API 参考
在线调试

临时禁言聊天室成员

更新时间: 2024/07/17 17:26:06

该接口用于将聊天室成员设置为临时禁言状态或取消临时禁言状态。临时禁言,即在特定时间段内禁言,过了特定时间段,自动取消成员的临时禁言状态。

  • 只有聊天室创建者可以设置管理员的临时禁言状态。
  • 聊天室创建者和管理员可以设置普通成员的临时禁言状态。
  • 不能设置自己的临时禁言状态。

调用频率

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

请求

URL

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

请求 Header 的参数说明请参见请求 Header

路径参数

参数名称 类型 是否必选 描述
account_id String 必选 需要设置临时禁言的成员账号 ID。

请求体参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。
operator_account_id String 必选 操作者账号 ID。只有聊天室创建者或管理员才能临时禁言/取消临时禁言聊天室成员。
chat_banned Boolean 必选 是否设置为禁言状态。true:设置为禁言状态;false:取消禁言状态。
chat_banned_duration Long 可选 设置临时禁言的时间(秒)。chat_banned 为 true 时,该参数必填。禁言时间最大不能超过 2592000 秒(30天)。
notification_enabled Boolean 可选 操作完成后是否发送通知消息。false(默认):不发送;true:发送。
notification_extension String 可选 通知扩展字段,JSON 格式,长度上限为 2048 字符。

请求体示例

json{
    "operator_account_id": "ciaos20",
    "room_id": 1602735437,
    "notification_extension": "dolor labore Lorem ut",
    "notification_enabled": true,
    "chat_banned_duration":3000,
    "chat_banned": false
}

响应

Header

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

响应体参数

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

响应体示例

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

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
102404 用户不存在 account not exist
113410 聊天室服务未开通 chatroom service disabled
113404 聊天室不存在 chatroom not exist
113406 聊天室已关闭 chatroom closed
114432 仅允许聊天室所有者或管理员操作 chatroom owner or manager operation permission required
114427 仅允许聊天室所有者操作 chatroom owner operation permission required
114301 目标账号在禁言或黑名单列表中 target account in blocklist or chat banned list of chatroom
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码