有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能说明

App 管理员和群成员可以拉取消息扩展,消息扩展为一组自定义的键值对。
注意
此功能需 旗舰版套餐,并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
单条群消息可设置的最大键值对数量为300条。
被设置的群消息需要在发送时指定“支持消息扩展”,参见 在群组中发送普通消息

接口调用说明

适用的群组类型

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

请求 URL 示例

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

最高调用频率

200次/秒。

请求包示例

基础形式
拉取MsgSeq为158的群消息扩展:
{
"GroupId": "@TGS#1YMVAB3IZ",
"MsgSeq": 158
}
拉取MsgSeq为158、并且Seq大于等于2的群消息扩展:
{
"GroupId": "@TGS#1YMVAB3IZ",
"MsgSeq": 158,
"StartSeq": 2
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
群id
MsgSeq
Integer
必填
需要设置的群消息的 Seq
StartSeq
Integer
选填
拉取大于等于 StartSeq 的消息扩展

应答包体示例

{
"ErrorCode": 0,
"ErrorInfo": "",
"ActionStatus": "OK",
"CompleteFlag": 1,
"LatestSeq": 2,
"ClearSeq": 0,
"ExtensionList": [
{
"Key": "key1",
"Value": "1",
"Seq": 1
},
{
"Key": "key2",
"Value": "2",
"Seq": 1
},
{
"Key": "key3",
"Value": "3",
"Seq": 2
}
]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败
ErrorInfo
String
错误信息
ExtensionList
Array
返回的 KV 列表,按 Seq 大小排序。单次拉取最多返回200条 KV。超过200条需要通过 StartSeq 分批拉取。
CompleteFlag
Integer
1:为已返回所有扩展
0:为未返回所有列表
LatestSeq
Integer
后台最新的 Seq,为所有 KV 的 Seq 的最大值
ClearSeq
Integer
清空操作的 Seq,客户端本地需要删除所有小于等于 ClearSeq 的 KV。

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
10002
服务器内部错误,请重试
10004
参数非法,请根据错误描述检查请求是否正确
10008
非法请求,非旗舰版套餐请求返回该错误
23004
群消息不存在