tencent cloud

功能说明

App 管理员可以通过该接口拉取群消息已读回执信息。

注意：

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

接口调用说明

适用的群组类型

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

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

批量拉取群消息已读回执信息，包含已读数和未读数

• 基础形式

  {
    "GroupId":"@TGS#2TTV7VSII",
    "MsgSeqList":[        // 拉取消息的 seq 列表
        {"MsgSeq":1},
        {"MsgSeq":2}
    ]
  }
  

请求包字段说明

应答包体示例

• 基础形式

  {
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "GroupMsgReceiptList": [   // 已读回执信息
        {
            "Code": 0,
            "MsgSeq": 1,       
            "ReadNum": 1,      // 群消息已读数
            "UnreadNum": 6     // 群消息未读数
        },
        {
            "Code": 0,
            "MsgSeq": 2,
            "ReadNum": 1,
            "UnreadNum": 6
        }
    ]
  }
  

应答包字段说明

错误码说明

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

接口调试工具

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

参考

拉取群消息已读回执详情（v4/group_open_http_svc/get_group_msg_receipt_detail）