聊天室标签禁言
PATCH
/im/v2/room_members/actions/chat_banned_tagged_members请求参数
Body 参数application/json
room_id
integer <long>
聊天室 ID
聊天室 ID。
operator_account_id
string
操作者账号 ID
操作者账号 ID。
target_tag
string
目标标签
需要禁言的目标标签。
chat_banned
boolean
禁言状态
是否设置为禁言状态。true:设置为禁言状态;false:取消禁言状态。
chat_banned_duration
integer <long>
临时禁言的时间
设置临时禁言的时间(秒)。chat_banned 为 true 时,该参数必填。禁言时间最大不能超过 2592000 秒(30天)。
notification_enabled
boolean
是否发送通知消息
操作完成后是否发送通知消息。false(默认):不发送;true:发送。
notification_extension
string
通知扩展字段
通知扩展字段,JSON 格式,长度上限为 2048 位字符。
notification_target_tags
string
目标标签表达式
禁言通知的目标标签表达式,默认发送给target_tag标签下的用户。例如 {"tag":"26333816"} AND {"tag":"243680"}
示例
{
"operator_account_id": "hzwanglei2014",
"chat_banned": true,
"notification_target_tags": "{\"tag\":\"tag1\"}",
"notification_extension": "dolore",
"notification_enabled": true,
"target_tag": "test01",
"chat_banned_duration": 3000
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer
必需
msg
string
必需
data
object
必需
mute_duration
integer
禁言时长。
示例
{
"code": 200,
"msg": "success",
"data": {
"mute_duration": 3000
}
}
最后修改时间: 8 个月前