圈组的消息默认存云端历史。可调用本 API 查询云端历史消息。

URL

httpPOST https://api.netease.im/nimserver/qchat/queryHistoryMsg.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考API调用方式。

• POST 请求中 Body 的设置如下：

参数	类型	必须	说明
accid	String	是	操作者的 IM 账号（即 accid）
fromTime	String	否	开始时间，默认0，单位毫秒
toTime	String	否	结束时间，默认当前时间，单位毫秒
serverId	String	是	服务器唯一标识
channelId	String	是	频道唯一标识
excludeMsgId	String	否	排除的消息 ID，分页时请填写上一页最后一条消息的消息 ID，用于定位锚点 主要是为了处理分页时，边界上多条消息的发送时间戳相同的情况
limit	String	否	查询条数，默认100，最大100
reverse	String	否	是否逆序，0或者1，默认0，表示从现在往过去查

返回参数

参数	说明
code	状态码
data	查询到的云端历史消息，字段信息见下表

data 的字段	类型	说明
fromAccount	String	发送方账号
fromNick	String	发送方昵称
fromClientType	String	发送方所使用设备的类型，如 AOS、IOS、PC、WEB 等
time	Long	发送时间
updateTime	Long	更新时间
status	int	消息状态，0 表示消息默认状态，1 表示撤回，2 表示删除，大于等于 10000 表示自定义状态
body	String	消息内容
attach	String	消息附件
ext	String	消息扩展字段
type	int	消息类型，具体参见发送消息中 type 的说明
msgIdServer	Long	消息的服务端消息 ID
msgIdClient	Long	消息的客户端消息 ID

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9**w0803mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&serverId=1&channelId=1' 'https://api.netease.im/nimserver/qchat/queryHistoryMsg.action'

返回示例

HTTP 响应：JSON

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "data":
    [
        {
            "fromAccount": "zhangsan",
            "fromNick": "张三",
            "fromClientType": "IOS",
            "time": 1234,
            "updateTime": 1234,
            "status": 1,
            "body": "abc",
            "attach": "sasa",
            "ext": "sasa",
            "type": 0,
            "msgIdServer": 123,
            "msgIdClient": "assas"
        },
        {
            "fromAccount": "zhangsan",
            "fromNick": "张三",
            "fromClientType": "IOS",
            "time": 1234,
            "updateTime": 1234,
            "status": 1,
            "body": "abc",
            "attach": "sasa",
            "ext": "sasa",
            "type": 0,
            "msgIdServer": 123,
            "msgIdClient": "assas"
        }
    ]
}

状态码

该接口在 HTTPS Body 中返回请求的状态码，以下仅列出与接口业务相关的状态码。完整状态码及说明请参见状态码。

状态码	说明	处理建议
200	请求成功	-
403	非法操作或没有权限	检查是否已开通圈组功能
404	对象不存在	检查传入的账号、消息 ID、服务器 ID、频道 ID 等信息是否存在 检查是否存在必传参数为空的问题
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超限	降低调用频率
431	HTTP 重复请求	-