API 参考
在线调试

拉黑聊天室成员

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

该接口用于拉黑/取消拉黑聊天室成员。

只有聊天室创建者或管理员可以拉黑聊天室成员。

调用频率

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

请求

URL

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

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

路径参数

参数名称 类型 是否必选 描述
account_id String 必选 需要拉黑或取消拉黑的成员账号 ID。

请求体参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。
operator_account_id String 必选 操作者账号 ID。只有聊天室创建者或管理员才能拉黑或取消拉黑聊天室成员。
blocked Boolean 必选 是否拉黑。true:设置为拉黑状态;false:取消拉黑状态。
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,
    "blocked": false
}

响应

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
114432 仅允许聊天室所有者或管理员操作 chatroom owner or manager operation permission required
114427 仅允许聊天室所有者操作 chatroom owner operation permission required
114405 聊天室成员重复操作 chatroom member repeated operation
114429 聊天室成员操作列表包含操作者 operator in chatroom member operation list
114437 聊天室成员数量超限 chatroom member limit
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码