该接口用于更新群组（包括高级群和超大群）信息，包括群组名称、群组类型、入群模式、群组禁言状态、群消息免打扰等信息。

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

调用频率

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

请求信息

请求 URL

PATCH https://open.yunxinapi.com/im/v2.1/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	否	自定义群组扩展字段，第三方可以跟据此属性自定义扩展自己的群属性，建议封装成 JSONObject 格式，{key:value}。长度上限 1024 位字符。
customer_extension	String	否	客户端自定义扩展字段，仅服务器 API 可以设置，SDK 仅负责透传，不解析内容。
extension	String	否	自定义扩展字段，即自定义的通知字段，JSON 格式，不会持久化。长度上限 512 位字符。对应客户端 SDK 通知消息附件 V2NIMMessageNotificationAttachment 的 serverExtension 字段。该字段仅针对高级群，对超大群无效。
+ configuration	Object	否	群组配置项。
join_mode	Integer	否	通过 SDK 侧操作申请入群的验证方式。 0（默认）：无需验证，直接入群。 1：需要群主或管理员验证通过才能入群。 2：不允许任何人申请入群。
agree_mode	Integer	否	邀请入群时是否需要被邀请人的同意。 0（默认）：需要被邀请人同意才能入群。 1：不需要被邀请人同意，直接入群。
invite_mode	Integer	否	邀请权限，即谁可以邀请他人入群。 0（默认）：群主和管理员。 1：所有人。
update_team_info_mode	Integer	否	客户端修改群组信息的权限，即谁可以修改群组信息。 0（默认）：群主和管理员。 1：所有人。
update_extension_mode	Integer	否	客户端修改群自定义扩展信息（server_extension&customer_extension）权限，即谁可以修改群自定义扩展信息。 0（默认）：群主和管理员。 1：所有人。
chat_banned_mode	Integer	否	群组禁言状态。 0（默认）：取消群组禁言。 1：禁言全体普通成员，不包括群主和管理员。 3：禁言全体成员。
+ antispam_configuration	Object	否	安全通相关配置项。
enabled	Boolean	否	是否开启安全通，默认为 true，即默认使用安全通功能。如果需要设置单条消息不过安全通，则设置为 false。只有在 网易云信控制台 开通安全通业务的用户，该字段才有效，如未开启安全通业务，该字段无效。
+ business_id_map	Array of objects	否	安全通业务列表。
type	Integer	是	检测类型。1：文本。2：图片。
business_id	String	是	安全通业务 ID，可以指定当前群组信息过安全通某个检测策略。 默认情况下网易云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请 提交工单 联系网易云信技术支持工程师进行配置，配置好后传入对应的安全通业务 ID，表示当前群组信息过安全通的指定检测策略。

请求体示例

JSON{
    "operator":"123456",
    "team_name":"test",
    "configuration":{
       "join_mode":0     
    }
}

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
+ team_info	Object	修改的群组信息。	是
team_id	Long	群组 ID，网易云信服务器返回。	是
name	String	群组名称。	是
icon	String	群组头像的 URL 地址。	是
announcement	String	群组公告	是
intro	String	群组简介。	是
server_extension	String	自定义群组扩展字段，第三方可以跟据此属性自定义扩展自己的群属性，建议封装成 JSON 格式，{key:value}。	否
customer_extension	String	客户自定义扩展字段，仅服务器 API 可以设置，SDK 仅负责透传，不解析内容。	否
create_time	Long	群组创建时间戳。	是
update_time	Long	群组更新时间戳。	是
+ configuration	Object	群组配置项。	是
join_mode	Integer	通过 SDK 侧操作申请入群的验证方式。 0：无需验证，直接入群。 1：需要群主或管理员验证通过才能入群。 2：不允许任何人申请入群。	是
agree_mode	Integer	邀请入群时是否需要被邀请人的同意。 0：需要被邀请人同意才能入群。 1：不需要被邀请人同意，直接入群。	是
invite_mode	Integer	邀请权限，即谁可以邀请他人入群。 0：群主和管理员。 1：所有人。	是
update_team_info_mode	Integer	客户端修改群组信息的权限，即谁可以修改群组信息。 0：群主和管理员。 1：所有人。	是
update_extension_mode	Integer	客户端修改群自定义扩展信息（server_extension&extension）权限，即谁可以修改群自定义扩展信息。 0：群主和管理员。 1：所有人。	是
chat_banned_mode	Integer	群组禁言状态。 0：取消全员禁言。 1：全员禁言，不包括群主和管理员。 3：全员禁言。	否

响应体示例

JSON{
    "code":200,
    "msg":"success",
    "data":{
        "tinfo":{
                "team_id":"123456",
                "icon": null,
                "announcement": null,
                "members_limit": 1000,
                "server_extension":"",
                "intro":null,
                "name":"test",
                "customer_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