Kick User from Room
Kick a specified user out of an RTC room.
Note
The kicked user can rejoin the room. To prevent rejoining, call the Block User in Specified Room or Block User in All Rooms API.
Request Method
POST: https://data center domain/rtc/user/kick.json
Signature Rule: All requests to RC server APIs require signature verification. See API Request Signature for details.
Request Body
The HTTP request body contains a JSON object with the following structure:
Parameter | Type | Required | Description |
---|---|---|---|
userId | String | Yes | Target user ID to be kicked |
roomId | String | Yes | RTC room ID |
Request Example
POST /rtc/user/kick.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json
{
"userId":"DDDDD",
"roomId":"DXXXX"
}
Response
The HTTP response body contains a JSON object with the following structure:
code
: Business status code in the HTTP response body.200
indicates success.
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200
}