网易云信 IM 服务端支持对聊天室成员设置为临时禁言状态，也支持将聊天室设置为整体禁言状态。

• 还可通过聊天室角色设置 API 将某成员设置为禁言用户，实现禁言功能。具体请参见设置角色。
• 还可通过标签禁言 API 将带有某标签的聊天室都设置为整体禁言状态。具体请参见标签禁言。

设置临时禁言状态

功能描述

将聊天室内成员设置为在特定时间段内禁言，操作者必须是管理员或创建者角色。

聊天室用户角色配置相关 API 说明请参见管理聊天室用户角色。

URL

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

请求参数

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

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

参数	类型	必须	说明
roomid	long	是	聊天室id
operator	String	是	操作者accid,必须是管理员或创建者
target	String	是	被禁言的目标账号accid
muteDuration	long	是	0:解除禁言;>0设置禁言的秒数，不能超过2592000秒(30天)
needNotify	Boolean	否	操作完成后是否发送通知消息，true：发送，false：不发送，默认 true
notifyExt	String	否	通知消息的扩展字段，长度限制 2048 字符

示例

cURL请求示例

curlcurl -X POST -H "CheckSum: 66dc1ad0166a***hh049c937777" -H "AppKey: acd7y640c***1847aggggg" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=123&operator=zhangsan&target=lisi&muteDuration=300&notifyExt=这是扩展字段' "https://api.netease.im/nimserver/chatroom/temporaryMute.action"

请求成功返回示例

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

将聊天室整体禁言

功能描述

将聊天室设置为整体禁言状态（仅创建者和管理员能发言），操作者必须是管理员或创建者角色。

聊天室用户角色配置相关 API 说明请参见管理聊天室用户角色。

URL

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

请求参数

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

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

参数	类型	必须	说明
roomid	long	是	聊天室id
operator	String	是	操作者accid，必须是管理员或创建者
mute	Boolean	是	true：将聊天室设置为整体禁言状态（仅创建者和管理员能发言），false：取消整体禁言状态
needNotify	String	否	操作完成后是否发送通知消息，true：发送，false：不发送，默认 true
notifyExt	String	否	通知消息的扩展字段，长度限制 2048 字符

示例

cURL请求示例

curlcurl -X POST -H "CheckSum: 32dc17d0***9bbf049c9367e7" -H "AppKey: fe416640***e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=4235&operator=zhangsan&mute=true'  "https://api.netease.im/nimserver/chatroom/muteRoom.action"

请求成功返回示例

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

状态码

上述 API 在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。