API 参考
在线调试

清空聊天室虚构用户

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

该接口用于在聊天室中删除所有虚构用户。

调用频率

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

请求

URL

DELETE https://open.yunxinapi.com/im/v2/room_members/actions/clear_virtual_members

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

查询参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。
notification_enabled Boolean 可选 清空聊天室中的虚构用户是否发送通知,默认为 true(通知)。

响应

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
113404 聊天室不存在 chatroom not exist
113410 聊天室服务未开通 chatroom service disabled
113406 聊天室已关闭 chatroom closed
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码