云通讯平台为开发者提供了获取已读未读消息列表接口,该接口主要用于获取群组已读未读消息,需要结合客户端设置消息已读接口使用。
1、请求地址
/{SoftVersion}/Application/{appId}/IMPlus/MessageReceipt
2、请求包头
请参阅《鉴权说明》
3、请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
msgId | String | 可选 | 消息Id,客户端发消息返回的消息id。version和msgId两个参数二选一,都传则以version为准。 |
version | String | 可选 | 消息版本号 | pageSize | int | 可选 | 数量默认50条,最大100条,超过100条返回错误码 | pageNo | int | 可选 | 页码 默认第一页 | type | int | 必选 | 类型 1.已读 2.未读 |
userName | String | 必选 | 用户账号 |
3.1、请求示例
POST:/2013-12-26/Application/20150314000000110000000000000010/IM/MessageReceipt?sig=b1491f1dc4e2b3ea9611d129427d17c8 HTTP/1.1 content-type: application/json;charset=utf-8 accept: application/json authorization:MjAxNTAzMTQwMDAwMDAxMTAwMDAwMDAwMDAwMDAwMTA6MjAxNjA4MTkxNzUyNDM= content-length: 79 host: 127.0.0.1:8080 connection: Keep-Alive { "msgId":"111", "version":"12", "pageSize":2, "pageNo":3, "type":1, "userName":"123" }
4、响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值200(成功)。 |
result | List | 必选 | 返回结果集 |
useracc | String | 可选 | 用户信息 |
time | String | 可选 | 时间 |
totalSize | String | 必选 | 总页数 |
4.1、响应示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode":"200", "result":[ {"useracc":"aa#333", "time":"1470213301751"}, {"useracc":"aa#444", "time":"1470213301751"} ], "totalSize":"3" }