云通訊平臺為開發者提供了獲取已讀未讀消息列表接口,該接口主要用于獲取群組已讀未讀消息,需要結合客戶端設置消息已讀接口使用。
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" }