API 参考
在线调试

更新群组信息

更新时间: 2024/07/17 17:08:08

该接口用于更新群组(包括高级群和超大群)信息,包括群组名称、群组类型、入群模式、群组禁言状态等信息。

只有群主和管理员可以修改群组的基本信息。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

PATCH https://open.yunxinapi.com/im/v2/teams/:{team_id}

请求 Header 的参数说明请参见 请求 Header

路径参数

参数名称 类型 是否必选 描述
team_id String 必选 群组 ID,创建群组成功时,云信服务器会自动生成并返回。

请求体参数

参数名称 类型 是否必选 描述
operator_id String 必选 操作者(群主或管理员)账号 ID。
team_type Integer 必选 需要更新的群组类型。1:高级群;2:超大群。
name String 可选 群组名称,长度上限 64 位字符。
icon String 可选 群组头像的 URL 地址,例如 "https://netease/xxx.png" ,长度上限 1024 位字符。
announcement String 可选 群组公告,长度上限 1024 位字符。
intro String 可选 群组简介,长度上限 512 位字符。
members_limit Integer 可选 群组成员数上限(包含群主),默认为 200。可设置范围的为:[2 ~ 200]。。若需要扩展群容量,请前往云信控制台配置。配置好后,该参数颗设置的范围为:[2 ~ 控制台设置的群人数上限]。
server_extension String 可选 自定义群组扩展字段,第三方可以跟据此属性自定义扩展自己的群属性,建议封装成 JSON 格式,{key:value}。长度上限 1024 位字符。
extension String 可选 自定义扩展字段,即自定义的通知字段,JSON 格式,不会持久化。长度上限 512 位字符。该字段仅针对高级群,对超大群无效。
configuration Object 可选 群组配置项。
antispam_configuration Object 可选 安全通相关配置项。

请求体示例

json{
    "operator_id": "123456",
    "name": "test",
    "configuration": {
        "join_mode": 0
    }
}

响应

Header

响应 Header 的参数说明请参见 响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code":200,
    "msg":"success",
    "data":{
        "tinfo":{
                "team_id":"123456",
                "icon": null,   
                "announcement": null,  
                "server_extension":"",   
                "intro":null,  
                "name":"test",  
                "extension":"", 
                "configuration":{
                   "update_team_info_mode": 0,
                   "invite_mode": 1, 
                   "join_mode": 0, 
                   "agree_mode": 1,     
                   "update_extension_mode": 0, 
                   "chat_banned_status": 0,  
                }       
          } 
     }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
102404 用户不存在 account not exist
108302 非高级群 not advanced team
108311 超大群服务未开通 super team service disabled
108404 群组不存在 team not exist
108451 群组信息未过反垃圾审核 team hit antispam
109404 群成员不存在 team member not exist
109432 仅允许群主或管理员操作 team owner or manager operation permission required
109427 仅允许群主操作 team owner operation permission required
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码