发送群聊已读回执
更新时间: 2024/07/17 17:57:35
云信服务端支持在群聊场景下,将多条群消息标记为已读。
调用前提
该 API 需要先开通群组已读功能才能正常调用。
如未开通,请前往云信控制台开通该功能。配置路径:选择待开通该功能的应用,然后进入IM 即时通讯 > 功能配置 > 群聊 > 群组已读。
API 使用限制
单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。
URL
POST http://api.netease.im/nimserver/msg/markReadTeamMsg.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参见API调用方式。
-
POST 请求中 Body 的设置如下:
参数 |
类型 |
必填 | 说明 |
---|---|---|---|
accid | String | 是 | 需要标记已读的用户账号(accid) |
tid | Long | 是 | 群组的 ID |
msgids | Array of long number | 是 | 需要标记为已读的群消息数组。数组的每一项存放一个由云信服务端为群消息生成的消息 ID(serverId)。示例:[123123123123, 123123123123] |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
data | Object | 标记已读失败的消息列表对象,包含字段为 errMsgIds,表示标记已读失败的群消息 ID 列表 |
示例
cURL 请求示例
curl -X POST -H "AppKey: go9dnk49bkd9jd9v******lw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=wqt_tm_1&tid=2348681084&msgIdArray=[157617319445528738]' 'http://api.netease.im/nimserver/msg/markReadTeamMsg.action'
请求成功返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"data":
{
"errMsgIds" :[157617319445528739, 1231232312312123] // 未标记成功的消息id列表
}
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 403,
"desc": "permission denied" // 群已读功能未开通
}
状态码
状态码 | 说明 | 处理建议 |
---|---|---|
403 | 功能为开通 | 前往云信控制台开通群组已读功能 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低接口调用频率 |
500 | 服务错误 | 请联系技术支持 |
此文档是否对你有帮助?