获取超级群消息扩展
根据消息 ID 获取指定消息的扩展信息。
超级群消息扩展功能可用于为原 始消息增加状态标识(扩展数据为 KV 键值对),提供添加、删除、查询扩展信息的接口。
请求方法
POST: https://数据中心域名/ultragroup/message/expansion/query.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
msgUID | String | 是 | 消息唯一标识 ID,可通过全量消息路由功能获取。详见全量消息路由。 |
busChannel | String | 否 | 超级群频道 ID。具体使用要求如下:
channelId 。 |
groupId | String | 是 | 超级群 ID。 |
pageNo | Int | 否 | 页数,默认返回 300 个扩展信息。 |
请求示例
POST /ultragroup/message/expansion/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1585127132438
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/x-www-form-urlencoded
msgUID=BRGM-DEN2-01E4-BN66&groupId=WNYZbMqpH&busChannel=abc
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码,200 为正常。 |
extraContent | Object | 消息扩展的内容,JSON 结构,以 Key、Value 的方式进行设置,如:{"type":"3"} 。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"extraContent": {
"kkk314": {
"v": "vvv314",
"ts": 33831605613
},
"kkk313": {
"v": "vvv313",
"ts": 33831605588
}
}
}