主题
IM聊天室服务-获取未读列表 FunctionCode | SER-B006
简介
获取未读列表
接口说明
- 请求方式
POST
- Headers
Content-Type: application/json
- Headers
Authorization: Bearer ${access_token}
正式环境 | 测试环境 |
---|---|
https://linkingcloud.cn/#/contact-us | https://api.linkingopen.com/test/service/im/eplustoolim/api/conversation/unreadList |
请求参数
名称 | 描述 | 类型 | 必填 |
---|---|---|---|
userId | 用户Id | string | 是 |
userSig | 用户签名 | string | 是 |
conversationIdList | 会话人员列表(一次最多传10个) | list<string> | 否 |
提示
conversationIdList一次性最多支持10个Id,不传时,默认通过最后一次阅读时间排序获取最新的10条
返回参数
名称 | 描述 | 类型 | 必填 |
---|---|---|---|
code | 错误码(1标识成功) | int | 是 |
data | 返回数据。 | list<object> | 是 |
message | 错误消息 | string | 否 |
返回参数
名称 | 描述 | 类型 | 必填 |
---|---|---|---|
conversationId | 会话Id | string | 是 |
unreadCount | 未读数量 | int | 是 |
lastReadAt | 最后一次读取时间(13位Unix时间戳) | int | 是 |
接口示例
参数示例
json
{
"userId": "123",
"userSig": "123",
"conversationIdList": ["123"]
}
json
{
"code": 1,
"message": "操作成功",
"requestId": null,
"data": [
{
"conversationId": "123",
"unreadCount": 0,
"lastReadAt": 0
}
],
"success": true
}