账号功能模块禁言
更新时间: 2024/07/18 10:13:44
设置或取消账号在某功能模块中的禁言状态。
功能描述
在单聊模块(P2P)、群组模块(Team)、聊天室模块(Chatroom)或圈组模块(QChat)中单独设置/取消账号的禁言状态。
账号在某模块中被设置禁言后,不能在该模块中发送消息(发送消息会返回 423 错误码),但是可以接收消息,也可以发送自定义系统通知。
API 使用限制
单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。
URL
httpPOST https://api.netease.im/nimserver/user/muteModule.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考 API 调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
accid | String | 是 | 用户帐号,最大长度 32 位字符 |
muteP2P | Boolean | 否 | 是否在单聊模块中禁言该账号 true:禁言,false:取消禁言 |
muteTeam | Boolean | 否 | 是否在群组模块中禁言该账号 true:禁言,false:取消禁言 |
muteRoom | Boolean | 否 | 是否在聊天室模块中禁言该账号 true:禁言,false:取消禁言 |
muteQChat | Boolean | 否 | 是否在圈组模块中禁言该账号 true:禁言,false:取消禁言 |
- 入参
muteP2P
,muteTeam
,muteRoom
,muteQChat
都是非必填项,但至少填一个,否则将报 414 错误。 - 建议用户在调用该接口时填写全部的入参,指明账号在每一个模块中的禁言状态。
返回参数
参数 | 说明 |
---|---|
code | 状态码,200 表示请求成功 |
data | 用户在各模块中的禁言状态 |
data 中的参数说明
参数 | 说明 |
---|---|
muteP2P | 在单聊模块中的禁言状态 |
muteTeam | 在群组模块中的禁言状态 |
muteRoom | 在聊天室模块中的禁言状态 |
muteQChat | 在圈组模块中的禁言状态 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk4***803mgq3" -H "Nonce: 4tgg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=123123&muteP2P=true' 'https://api.netease.im/nimserver/nimserver/user/muteModule.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200
"data":{
"muteP2P": false,
"muteTeam": true,
"muteRoom": false,
"muteQChat": false
}
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code":414
"desc":"missing required parameter" // 没有传入任何禁言状态
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
500 | 服务出错 | - |
此文档是否对你有帮助?