查询超大群云端历史消息
更新时间: 2024/07/17 17:57:35
用户可以查询存储在云信服务器中的超大群历史消息,只能查询在保存时间范围内的消息。
根据用户 ID 查询超大群历史消息
API 使用限制
单个应用最高调用频率:100次/秒,超过返回 416 错误码。
URL
POST https://api.netease.im/nimserver/superteam/queryHistoryMsg.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
tid | Long | 是 | 云信服务器产生,超大群唯一标识,创建时会返回,最大长度 64 位长整型 |
accid | String | 是 | 需要查询的用户账号,accid,最大长度 32 位字符 |
begintime | Long | 是 | 开始时间,毫秒级别时间戳 只能在应用可以查询的历史消息时间以内 只能查询最新入群之后的消息 |
endtime | Long | 是 | 截止时间,毫秒级别时间戳 |
limit | Integer | 是 | 本次查询的消息条数上限,(0,100] |
reverse | Integer | 否 | 查询方向 1,按时间正序排列;2,按时间降序排列(默认) |
type | Integer | 否 | 查询指定的消息类型,类型之间用","分割,不设置该参数则查询全部类型消息,最大长度 500 位字符 类型支持: 0,文本消息;1,图片;2,语音;3,视频;4,地理位置信息;6,文件;10,提示;100,自定义消息类型 |
excludeMsgid | String | 否 | 结束查询的最后一条消息的 msgid(不包含在查询结果中),用于定位锚点 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码,请求成功则返回 200 |
size | Integer | 历史消息数量 |
tid | Long | 超大群 ID |
msgs | String | 历史消息的详细信息,JSON |
msgs 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
msgid | Long | 服务端消息 ID |
sendtime | Long | 消息发送时间 |
from | String | 消息发送方账号,accid |
type | Integer | 消息类型 |
ext | String | 第三方扩展字段 |
body | Object | 消息体,根据消息类型的不同而不同,格式参见消息格式示例 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk***0803mgq3" -H "Nonce: 4tggg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'begintime=1443599631111&endtime=1443599639999&tid=1513535&accid=zhangsan&limit=50' 'https://api.netease.im/nimserver/superteam/queryHistoryMsg.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200
"tid": 123,
"size":1,
"msgs":[
{
"msgid":1123,
"sendtime":1123123,
"from": "accid",
"type":0,
"ext": null,
"body":{ // (消息body根据消息类型的不同而不同,body格式见1.5.10), Object
"msg": "msg" // 消息体
}
}
]
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414,
"desc": "bad reverse" // reverse 不合法
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作: 超大群功能未开通或 app 权限错误 |
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
根据消息 ID 查询超大群历史消息
API 使用限制
单个应用最高调用频率:100次/秒,超过返回 416 错误码。
URL
POST https://api.netease.im/nimserver/superteam/queryHistoryMsgByIds.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
msgs | String | 是 | 可转换成 JSONArray,最多只能有 100 个JSON,最大长度 20480 位字符 每个 JSON 中包括一下四个字段: from:消息发送者账号,accid(String) to:超大群 ID,tid(Long) time:消息发送时间(Long) msgid:消息 ID(Long) |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码,请求成功则返回 200 |
msgs | String | 历史消息的详细信息,JSON |
msgs 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
msgid | Long | 服务器消息 ID |
sendtime | Long | 消息发送时间 |
from | String | 消息发送方账号,accid |
type | Integer | 消息类型 |
ext | String | 第三方扩展字段 |
body | Object | 消息体,根据消息类型的不同而不同,格式参见消息格式示例 |
示例
请求示例(curl)
curlcurl -X POST -H "appkey: fe416640c***7ad2547" -H "nonce: 12345" -H "curtime: 1459154905" -H "checksum: 8d3ef001b160bda737c779d75d906e48e75fc9d3" -H "Content-Type: application/x-www-form-urlencoded" -d 'msgs=[{"from":"aa","to":23,"time":123,"msgid":123}]' "https://api.netease.im/nimserver/superteam/queryHistoryMsgByIds.action"
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"msgs": [
{
"msgid":1123,
"sendtime":1123123,
"from": "accid",
"type":0,
"ext": null,
"body":{ // (消息body根据消息类型的不同而不同,body格式见1.5.10), Object
"msg": "msg" // 消息体
}
}
]
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414,
"desc": "bad reverse" // reverse 不合法
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作: 超大群功能未开通或 app 权限错误 |
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?