API 参考
圈组

设置群消息免打扰

更新时间: 2024/08/06 17:37:43

网易云信 IM 服务端支持设置群消息免打扰,设置群消息免打扰后,该群组的消息不会触发在线消息提醒和离线推送的通知栏。

API 使用限制

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

除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考 API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong云信服务端产生,群唯一标识,创建群时会返回,最大长度 64 位长整型
accidString需要设置群消息免打扰的账号 ID,最大长度 32 位字符该用户必须为群组成员。
ope Integer1,群消息免打扰;2,开启群消息提醒

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: e8c47bc1ede283cc4c382ba741de33f1f7e7e8f2" -H "AppKey: fe416640***47ad2547" -H "Nonce: 1" -H "CurTime: 1452010720" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhouliangwei&tid=4104&ope=2' 'https://api.netease.im/nimserver/team/muteTeam.action'

请求成功返回示例

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

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
"code": 414,  // 参数错误
"desc": "xxxx  is empty" 
}

状态码

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

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