该接口用于更新群组指定成员的群昵称、禁言状态、群消息免打扰方式以及特别关注等信息，包括高级群成员和超大群成员。

• 只有群主和管理员可以更新普通群成员的信息。
• 管理员信息只有群主可以更新，管理员不能修改其他管理员的信息。

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2.1/team_members/{account_id}

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

请求路径参数

参数名称	类型	是否必选	描述
account_id	String	是	需要更新信息的群成员账号 ID。

请求体参数

参数名称	类型	是否必选	描述
operator_id	String	是	操作者（群主或管理员）账号 ID。
team_type	Integer	是	群组类型。1：高级群。2：超大群。
team_id	Long	是	群组 ID。
team_nick	String	否	此成员在本群中的昵称（只在本群中生效，不影响其他群组）。该字段支持反垃圾检测。
chat_banned	Boolean	否	在本群中是否禁言此成员，false（默认）：不禁言。true：禁言。
message_notify_state	Integer	否	本群的新消息是否免打扰（是否提醒该成员），0：免打扰（不提醒）。1：提醒。2：仅提醒群主和群管理员的消息。
extension	String	否	自定义扩展字段，即自定义的通知字段，JSON 格式，不会持久化。长度上限 512 位字符。对应客户端 SDK 通知消息附件 V2NIMMessageNotificationAttachment 的 serverExtension 字段。该字段仅针对高级群，对超大群无效。
server_extension	String	否	服务端自定义扩展字段。该字段支持反垃圾检测。
- antispam_configuration	Object	否	安全通相关配置项。
enabled	Boolean	否	是否开启安全通，默认为 true，即默认启用 安全通 功能。如果需要关闭安全通检测，请设置为 false。该字段只针对在 网易云信控制台 开通了安全通业务的应用生效。若未开启安全通业务，该字段无效。
- business_id_map	Array of objects	否	安全通业务列表。
type	Integer	是	检测类型。1：文本。2：图片。
business_id	String	是	安全通业务 ID，可以指定当前群成员信息过安全通某个检测策略。 默认情况下 网易云信控制台 会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请 提交工单 联系网易云信技术支持工程师进行配置，配置好后传入对应的安全通业务 ID，表示当前群组信息过安全通的指定检测策略。

• team_nick 和 server_extension 字段更新，SDK 会触发通知，群组内全部成员会收到该成员信息同步更新的通知。
• 若将 chat_banned 设置为 true，即设置该成员禁言，SDK 会触发通知，群组内全部成员会收到该成员被禁言的通知。
• 若更新 message_notify_state 字段，SDK 会触发通知，被更新的成员会收到信息同步更新的通知。

请求体示例

JSON{
  "operator_id": "account123",
  "team_type": 1,
  "team_id": 12345678,
  "team_nick": "小王",
  "chat_banned": false,
  "message_notify_state": 1,
  "extension": "{\"operation\":\"modify_member\",\"reason\":\"违反群规\"}",
  "server_extension": "{\"level\":3,\"join_time\":1642558200}",
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
team_id	Long	群组 ID。	是
member_role	Integer	群成员的角色。0：群主。1：群管理员。2：群普通成员。	是
account_id	String	该成员的账号 ID。	是
chat_banned	Boolean	该成员是否被禁言	是
team_nick	String	该成员在本群中的昵称。	是
invitor_account_id	String	邀请该成员入群的用户账号 ID。	否
server_extension	String	服务器扩展字段。	否
join_time	Long	成员加入群组的时间戳。	是
update_time	Long	群成员信息更新的时间戳。	是

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "team_id": 44079780655,
        "account_id": "test1",
        "member_role": 0,
        "team_nick": "team_nick_name1752571597365",
        "server_extension": "extension1111",
        "chat_banned": false,
        "join_time": 1752571596536,
        "update_time": 1752571597482
    }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
102404	用户不存在	account not exist
108311	超大群服务未开通	super team service disabled
108404	群组不存在	team not exist
109404	群成员不存在	team member not exist
109305	不允许操作管理员	operation on team manager not allowed
109432	仅允许群主或管理员操作	team owner or manager operation permission required
109451	群成员反垃圾	team member hit antispam
500	服务端内部错误	internal server error
503	服务器繁忙	server busy