获取指定超级群消息内容
根据消息 UID 获取超级群消息,单次最多获取 20 条。
App 后端使 用该接口查询消息的内容与消息扩展数据。如果消息已超过超级群历史消息记录存储期限(默认 7 天)则返回内容为空。查询消息所需传入的消息全局唯一 ID(消息 UID)与频道 ID 可以由 App 自动从客户端上传至 App 后端,或通过即时通讯服务提供的全量消息路由等回调服务获取。
方法说明
POST: https://数据中心域名/ultragroup/msg/get.json
频率限制: 每秒钟限 5 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
groupId | String | 是 | 超级群 ID |
msgs | Array of Objects | 是 | 消息的查询参数,单次请求最多获取 20 条消息。 |
msgs[i].msgUID | String | 是 | 全局唯一 ID,即消 息 UID。 |
msgs[i].busChannel | String | 否 | 消息所在的超级群频道 ID。 |
请求示例
POST /ultragroup/msg/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxabx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e739219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
groupId=BWSZNmXBD&msgs=%5B%7B%22busChannel%22%3A%22001%22%2C%22msgUID%22%3A%22C16R-VBGG-1IE5-SD0C%22%7D%2C%7B%22busChannel%22%3A%22002%22%2C%22msgUID%22%3A%22C16R-VBGG-1IE5-SD5C%22%7D%5D
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
data | JSONArray | 消息数组。 |
data[i].fromUserId | String | 发送人用户 ID。 |
data[i].groupId | String | 超级群 ID。 |
data[i].sentTime | Number | 消息发送时间。Unix 时间戳,单位为毫秒。 |
data[i].busChannel | String | 频道 ID。 |
data[i].msgUID | String | 全局唯一消息 ID,即消息 UID。 |
data[i].objectName | String | 消息类型的唯一标识。 |
data[i].content | String | 消息的内容。 |
data[i].expansion | Boolean | 是否为扩展消息。 |
data[i].extraContent | String | 消息扩展的内容,JSON 结构的 Key、Value 对,如:"{\"key1\":{\"v\":\"value\",\"ts\":110908544521}}" 。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"data":[
{
"fromUserId":"user1",
"groupId":"g1",
"sentTime":1654591498853,
"busChannel":"001",
"msgUID":"C16R-VBGG-1IE5-SD0C",
"objectName":"RC:TxtMsg",
"content":"哈喽",
"expansion":"false",
"extraContent": ""
}
]
}