在线调试
修改聊天室在线成员标签
更新时间: 2024/07/17 17:26:06
该接口用于修改聊天室在线成员的标签,修改标签后可以选择是否通知目标标签用户。
聊天室标签功能请参见聊天室标签。
只有聊天室创建者或管理员才能修改其他在线成员的用户标签。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}/actions/tags
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
account_id |
String | 必选 | 需要修改标签的聊天室成员的账号 ID。 |
请求体参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
room_id |
Long | 必选 | 聊天室 ID。 |
tags |
String | 必选 | 需要设置的标签,可设置多个标签,JSON 字符串格式,例如 ["tag1", "tag2"]。 |
notify_target_tags |
String | 可选 | 通知目标标签,修改后,目标标签下的用户会收到通知。 是标签表达式,同时也会改变该连接掉线时的通知对象。 |
notify_extension |
String | 可选 | 通知扩展字段,长度上限为 2048 字符。 |
请求体示例
json{
"room_id": 72,
"notify_target_tags": "{\"tag\":\"tag1\"}",
"notify_extension": "dolore",
"tags": ["test01", "test02"]
}
响应
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 |
114432 | 仅允许聊天室所有者或管理员操作 | chatroom owner or manager operation permission required |
114304 | 目标成员帐号不在线 | Target chatroom member offline |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?