domain说明

序号	系统	环境	地址	备注
1	卓易政企通	测试	https://test-gateway.eazytec-cloud.com	适用【园企通】【行业政企通】【乡镇政企通】【协会政企通】
2	卓易政企通	线上	https://gateway.eazytec-cloud.com	适用【园企通】【行业政企通】【乡镇政企通】【协会政企通】
3	宜兴政企通	测试	https://test-gateway.eazytec-cloud.com/YX	适用【宜兴政企通】
4	宜兴政企通	线上	https://gateway.eazytec-cloud.com/YX	适用【宜兴政企通】
5	宜兴政企通	线上-政务外网	http://10.36.12.1:8000/YX（vpn） http://2.18.243.11:8000/YX（政务外网）	适用【宜兴政企通-政务外网】
6	江苏政企通	测试	https://test-gateway.eazytec-cloud.com/JS	适用【江苏政企通】
7	江苏政企通	线上	https://gateway.eazytec-cloud.com/JS	适用【江苏政企通】

收件箱

1. 获取收件消息一级分类统计
 2. 获取收件消息二级分类统计
 3. 获取收件消息二级分类统计(包含5条收件消息)
4. 获取某个分类的消息列表(可选扩展接口)
5. 获取某个分类下某个应用的消息列表(可选扩展接口)
6. 查询收件箱消息（通用接口）
7. 获取收件消息详情
 8. 删除单条收件箱消息
 9. 批量删除收件箱
 10. 用户阅读单体收件消息
 11. 用户设置全部已读
 12. 获取未读消息数量
 13. 查询所有分类的收件箱
 14. 统计所有分类的收件箱消息数量

1. 获取收件消息一级分类统计

请求URL

/AGCS_zqc/v3_1/msgcenter/report/main
请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	是否必须
toUserid	接收人用户ID	String	否
toUsertype	接收人用户分类(1-政府/2-企业)	int	否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String	否

返回
返回成功

{
  "data": {
      "itemList": [
          {
              "appname": "政企消息",
              "deptid": "d-11",
              "des": "消息标题33333",
              "id": "151bd358-8cf8-41bb-b5ce-715a0234cac0",
              "msgtype": 0,
              "orgid": "o-11",
              "unreadnum": 2,
              "userid": "u-11",
              "usertype": 2,
              "utime": 1540452497856
          },
          {
              "appname": "我的订阅",
              "des": "标题",
              "id": "7a500a4f-fc15-480d-af34-91fbb9effe9b",
              "msgtype": 10,
              "orgid": "baseid-11",
              "unreadnum": 1,
              "userid": "u-11",
              "usertype": 2,
              "utime": 1540516685075
          }
      ],
      "pageNo": 1,
      "pageSize": 100,
      "totalNum": 3,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
des	最近一条消息的标题
utime	最近一条消息的发送时间
unreadnum	未读消息数量

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

2. 获取收件消息二级分类统计

请求URL

/AGCS_zqc/v3_1/msgcenter/report/msgtype/{msgtype}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID （政企labelid/企业baseid）	String		否
appid	应用ID（多个逗号分隔）	String		否
appname	应用名称(模糊搜索)	String		否

返回
返回成功

{
  "data": {
      "itemList": [
          {
              "appid": "zqtong_gov_app_client",
              "appname": "应用名称222",
              "avatar": "https://gateway.eazytec-cloud.com/EFS_gcs/app/gov/icons/20180904/1536024532989.png",
              "avatarBig": "https://gateway.eazytec-cloud.com/EFS_gcs/app/gov/bigicons/20180904/1536024532989.png",
              "deptid": "d-11",
              "des": "消息标题33333",
              "id": "2fb0b9bf-d1d6-4112-88e0-aeb7eb0f4260",
              "msgtype": 0,
              "orgid": "o-11",
              "systemName": "政企消息",
              "unreadnum": 0,
              "userid": "u-11",
              "usertype": 2,
              "utime": 1540344714914,
              "utimeVo": "2018-10-24 09:31:54"
          }
      ],
      "pageNo": 1,
      "pageSize": 10,
      "totalNum": 4,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
des	最近一条消息的标题
utime	最近一条消息的发送时间
unreadnum	未读消息数量
avatar	应用小图标(用于APP)(通过clientID获取，可能为空)
avatarBig	应用大图标(用于PC)(通过clientID获取，可能为空)
systemName	应用名称(通过clientID获取，可能为空)
utimeVo	最近一条消息的发送时间

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

3. 获取收件消息二级分类统计(包含5条收件消息)

请求URL

/AGCS_zqc/v3_1/msgcenter/report/list/{msgtype}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String		否
appid	应用ID（多个逗号分隔）	String		否
appname	应用名称(模糊搜索)	String		否

返回
返回成功

{
  "data": {
      "itemList": [
           {
                 "appid": "zqtong_gov_app_client",
                 "appname": "应用名称222",
                 "avatar": "https://gateway.eazytec-cloud.com/EFS_gcs/app/gov/icons/20180904/1536024532989.png",
                 "avatarBig": "https://gateway.eazytec-cloud.com/EFS_gcs/app/gov/bigicons/20180904/1536024532989.png",
                 "deptid": "d-11",
                 "des": "消息标题33333",
                 "id": "2fb0b9bf-d1d6-4112-88e0-aeb7eb0f4260",
                 "list": [
                     {
                         "appid": "zqtong_gov_app_client",
                         "appname": "应用名称222",
                         "ctime": 1540291760096,
                         "deptid": "d-11",
                         "ext": "{\"test\":\"test-value\"}",
                         "fromDeptid": "d-114",
                         "fromOrgid": "o-114",
                         "fromUserid": "u-114",
                         "fromUsertype": 1,
                         "hasatt": 1,
                         "id": "0_78389df6-c528-41a8-9dd5-01340436049f",
                         "msgcategory": "消息类别",
                         "msglevel": "消息级别",
                         "msgtype": 0,
                         "needpush": 0,
                         "needreply": 1,
                         "needsms": 1,
                         "orgid": "o-11",
                         "outboxid": "8cea3044-1907-4ebb-96e3-5836d38da7e7",
                         "readtime": 1540293678294,
                         "replytime": 1540545808763,
                         "sender": "发件人描述",
                         "state": 1,
                         "title": "消息标题33333",
                         "userid": "u-11",
                         "userread": 1,
                         "userreply": 9,
                         "usertype": 2
                     }
                 ],
                 "msgtype": 0,
                 "orgid": "o-11",
                 "systemName": "政企消息",
                 "unreadnum": 0,
                 "userid": "u-11",
                 "usertype": 2,
                 "utime": 1540344714914,
                 "utimeVo": "2018-10-24 09:31:54"
         }
      ],
      "pageNo": 1,
      "pageSize": 10,
      "totalNum": 4,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
des	最近一条消息的标题
utime	最近一条消息的发送时间
unreadnum	未读消息数量
avatar	应用小图标(用于APP)(通过clientID获取，可能为空)
avatarBig	应用大图标(用于PC)(通过clientID获取，可能为空)
systemName	应用名称(通过clientID获取，可能为空)
utimeVo	最近一条消息的发送时间
list	该来源应用下最近5条的消息列表

字段	描述
ctime	创建时间(毫秒时间戳)
ext	扩展参数(jsonString)
state	状态(0-删除，1-正常)
hasatt	是否有附件(0-否，1-是)
readtime	阅读时间
replytime	回复时间
userread	用户是否阅读(0-否，1-是)
userreply	用户是否已回复(0-否，1-是)

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

4. 获取某个分类的消息列表(可选扩展接口)

请求URL

/AGCS_zqc/v3_1/msgcenter/list/inbox/{msgtype}
扩展接口(增加：消息回复总数)

/AGCS_zqc/v3_1/msgcenter/list/inbox/ext/{msgtype}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID（政企labelid/企业baseid）	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID	String		否
appid	应用ID（多个逗号分隔）	String		否
appname	应用名称(模糊搜索)	String		否
fromUserid	发件人用户ID	String		否
fromUsertype	发件人用户分类(1-政府/2-企业)	int		否
fromOrgid	发件人组织ID（政企labelid/企业baseid）	String		否
fromDeptid	发件人部门ID	String		否
title	标题(模糊搜索)	String		否
userread	用户是否阅读(0-否，1-是)	int		否
userreply	用户是否回复(0-否，1-是)	int		否
hasatt	是否有附件(0-否，1-是)	int		否
msgcategory	消息类别	string		否
msglevevl	消息级别	string		否
outboxid	发件消息ID	String		否

返回
返回成功

{
  "data": {
      "itemList": [
            {
                      "appid": "应用id222",
                      "appname": "应用名称222",
                      "ctime": 1540537984611,
                      "deptid": "d-11",
                      "ext": "{\"test\":\"test-value\"}",
                      "fromDeptid": "d-114",
                      "fromOrgid": "baseid-1",
                      "fromUserid": "u-114",
                      "fromUsertype": 1,
                      "hasatt": 1,
                      "id": "0_305319ce-ee60-4ca4-9311-d27358b4cd99",
                      "msgcategory": "消息类别",
                      "msglevel": "消息级别",
                      "msgtype": 0,
                      "needpush": 0,
                      "needreply": 1,
                      "needsms": 1,
                      "orgid": "baseid-11",
                      "outboxid": "e5d54718-18e0-4097-9579-789ea3a19f0e",
                      "sender": "发件人描述",
                      "state": 1,
                      "title": "消息标题33333",
                      "userid": "u-11",
                      "userread": 0,
                      "userreply": 0,
                      "usertype": 2,
                      "replynum":11,
                       "summary": "正文概要",
                       "fromDeptName":"镇领导"
                  }
      ],
      "pageNo": 1,
      "pageSize": 10,
      "totalNum": 4,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
ctime	创建时间(毫秒时间戳)
ext	扩展参数(jsonString)
state	状态(0-删除，1-正常)
hasatt	最近一条消息的标题
readtime	阅读时间
replytime	回复时间
userread	用户是否阅读(0-否，1-是)
userreply	用户是否已回复(0-否，1-是)
replynum	消息回复总数（EXT扩展接口才有）
fromDeptName	发件人部门名称（EXT扩展接口才有）
summary	正文概要（EXT扩展接口才有）

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

5. 获取某个分类下某个应用的消息列表(可选扩展接口)

请求URL

/AGCS_zqc/v3_1/msgcenter/list/inbox/{msgtype}/{appid}
扩展接口(增加：消息回复总数)

/AGCS_zqc/v3_1/msgcenter/list/inbox/ext/{msgtype}/{appid}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是
appid	应用ID	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String		否
fromUserid	发件人用户ID	String		否
fromUsertype	发件人用户分类(1-政府/2-企业)	int		否
fromOrgid	发件人组织ID（政企labelid/企业baseid）	String		否
fromDeptid	发件人部门ID	String		否
title	标题(模糊搜索)	String		否
userread	用户是否阅读(0-否，1-是)	int		否
userreply	用户是否回复(0-否，1-是)	int		否
hasatt	是否有附件(0-否，1-是)	int		否
msgcategory	消息类别	string		否
msglevevl	消息级别	string		否
outboxid	发件消息ID	String		否

返回
返回成功

{
  "data": {
      "itemList": [
            {
                      "appid": "应用id222",
                      "appname": "应用名称222",
                      "ctime": 1540537984611,
                      "deptid": "d-11",
                      "ext": "{\"test\":\"test-value\"}",
                      "fromDeptid": "d-114",
                      "fromOrgid": "baseid-1",
                      "fromUserid": "u-114",
                      "fromUsertype": 1,
                      "hasatt": 1,
                      "id": "0_305319ce-ee60-4ca4-9311-d27358b4cd99",
                      "msgcategory": "消息类别",
                      "msglevel": "消息级别",
                      "msgtype": 0,
                      "needpush": 0,
                      "needreply": 1,
                      "needsms": 1,
                      "orgid": "baseid-11",
                      "outboxid": "e5d54718-18e0-4097-9579-789ea3a19f0e",
                      "sender": "发件人描述",
                      "state": 1,
                      "title": "消息标题33333",
                      "userid": "u-11",
                      "userread": 0,
                      "userreply": 0,
                      "usertype": 2,
                      "replynum":11,
                      "summary":"正文概要",
                      "fromDeptName":"镇领导"
                  }
      ],
      "pageNo": 1,
      "pageSize": 10,
      "totalNum": 4,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
ctime	创建时间(毫秒时间戳)
ext	扩展参数(jsonString)
state	状态(0-删除，1-正常)
hasatt	最近一条消息的标题
readtime	阅读时间
replytime	回复时间
userread	用户是否阅读(0-否，1-是)
userreply	用户是否已回复(0-否，1-是)
replynum	消息回复总数（EXT扩展接口才有）
fromDeptName	发件人部门名称（EXT扩展接口才有）
summary	正文概要（EXT扩展接口才有）

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

6. 查询收件箱消息（通用接口）

请求URL

/AGCS_zqc/v3_1/msgcenter/query/inbox/{msgtype}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String		否
appid	应用ID（多个逗号分隔）	String		否
appname	应用名称(模糊搜索)	String		否
fromUserid	发件人用户ID	String		否
fromUsertype	发件人用户分类(1-政府/2-企业)	int		否
fromOrgid	发件人组织ID（政企labelid/企业baseid）	String		否
fromDeptid	发件人部门ID	String		否
title	标题(模糊搜索)	String		否
userread	用户是否阅读(0-否，1-是)	int		否
userreply	用户是否回复(0-否，1-是)	int		否
hasatt	是否有附件(0-否，1-是)	int		否
msgcategory	消息类别	string		否
msglevevl	消息级别	string		否
outboxid	发件消息ID	String		否

返回
返回成功

{
  "data": {
      "itemList": [
            {
                      "appid": "应用id222",
                      "appname": "应用名称222",
                      "ctime": 1540537984611,
                      "deptid": "d-11",
                      "ext": "{\"test\":\"test-value\"}",
                      "fromDeptid": "d-114",
                      "fromOrgid": "baseid-1",
                      "fromUserid": "u-114",
                      "fromUsertype": 1,
                      "hasatt": 1,
                      "id": "0_305319ce-ee60-4ca4-9311-d27358b4cd99",
                      "msgcategory": "消息类别",
                      "msglevel": "消息级别",
                      "msgtype": 0,
                      "needpush": 0,
                      "needreply": 1,
                      "needsms": 1,
                      "orgid": "baseid-11",
                      "outboxid": "e5d54718-18e0-4097-9579-789ea3a19f0e",
                      "sender": "发件人描述",
                      "state": 1,
                      "title": "消息标题33333",
                      "userid": "u-11",
                      "userread": 0,
                      "userreply": 0,
                      "usertype": 2
                  }
      ],
      "pageNo": 1,
      "pageSize": 10,
      "totalNum": 4,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
ctime	创建时间(毫秒时间戳)
ext	扩展参数(jsonString)
state	状态(0-删除，1-正常)
hasatt	最近一条消息的标题
readtime	阅读时间
replytime	回复时间
userread	用户是否阅读(0-否，1-是)
userreply	用户是否已回复(0-否，1-是)

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

7. 获取收件消息详情

请求URL

/AGCS_zqc/v3_1/msgcenter/detail/inbox/{inboxid}

参数	描述	格式	举例	是否必须
inboxid	收件消息ID	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

返回
返回成功

{
  "data": {
      "appid": "zqtong_gov_app_client",
      "appname": "应用名称222",
      "attfiles": "\"[file:{name:'附件1',path:'www.path.com'}]\"",
      "body": "<p>测试消息正文</p><H>测试一下</H>",
      "ctime": 1540291760096,
      "deptid": "d-11",
      "ext": "{\"test\":\"test-value\"}",
      "fromDeptid": "d-114",
      "fromOrgid": "o-114",
      "fromUserid": "u-114",
      "fromUsertype": 1,
      "hasatt": 1,
      "id": "0_78389df6-c528-41a8-9dd5-01340436049f",
      "msgcategory": "消息类别",
      "msglevel": "消息级别",
      "msgtype": 0,
      "needpush": 0,
      "needreply": 1,
      "needsms": 1,
      "orgid": "o-11",
      "outboxid": "8cea3044-1907-4ebb-96e3-5836d38da7e7",
      "readtime": 1540293678294,
      "replytime": 1540545808763,
      "sender": "发件人描述",
      "state": 1,
      "title": "消息标题33333",
      "userid": "u-11",
      "userread": 1,
      "userreply": 9,
      "usertype": 2
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
ctime	创建时间(毫秒时间戳)
ext	扩展参数(jsonString)
attfiles	附件列表(jsonString)
state	状态(0-删除，1-正常)
hasatt	最近一条消息的标题
readtime	阅读时间
replytime	回复时间
userread	用户是否阅读(0-否，1-是)
userreply	用户是否已回复(0-否，1-是)

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

8. 删除单条收件箱消息

请求URL

/AGCS_zqc/v3_1/msgcenter/delete/inbox/{inboxid}

参数	描述	格式	举例	是否必须
inboxid	收件消息ID	String		是

请求方式

DELETE
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

返回
返回成功

  {
      "data": "true/false" ,
      "msg": "success",
      "oK": true,
      "status": 200
  }

返回失败: 400（参数缺失）

   {
     "data": "缺少必要参数" ,
     "msg": "fail",
     "status": 400
   }

返回失败: 401（解决：重新获取token，然后重新请求）

   {
       "error": "invalid_token",
       "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
   }

9. 批量删除收件箱

请求URL

/AGCS_zqc/v3_1/msgcenter/delete/batch/inbox
请求方式

DELETE
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Body
Type: raw
```
  ["inboxid1","inboxid2","inboxid3"]
```

返回
返回成功

  {
      "data": "true/false" ,
      "msg": "success",
      "oK": true,
      "status": 200
  }

返回失败: 400（参数缺失）

   {
     "data": "缺少必要参数" ,
     "msg": "fail",
     "status": 400
   }

返回失败: 401（解决：重新获取token，然后重新请求）

   {
       "error": "invalid_token",
       "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
   }

10. 用户阅读单体收件消息

请求URL

/AGCS_zqc/v3_1/msgcenter/read/{inboxid}

参数	描述	格式	举例	是否必须
inboxid	收件消息ID	String		是

请求方式

POST
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

返回
返回成功

  {
      "data": "true/false" ,
      "msg": "success",
      "oK": true,
      "status": 200
  }

返回失败: 400（参数缺失）

   {
     "data": "缺少必要参数" ,
     "msg": "fail",
     "status": 400
   }

返回失败: 401（解决：重新获取token，然后重新请求）

   {
       "error": "invalid_token",
       "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
   }

11. 用户设置全部已读

请求URL

/AGCS_zqc/v3_1/msgcenter/read/all/{msgtype}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是

请求方式

POST
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Body
Type: raw

{
  "toUserid":"String | 必填 |发送人用户ID",
  "toUsertype":"int | 必填 | 发送人用户分类(1-政府/2-企业)",
  "toOrgid":"String | 可选 |发送人组织ID（政企labelid/企业baseid）",
  "appid": "String | 可选 | 申请的clientID"
}

示例

{
  "toUserid":"u-12",
  "toUsertype":"2",
  "toOrgid":"",
  "appid":"1"
}

返回
返回成功

  {
      "data": "true/false" ,
      "msg": "success",
      "oK": true,
      "status": 200
  }

返回失败: 400（参数缺失）

     {
       "data": "缺少必要参数" ,
       "msg": "fail",
       "status": 400
     }

返回失败: 401（解决：重新获取token，然后重新请求）

     {
         "error": "invalid_token",
         "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
     }

12. 获取未读消息数量

请求URL

/AGCS_zqc/v3_1/msgcenter/count/unread/{msgtype}

参数	描述	格式	举例	是否必须
msgtype	消息类型	String		是

请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	是否必须
toUserid	接收人用户ID	String	否
toUsertype	接收人用户分类(1-政府/2-企业)	int	否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String	否
appid	应用ID（多个逗号分隔）	String	否
fromUserid	发件人用户ID	String	否
fromUsertype	发件人用户分类(1-政府/2-企业)	int	否
fromOrgid	发件人组织ID（政企labelid/企业baseid）	String	否
fromDeptid	发件人部门ID	String	否

返回
返回成功

{ 
"data":103,
"msg":"success",
"oK":true,
"status":200
}

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

13. 查询所有分类的收件箱

请求URL

/AGCS_zqc/v3_1/msgcenter/query/union/inbox
请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String		否
fromUserid	发件人用户ID	String		否
fromUsertype	发件人用户分类(1-政府/2-企业)	int		否
fromOrgid	发件人组织ID（政企labelid/企业baseid）	String		否
fromDeptid	发件人部门ID	String		否
title	标题(模糊搜索)	String		否
userread	用户是否阅读(0-否，1-是)	int		否
userreply	用户是否回复(0-否，1-是)	int		否
hasatt	是否有附件(0-否，1-是)	int		否
msgcategory	消息类别	string		否
msglevevl	消息级别	string		否
outboxid	发件消息ID	String		否
msgtype	消息类型	String		否
appid	应用ID	String		否
starttime	开始时间(yyyy-MM-dd格式)	String	2019-03-12	否
endtime	结束时间(yyyy-MM-dd格式)	String	2019-03-13	否

返回
返回成功

{
  "data": {
      "itemList": [
            {
                      "appid": "应用id222",
                      "appname": "应用名称222",
                      "ctime": 1540537984611,
                      "deptid": "d-11",
                      "ext": "{\"test\":\"test-value\"}",
                      "fromDeptid": "d-114",
                      "fromOrgid": "baseid-1",
                      "fromUserid": "u-114",
                      "fromUsertype": 1,
                      "hasatt": 1,
                      "id": "0_305319ce-ee60-4ca4-9311-d27358b4cd99",
                      "msgcategory": "消息类别",
                      "msglevel": "消息级别",
                      "msgtype": 0,
                      "needpush": 0,
                      "needreply": 1,
                      "needsms": 1,
                      "orgid": "baseid-11",
                      "outboxid": "e5d54718-18e0-4097-9579-789ea3a19f0e",
                      "sender": "发件人描述",
                      "state": 1,
                      "title": "消息标题33333",
                      "userid": "u-11",
                      "userread": 0,
                      "userreply": 0,
                      "usertype": 2,
                      "replynum":11,
                      "fromDeptName":"镇领导"
                  }
      ],
      "pageNo": 1,
      "pageSize": 10,
      "totalNum": 4,
      "totalPage": 1
  },
  "msg": "success",
  "oK": true,
  "status": 200
}

字段	描述
ctime	创建时间(毫秒时间戳)
ext	扩展参数(jsonString)
state	状态(0-删除，1-正常)
hasatt	最近一条消息的标题
readtime	阅读时间
replytime	回复时间
userread	用户是否阅读(0-否，1-是)
userreply	用户是否已回复(0-否，1-是)
replynum	消息回复总数
fromDeptName	发件人部门

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

14. 统计所有分类的收件箱消息数量

请求URL

/AGCS_zqc/v3_1/msgcenter/count/union/inbox
请求方式

GET
请求Header参数

key	value	举例	是否必须
Content-Type	application/json	application/json	是
Authorization	Bearer [token]	Bearer b43bfc94-2c77-46b4-b8f8-87cb549dfef3	是

请求Query参数

参数	描述	格式	举例	是否必须
pageNo	分页时的当前页数	int >=1	1	否，默认为1
pageSize	分页时的每页记录数	int >=1	10	否，默认为10
toUserid	接收人用户ID	String		否
toUsertype	接收人用户分类(1-政府/2-企业)	int		否
toOrgid	接收人组织ID（政企labelid/企业baseid）	String		否
fromUserid	发件人用户ID	String		否
fromUsertype	发件人用户分类(1-政府/2-企业)	int		否
fromOrgid	发件人组织ID（政企labelid/企业baseid）	String		否
fromDeptid	发件人部门ID	String		否
title	标题(模糊搜索)	String		否
userread	用户是否阅读(0-否，1-是)	int		否
userreply	用户是否回复(0-否，1-是)	int		否
hasatt	是否有附件(0-否，1-是)	int		否
msgcategory	消息类别	string		否
msglevevl	消息级别	string		否
outboxid	发件消息ID	String		否
msgtype	消息类型	String		否
appid	应用ID	String		否
starttime	开始时间(yyyy-MM-dd格式)	String	2019-03-12	否
endtime	结束时间(yyyy-MM-dd格式)	String	2019-03-13	否

返回
返回成功

{
  "data": 105,
  "msg": "success",
  "oK": true,
  "status": 200
}

返回失败: 400（参数缺失）

    {
      "data": "缺少必要参数" ,
      "msg": "fail",
      "status": 400
    }

返回失败: 401（解决：重新获取token，然后重新请求）

    {
        "error": "invalid_token",
        "error_description": "Invalid access token: e9a86405-5b16-4d33-825b-ee5d848ac55"
    }

1.4 收件箱

domain说明

收件箱

1. 获取收件消息一级分类统计

2. 获取收件消息二级分类统计

3. 获取收件消息二级分类统计(包含5条收件消息)

4. 获取某个分类的消息列表(可选扩展接口)

5. 获取某个分类下某个应用的消息列表(可选扩展接口)

6. 查询收件箱消息（通用接口）

7. 获取收件消息详情

8. 删除单条收件箱消息

9. 批量删除收件箱

10. 用户阅读单体收件消息

11. 用户设置全部已读

12. 获取未读消息数量

13. 查询所有分类的收件箱

14. 统计所有分类的收件箱消息数量

results matching ""

No results matching ""