Skip to main content
POST
/
room_sessions
/
{room_session_id}
/
actions
/
kick
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx();

const response = await client.rooms.sessions.actions.kick('0ccc7b54-4df3-4bca-a65a-3da1ecc777f0');

console.log(response.data);
{
  "data": {
    "result": "ok"
  }
}

Path Parameters

​
room_session_id
string<uuid>
required

The unique identifier of a room session.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

Body

application/json

Parameters that can be defined during Kick action.

​
participants

Either a list of participant id to perform the action on, or the keyword "all" to perform the action on all participant.

Available options:
all
Example:

"all"

​
exclude
string<uuid>[]

List of participant id to exclude from the action.

Response

Success Action Response

​
data
object