该接口用于将聊天室中的指定成员踢出聊天室。

• 只有聊天室创建者和管理员才能踢人出聊天室。
• 只有聊天室创建者才能踢管理员，管理员之间不能互踢。

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2.1/room_members/{account_id}/actions/kicked

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

路径参数

参数名称	类型	是否必选	描述
account_id	String	是	需要踢出聊天室的用户账号 ID。

请求体参数

参数名称	类型	是否必选	描述
room_id	Long	是	聊天室 ID。
operator_account_id	String	是	操作者账号 ID。只有聊天室创建者或管理员才能踢人出聊天室。
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
}

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

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

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {}
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
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	聊天室成员无效	chatroom member was already deleted
114429	不能对自己进行操作	operator in chatroom member operation list
114432	仅允许聊天室所有者或管理员操作	chatroom owner or manager operation permission required
114427	操作者必须为创建者	chatroom owner operation permission required
500	服务端内部错误	internal server error
503	服务器繁忙	server busy