即时通信 IM
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 即时通信 IM > 服务端 API > REST API > 消息相关 > 已读回执 > 拉取群消息已读回执详情

拉取群消息已读回执详情

最近更新时间：2023-12-12 15:56:24

我的收藏

本页目录：

功能说明

App 管理员可以通过该接口拉取群消息已读或未读成员列表。
注意
该功能仅对旗舰版客户开放，需 购买旗舰版套餐包 并在 控制台 > 功能配置 > 群组配置 > 群消息已读回执打开开关后方可使用。

接口调用说明

适用的群组类型

群组类型ID
是否支持此 REST API
Private
支持，同新版本中的 Work(好友工作群)
Public
支持
ChatRoom
支持，同新版本中的 Meeting(临时会议群)
AVChatRoom
不支持
Community（社群）
不支持
即时通信 IM 内置上述群组类型，详情请参阅 群组系统。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/get_group_msg_receipt_detail?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
孟买：adminapiind.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/group_open_http_svc/get_group_msg_receipt_detail
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

分批拉取群消息已读或未读成员列表
基础形式 使用 Cursor 和 Count 两个值用于控制分页拉取：
Count 限制回包中 ReadList 或者 UnreadList 数组中成员的个数，不得超过200.
Cursor 控制从某一个成员位置拉取后续的信息。第一次请求时，客户端请求参数 Cursor 传""; 最后一次请求服务端返回的 IsFinish 为 1 时，代表拉取结束；
{
 "GroupId":"@TGS#2TTV7VSII",
 "MsgSeq": 1,
 "Filter": 1,        // 0表示拉取已读成员列表，1表示拉取未读列表
 "Cursor":"",      // 上一次拉取到的成员位置，第一次填写""
 "Count":5           // 最多拉取多少个成员
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
要拉取已读回执详情的群组 ID
MsgSeq
Integer
选填
拉取消息的 seq
Filter
Integer
必填
拉取已读，未读成员列表：
0：表示拉取已读成员列表
1：表示拉取未读列表
Cursor
String
必填
上一次拉取到的成员位置，第一次填写""
Count
Integer
必填
一次最多拉取多少个成员数，最高可填200

应答包体示例

拉取已读成员列表
{
    "ActionStatus": "OK",
    "Cursor": "0",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "IsFinish": 1,     // 拉取完毕，不用续拉 
    "MsgSeq": 1,  
    "ReadList": [    // 已读成员列表
        {
            "Read_Account": "test1"
        }
    ]
}
拉取未读成员列表
{
  "ActionStatus": "OK",
  "Cursor": "144115213529088617", // 下一次请求应该传的 Cursor 值
  "ErrorCode": 0,
  "ErrorInfo": "",
  "IsFinish": 0,   // 未拉取完毕，需要续拉
  "MsgSeq": 1,
  "UnreadList": [  // 未读成员列表
      {
          "Unread_Account": "test"
      },
      {
          "Unread_Account": "test6"
      },
      {
          "Unread_Account": "test3"
      },
      {
          "Unread_Account": "test5"
      },
      {
          "Unread_Account": "test4"
      }
  ]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorInfo
String
错误信息
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
IsFinished
Integer
是否已经拉取完毕：
0：表示未拉取完毕
1：表示拉取完毕
MsgSeq
Integer
拉取消息的 seq
ReadList
Array
已读成员列表
Read_Account
String
已读成员
UnreadList
Array
未读成员列表
Unread_Account
String
未读成员
Cursor
String
下一次请求应该传的 Cursor 值

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
描述
10002
服务器内部错误，请重试
10003
请求命令字非法
10004
参数非法，请根据错误描述检查请求是否正确
10007
操作权限不足，操作人必须为该群类型中有权限执行对应操作的成员角色
10010
群组不存在，或者曾经存在过，但是目前已经被解散
10015
群组 ID 非法，请检查群组 ID 是否填写正确
10062
已读回执信息不存在

接口调试工具

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

参考

拉取群消息已读回执信息（v4/group_open_http_svc/get_group_msg_receipt）
中国站