即时通信 IM 设置成员未读消息计数 - 服务端 API

注意：

该文档仅限迁移用户使用，线上用户不能使用。

功能说明

• App 管理员使用该接口设置群组成员未读消息数，不会触发回调、不会下发通知。
• 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议设置群成员的未读消息计数。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

说明：

ChatRoom 和 AVChatroom（直播群）的客户端不支持未读消息计数，所以对这两种类型的群组成员设置未读消息计数是无效的（但是不会返回错误）。

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/set_unread_msg_num?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

设置指定群成员的未读消息计数；
使用本接口设置的未读计数如果大于群当前的消息数，未读计数会设为群当前的消息总数。

{
   "GroupId": "@TGS#2CLUZEAEJ",  // 要操作的群组（必填）
   "Member_Account": "bob",  // 要操作的群成员（必填）
   "UnreadMsgNum":5          // 该成员的未读消息数
}

请求包字段说明

应答包体示例

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

在群组中发送系统通知（v4/group_open_http_svc/send_group_system_notification）。