服务端
API 参考
圈组

账号全局禁言

更新时间: 2024/03/15 14:31:50

设置或取消账号的全局禁言状态,对单聊、群聊、聊天室、圈组模块全部生效。

该接口不推荐使用,如果需要全局禁言,可以通过调用 muteModule.action 接口指明每个模块的禁言状态来实现,具体请参考账号功能模块禁言

功能描述

账号被设置为全局禁言后,不能发送单聊、群聊、聊天室和圈组消息,但是可以接收消息,也可以发送自定义系统通知。

若账号全局禁言后,发送消息会返回 423 错误码。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

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

请求参数

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

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

参数类型必须说明
accidString 用户帐号,最大长度 32 位字符
mute Boolean 是否全局禁言:
true:全局禁言,false:取消全局禁言mute = true,即表示该账号在所有功能模块都处于禁言状态

示例

请求示例(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=zhangsan&mute=true'  'https://api.netease.im/nimserver/nimserver/user/mute.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code":414
    "desc":"mute not boolean"  // 参数mute不是true或者false
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
500 服务出错 -
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码