该接口用于更新聊天室在线成员（固定成员和游客）信息，包括昵称、头像、扩展字段信息。

• 固定成员可修改在线信息，同时可以指定是否修改固定成员持久化信息。若固定成员不在线，且无需持久化时，接口返回聊天室成员不在线的错误信息。
• 游客可修改在线信息。游客不在线时，接口返回聊天室成员不在线的错误信息。

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/room_members/{account_id}

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

请求头参数

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

路径参数

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

请求体参数

参数名称	类型	是否必选	描述
room_id	Long	是	聊天室 ID。
persistence	Boolean	否	是否修改固定成员持久化信息。false（默认）：不持久化；true：持久化。 该参数只对固定成员生效，对游客不生效 固定成员不在线，且无需持久化时，接口返回聊天室成员不在线的错误信息
room_nick	String	否	成员在聊天室中的昵称，需要通过反垃圾审核。
room_avatar	String	否	成员在聊天室中的头像，需要通过反垃圾审核。
extension	String	否	自定义扩展字段，字段上限为 4096 字符，需要通过反垃圾审核。
notification_enabled	Boolean	否	操作完成后是否发送通知消息。false（默认）：不发送；true：发送。
notification_extension	String	否	通知扩展字段，JSON 格式，长度上限为 2048 字符。
- antispam_configuration	Object	否	安全通相关配置项。
enabled	Boolean	否	是否开启安全通，默认为 true，即默认启用 安全通 功能。如果需要关闭安全通检测，请设置为 false。该字段只针对在 网易云信控制台 开通了安全通业务的应用生效。若未开启安全通业务，该字段无效。
- business_id_map	Array of objects	否	安全通业务列表。
type	Integer	是	检测类型。1：文本；2：图片。
business_id	String	是	安全通业务 ID，可以指定当前群组信息过安全通某个检测策略。 默认情况下 网易云信控制台 会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请 提交工单 联系网易云信技术支持工程师进行配置，配置好后传入对应的安全通业务 ID，表示当前群组信息过安全通的指定检测策略。

请求体示例

JSON{
    "room_id": 1602735437,
    "extension": "laborum",
    "room_avatar": "deserunt non irure id",
    "notification_extension": "sit laboris ullamco ut Ut",
    "notification_enabled": true,
    "room_nickname": "梁磊 0001"
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
extension	String	自定义扩展字段。	否
room_id	Long	聊天室ID。	否
account_id	String	账号ID。	否
room_nick	String	用户在聊天室内的昵称。	否
room_avatar	String	用户在聊天室内的头像。	否
member_role	Integer	成员角色。	否
is_online	Boolean	否否在线。	否
enter_time	Long	进入时间戳。	否
blocked	Boolean	是否被拉黑。	否
chat_banned	Boolean	是否被禁言。	否
temp_chat_banned	Boolean	是否被临时禁言。	否
- online_info_list	Object	在线信息列表。	否
robot	Boolean	是否为机器人。	否
room_nick	String	在聊天室内的昵称。	否
room_avatar	String	在聊天室内的头像。	否
enter_time	Long	进入时间戳。	否
client_type	Integer	客户端类型。	否
online_count	Integer	在线人数。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "extension": "extension-自定义扩展字段",
        "room_id": 11665969994,
        "account_id": "test2",
        "room_nick": "test2-更新本人在聊天室内的昵称等信息",
        "room_avatar": "room_avatar",
        "member_role": 3,
        "is_online": true,
        "enter_time": 1752807502204,
        "blocked": false,
        "chat_banned": false,
        "temp_chat_banned": false,
        "online_info_list": [
            {
                "robot": false,
                "room_nick": "test2-更新本人在聊天室内的昵称等信息",
                "room_avatar": "room_avatar",
                "enter_time": 1752807502204,
                "client_type": 1
            }
        ],
        "online_count": 1
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
102404	用户不存在	account not exist
113410	聊天室服务未开通	chatroom service disabled
113404	聊天室不存在	chatroom not exist
113406	聊天室已关闭	chatroom closed
114404	聊天室成员不存在	chatroom member not exist
114408	聊天室成员已删除	Member: %s was already deleted
500	服务端内部错误	internal server error
503	服务器繁忙	server busy