IM 即时通讯
服务端
API 参考
圈组

查询@某人的未读消息

更新时间: 2023/02/09 20:58:55

圈组支持查询指定频道中@某个用户的未读消息列表。可通过调用本 API 进行查询。

其中@某个用户的未读消息具体包括以下三种:

  • 未读消息设置的@账号列表中包含目标用户。
  • 未读消息设置的需要@的身份组(不包括 everyone 身份组)中包含目标用户。
  • 未读消息设置的需要@所有人。

URL

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

请求参数

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

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

参数类型必须说明
accidString 用户的 IM 账号
serverIdLong服务器唯一标识
channelIdLong频道唯一标识
timeTagLong 查询的起始时间,默认值为 currentTime
查询范围:ackTime - timeTag,其中 ackTime 为用户查看过的最后一条信息的时间
查询顺序:倒序查询
limitInteger查询条数,默认 200 条,最大 200 条

返回参数

参数
说明
code 状态码
data 查询到的消息,包含 pageInfo(分页信息) 和 msgList(消息列表),消息的具体字段信息见下表
msgList 的字段
类型
说明
fromAccount String 发送方账号
fromNick String 发送方昵称
fromClientType String 发送方所使用设备的类型,如 AOS、IOS、PC、WEB、REST 等
time Long 发送时间
updateTime Long 更新时间
status Integer 消息状态,0 表示消息默认状态,1 表示撤回,2 表示删除,大于等于 10000 表示自定义状态
mentionedAll Integer 该消息是否@所有人,1 表示@所有人
body String 消息内容
attach String 消息附件
ext String 消息扩展字段
type Integer 消息类型,具体参见发送消息中 type 的说明
msgIdClient Long 消息的客户端消息 ID
msgIdServer Long 消息的服务端消息 ID

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk4***03mgq3" -H "Nonce: 4tggge**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9a**f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=ufdfiuadifadiofa&serverId=87834762&channelId=25372323&limit=100' 'https://api.netease.im/nimserver/qchat/queryChannelUnReadMentionedMsgPage.action'

返回示例

HTTP 响应:JSON

"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "data": {
    "pageInfo": {
      "nextTimetag": 1669794854264
    },
    "msgList": [
      {
        "fromNick": "wmyytest1",
        "msgIdClient": "100ada1c7bc04b6e9d59051d402203bf",
        "fromAccount": "wmyytest1",
        "mentionedAll": 1,
        "fromClientType": "REST",
        "updateTime": 1669794854264,
        "type": 0,
        "body": "10.196.124.59",
        "msgIdServer": 16846554,
        "time": 1669794854264,
        "status": 0
        "ext": "sasa",
        "attach": "sasa",
      }
    ]
  }
}

状态码

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

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