房间用户踢出接口

更新时间：2022-03-16 15:56

1 接口调用说明

http请求方式: POST/JSON，需使用https
踢出某个房间的指定用户；调用这个接口后，被踢的这个用户会收到onKickOut的SDK接口回调，且这个用户当前的推流和拉流会全部停止。

服务环境	调用频率限制	请求示例
国内正式环境	50次/秒	curl -X POST https://liveroom{APPID}-api.zego.im/cgi/kickout -d 'json_str'
海外正式环境	50次/秒	curl -X POST https://liveroom{APPID}-api.zegocloud.com/cgi/kickout -d 'json_str'
国内测试环境	50次/秒	curl -X POST https://test2-liveroom-api.zego.im/cgi/kickout -d 'json_str'
海外测试环境	50次/秒	2020年12月9日及之后接入的用户，使用： curl -X POST https://liveroom-mctest.zego.im/cgi/kickout -d 'json_str' 2020年12月9日之前接入的用户，保持使用原域名： curl -X POST https://test2-liveroom-api.zegocloud.com/cgi/kickout -d 'json_str'

json_str 内容如下：

{
    "access_token": "ACCESS_TOKEN",
    "version": 1,
    "seq": 1,
    "room_id": "321",
    "kickout_user_account": ["user1", "user2", "user3"]
}

参数名	类型	是否必须	说明
access_token	String	是	调用接口凭证
version	Int	是	协议版本号，默认填 1
seq	Int	是	协议序列号
room_id	String	是	房间 ID
kickout_user_account	Array	是	踢出房间的目的用户账号ID列表；最大支持5个目的用户账号
custom_reason	String	是	踢人原因

正常情况下，会返回下述JSON数据包给调用方：

{
    "code": 0,
    "data": {
        "seq": 1,
        "version": 1
    },
    "message": "success"
}

返回参数说明:

错误时会返回错误码等信息，JSON数据包示例如下（该示例为输入参数错误）:

{
    "code": 2,
    "message": "输入参数错误"
}