API 参考
圈组

修改超大群成员信息

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

IM 服务端支持修改超大群成员信息,包括超大群成员的群昵称,自定义扩展信息,以及超大群消息的提醒开关,用户可按需开启或关闭超大群消息提醒。

API 使用限制

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

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

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong云信服务器产生,超大群唯一标识,创建时会返回,最大长度 64 位长整型
accidString需要设置的用户账号,accid,最大长度 32 位字符
silentTypeInteger1,关闭消息提醒;0,打开消息提醒
nickString用户对应的群成员昵称,最大长度 32 位字符
customString自定义扩展字段,最大长度 32 位字符

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: e8c47bc1ede28***f7e7e8f2" -H "AppKey: fe41664**7ad2547" -H "Nonce: 1" -H "CurTime: 1452010720" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=4104&accid=zhangsan&silentType=1&nick=jack' 'https://api.netease.im/nimserver/superteam/updateTlist.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 禁止操作:
  • accid 不是群成员
  • 超大群功能未开通
  • 群昵称未通过反垃圾
    根据对应提示信息做出处理
    414 参数错误 根据提示信息,检查传入参数的格式和限制条件
    416 调用频率超出限制 降低访问频率
    500 服务出错 -
    此文档是否对你有帮助?
    有帮助
    去反馈
    • API 使用限制
    • URL
    • 请求参数
    • 示例
    • 请求示例(curl)
    • 请求成功返回示例
    • 请求失败返回示例
    • 状态码