API 参考
圈组

禁言超大群

更新时间: 2024/07/17 17:57:35

群主可以禁言整个超大群,只对普通成员生效,即普通成员不能发送消息,群主和管理员可以发送消息。

API 使用限制

单个应用中 1 秒内所有的超大群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。

  • 除超大群消息相关 API 外,其他所有超大群 API 都属于超大群操作 API。
  • 超大群消息相关 API 包括:发送超大群消息,发送超大群自定义系统通知,撤回超大群消息,根据用户 ID/消息 ID 查询超大群历史消息。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong云信服务器产生,超大群唯一标识,创建时会返回,最大长度 64 位长整型
ownerString群主帐号,accid,最大长度 32 位字符
muteTypeInteger禁言类型
0,解除禁言;1,禁言普通成员;3,禁言整个超大群(包括群主)

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dn***03mgq3" -H "Nonce: 4tggger**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&muteType=1' 'https://api.netease.im/nimserver/superteam/mute.action'

请求成功返回示例

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

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "tid not exist!"  // 群不存在
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 禁止操作:
  • owner 不是群成员
  • owner 不是群主
  • 超大群功能未开通
    根据对应提示信息做出处理
    414 参数错误 根据提示信息,检查传入参数的格式和限制条件
    416 调用频率超出限制 降低访问频率
    500 服务出错 -
    此文档是否对你有帮助?
    有帮助
    去反馈
    • API 使用限制
    • URL
    • 请求参数
    • 示例
    • 请求示例(curl)
    • 请求成功返回示例
    • 请求失败返回示例
    • 状态码