禁言群组
更新时间: 2025/04/01 18:43:50
使用该接口对群聊进行禁言或者解除禁言。群主可以禁言整个群组,只对普通成员生效,即普通成员不能发送消息,群主和管理员可以发送消息。同时,也支持禁言整个群,包括群主。
功能介绍
网易云信 IM 支持三种禁言方式:
- 账号全局禁言:账号被设置为全局禁言后,不能发送任何消息(包含点对点、群组(高级群和超大群)、聊天室消息)。
- 群整体禁言:可选择禁言整个群(包括群主),或者只禁言普通成员。
- 指定群成员禁言:可以禁言指定群成员,包括管理员和普通成员。
上述三种禁言方式相互独立。例如,某账号加入某高级群后,先后被全局禁言、群整体禁言、单个群成员禁言,那么需要分别解除三种禁言后才能恢复在该高级群发言。
使用限制
单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
除 发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。
请求信息
请求 URL
POST https://api.yunxinapi.com/nimserver/team/muteTlistAll.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考 API 调用方式。
-
POST 请求中 Body 的设置如下:
参数 类型 必须 说明 tid Long 是 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度 64 位长整型 owner String 是 群主账号,accid,最大长度 32 位字符 mute Boolean 否 true,禁言普通成员。false,解禁 - 当 mute 为空时则根据 muteType 取值进行处理。
- mute 和 muteType 至少提供一个,两个都提供时,按 mute 处理。两个都不提供时,返回 414 错误码。
muteType Integer 否 禁言类型
0,解除禁言。1,禁言普通成员。3,禁言整个群(包括群主)只有 mute 为空时,该字段才有效。 attach String 否 自定义扩展字段,最大长度 512 位字符
请求示例(curl)
cURLcurl -X POST -H "AppKey: go9dnk***w0803mgq3" -H "Nonce: 4tggge** 3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&mute=1' 'https://api.yunxinapi.com/nimserver/team/muteTlistAll.action'
返回信息
请求成功返回示例
JSON"Content-Type": "application/json; charset=utf-8"
{
"code":200
}
请求失败返回示例
JSON"Content-Type": "application/json; charset=utf-8"
{
"code": 414, // 参数错误
"desc": "xxxx is empty"
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参考 状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作:
|
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?