Room Sessions

Kick participants from a room session.

Changed on

Removes the selected participants from the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

post/room_sessions/{room_session_id}/actions/kick

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/room_sessions/{room_session_id}/actions/kick
  • Auth
    none required

Path parameters

room_session_idstring uuid required
Example:0ccc7b54-4df3-4bca-a65a-3da1ecc777f0

The unique identifier of a room session.

Request body

excludestring[]

List of participant id to exclude from the action.

Example request

{
  "participants": "all",
  "exclude": [
    "7b61621f-62e0-4aad-ab11-9fd19e272e73"
  ]
}

Response

Success Action Response

Example response

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

Changes

  • a72569d69430Revision changes
    • breaking

      removed subschema #1: all_participants from the request property oneOf list

    • info

      added subschema #1 to the request property oneOf list