Skip to main content

Kick participants from a room session.

POST 
/room_sessions/:room_session_id/actions/kick

Request ​

Path Parameters

    room_session_id uuidrequired

    The unique identifier of a room session.

Body

required

Parameters that can be defined during Kick action.

    participants

    object

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

    oneOf

    string

    Possible values: [all]

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

    exclude uuid[]

    List of participant id to exclude from the action.

Responses ​

200: Success Action Response

Schema

    data

    object

    result string

Request samples

curl -L 'https://api.telnyx.com/v2/room_sessions/:room_session_id/actions/kick' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "participants": "all",
  "exclude": [
    "7b61621f-62e0-4aad-ab11-9fd19e272e73"
  ]
}'

Response samples

{
  "data": {
    "result": "ok"
  }
}