注意
该接口仅限项目迁移场景下使用。
功能说明
App 管理员使用该接口设置群组成员未读消息数，不会触发回调、不会下发通知。
当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议设置群成员的未读消息计数。
接口调用说明
适用的群组类型
群组类型 ID | 是否支持此 REST API |
Private | 支持，同新版本中的 Work（好友工作群） |
Public | 支持 |
ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
AVChatRoom | 不支持 |
Community（社群） | 支持 |
说明
ChatRoom 和 AVChatroom（直播群）的客户端不支持未读消息计数，所以对这两种类型的群组成员设置未读消息计数是无效的（但是不会返回错误）。
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/set_unread_msg_num?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/group_open_http_svc/set_unread_msg_num | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
设置指定群成员的未读消息计数；
使用本接口设置的未读计数如果大于群当前的消息数，未读计数会设为群当前的消息总数。
{"GroupId": "@TGS#2CLUZEAEJ", // 要操作的群组（必填）"Member_Account": "bob", // 要操作的群成员（必填）"UnreadMsgNum":5 // 该成员的未读消息数}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 操作的群 ID |
Member_Account | String | 必填 | 要操作的群成员 |
UnreadMsgNum | Integer | 必填 | 成员未读消息数 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功 FAIL：表示失败 |
ErrorInfo | String | 错误信息 |
ErrorCode | Integer | 错误码： 0：表示成功 非0：表示失败 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 描述 |
10002 | 服务器内部错误，请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法，请根据错误描述检查请求是否正确 |
10007 | 操作权限不足，例如 Public 群组中普通成员尝试执行踢人操作，但只有 App 管理员才有权限 |
10010 | 群组不存在，或者曾经存在过，但是目前已经被解散 |
10015 | 群组 ID 非法，请检查群组 ID 是否填写正确 |
