tencent cloud

功能说明

App 管理员可以通过该接口拉取群消息已读或未读成员列表。

注意：

该功能仅对旗舰版客户开放，需 购买旗舰版 并在 控制台 > 功能配置 > 群组配置 > 群消息已读回执 打开开关后方可使用。

接口调用说明

适用的群组类型

即时通信 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 简介。

最高调用频率

200次/秒。

请求包示例

分批拉取群消息已读或未读成员列表

• 基础形式
  使用 Cursor 和 Count 两个值用于控制分页拉取：
• Count 限制回包中 ReadList 或者 UnreadList 数组中成员的个数，不得超过200.
• Cursor 控制从某一个成员位置拉取后续的信息。第一次请求时，客户端请求参数 Cursor 传""; 最后一次请求服务端返回的 IsFinish 为 1 时，代表拉取结束；

  {
   "GroupId":"@TGS#2TTV7VSII",
   "MsgSeq": 1,
   "Filter": 1,        // 0表示拉取已读成员列表，1表示拉取未读列表
   "Cursor":"",      // 上一次拉取到的成员位置，第一次填写""
   "Count":5           // 最多拉取多少个成员
  }
  

请求包字段说明

应答包体示例

• 拉取已读成员列表

  {
      "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"
        }
    ]
  }
  

应答包字段说明

错误码说明

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

接口调试工具

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

参考

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