API 参考
圈组

获取群消息已读未读详情

更新时间: 2024/07/17 17:57:35

通过指定群 ID、消息 ID 和消息发送者的 IM 账号,可查询对应群消息的已读未读详情,包括目标消息已读数、目标消息的未读数、已读用户列表和未读用户列表。

API 使用限制

单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。

除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong服务器产生,群唯一标识,创建群时会返回,最大长度 64 位长整型
msgidLong发送群已读业务消息时服务器返回的消息 ID,最大长度 64 位长整型
fromAccidString消息发送者账号,accid,最大长度 32 位字符
snapshotBoolean是否返回已读、未读成员的 IM 账号(accid)列表,默认为 false

返回参数

参数类型说明
codeInteger状态码,请求成功则返回 200
dataString目标消息的详细已读未读信息

data 中的参数说明

参数 类型 说明
readSize Integer 目标消息的已读数
unreadSize Integer 目标消息的未读数
readAccids String 目标消息的已读用户列表,JSON
unreadAccids String 目标消息的未读用户列表,JSON

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk4****w0803mgq3" -H "Nonce: 4tggg***3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&msgid=1200510468189&fromAccid=user12&snapshot=true' 'https://api.netease.im/nimserver/team/getMarkReadInfo.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "data": {
        "readSize": 2, 
        "unreadSize": 1  
        "readAccids": [    
            "user1","user2"  
        ],
        "unreadAccids": [     
            "user3"  
        ],
    }
            
}

请求失败返回示例


"Content-Type": "application/json; charset=utf-8"
{
"code": 414,  // 参数错误
"desc": "xxxx  is empty" 
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 禁止操作 -
404 未找到记录 -
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超出限制 降低访问频率
500 服务出错 -
此文档是否对你有帮助?
有帮助
去反馈
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码