API 参考
在线调试

更新群成员信息

更新时间: 2024/07/18 14:53:22

功能描述

该接口用于更新群组指定成员的群昵称、禁言状态、消息提醒状态等信息,包括高级群成员和超大群成员。

  • 只有群主和管理员可以更新普通群成员的信息,包括群昵称、禁言状态、消息提醒状态等信息。
  • 管理员信息只有群主可以更新,管理员不能修改其他管理员的信息。

调用频率

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

请求

URL

PATCH https://open.yunxinapi.com/im/v2/team_members/:{account_id}

请求 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 位字符。该字段仅针对高级群,对超大群无效。

请求体示例

json{
    "team_type": 1,
    "team_id": 2350566792,
    "team_nick": "另一个昵称",
    "chat_banned": true,
    "message_notify_state": 0,
    "extension": "",
    "operator_id": "ciios01"
}

响应

Header

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

响应体参数

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

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "member_role": 1,
        "account_id": "yx",
        "chat_banned": true,
        "invitor_account_id": "0",
        "team_nick": "",
        "create_time": 1657619302830,
        "update_time": 1657619302830
    }
}

错误码

错误码 错误码描述 错误信息示例
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
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码