拉取群消息已读回执信息

Recent Pages

拉取群消息已读回执信息

最后更新时间：2023-12-12 17:34:09

功能说明
App 管理员可以通过该接口拉取群消息已读回执信息。
注意
 该功能仅对进阶版客户开放，需 购买进阶版 并在 控制台 > 功能配置 > 群组配置 > 群消息已读回执 打开开关后方可使用。
接口调用说明
适用的群组类型
群组类型ID
是否支持此 REST API
Private
支持，同新版本中的 Work(好友工作群)
Public
支持
ChatRoom
支持，同新版本中的 Meeting(临时会议群)
AVChatRoom
不支持
Community（社群）
不支持
即时通信 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 简介。
参数
说明
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
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员帐账号生成的签名，具体操作请参见 生成 UserSig﻿
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json
最高调用频率
200次/秒。
请求包示例
批量拉取群消息已读回执信息，包含已读数和未读数
基础形式
{
  "GroupId":"@TGS#2TTV7VSII",
  "MsgSeqList":[        // 拉取消息的 seq 列表
      {"MsgSeq":1},
      {"MsgSeq":2}
  ]
}
请求包字段说明
字段
类型
属性
说明
GroupId
String
必填
要拉取已读回执详情的群组 ID
MsgSeqList
Array
必填
拉取消息的 seq 列表
MsgSeq
Integer
必填
拉取消息的 seq
应答包体示例
基础形式
{
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "GroupMsgReceiptList": [   // 已读回执信息
      {
          "Code": 0,
          "MsgSeq": 1,       
          "ReadNum": 1,      // 群消息已读数
          "UnreadNum": 6     // 群消息未读数
      },
      {
          "Code": 0,
          "MsgSeq": 2,
          "ReadNum": 1,
          "UnreadNum": 6
      }
  ]
}
应答包字段说明
字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorInfo
String
错误信息
ErrorCode
Integer
错误码，0表示成功，非0表示失败
GroupMsgReceiptList
Array
群消息已读回执信息
Code
Integer
对应已读回执信息错误码，例如：10062代表已读回执信息不存在
MsgSeq
Integer
拉取消息的 seq
ReadNum
Integer
群消息已读数
UnreadNum
Integer
群消息未读数
错误码说明
除非发生网络错误（例如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_detail）

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

拉取群消息已读回执信息

功能说明

接口调用说明

适用的群组类型

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

群组类型ID	是否支持此 REST API
Private	支持，同新版本中的 Work(好友工作群)
Public	支持
ChatRoom	支持，同新版本中的 Meeting(临时会议群)
AVChatRoom	不支持
Community（社群）	不支持

参数	说明
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	请求接口
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
usersig	App 管理员帐账号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype	请求格式固定值为`json`

字段	类型	属性	说明
GroupId	String	必填	要拉取已读回执详情的群组 ID
MsgSeqList	Array	必填	拉取消息的 seq 列表
MsgSeq	Integer	必填	拉取消息的 seq

错误码	描述
10002	服务器内部错误，请重试
10003	请求命令字非法
10004	参数非法，请根据错误描述检查请求是否正确
10007	操作权限不足，操作人必须为该群类型中有权限执行对应操作的成员角色
10010	群组不存在，或者曾经存在过，但是目前已经被解散
10015	群组 ID 非法，请检查群组 ID 是否填写正确
10062	已读回执信息不存在

tencent cloud

注册

登录

Recent Pages

拉取群消息已读回执信息

功能说明

接口调用说明

适用的群组类型

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？