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

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

调用频率

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

请求

URL

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

Header

请求 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 的参数说明请参见 响应 Header。

响应体参数

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

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {}
}

错误码

错误码	错误码描述	错误信息示例
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