Rooms

Create a room.

Changed on

Synchronously creates a new video room with the provided configuration and returns the created room.

post/rooms

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/rooms
  • Auth: HTTP bearer

Request body

unique_namestring

The unique (within the Telnyx account scope) name of the room.

max_participantsinteger

The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected.

enable_recordingboolean

Enable or disable recording for that room.

webhook_event_urlstring uri

The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.

webhook_event_failover_urlstring uri

The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

webhook_timeout_secsinteger

Specifies how many seconds to wait before timing out a webhook.

Example request

{
  "unique_name": "My room",
  "max_participants": 10,
  "enable_recording": true,
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_timeout_secs": 25
}

Response

Create room response.

Example response

{
  "data": {
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "max_participants": 50,
    "unique_name": "My Room",
    "created_at": "2021-04-16T09:46:20.954863Z",
    "updated_at": "2021-04-16T10:24:55.962200Z",
    "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
    "enable_recording": true,
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_timeout_secs": 25,
    "webhook_event_url": "https://www.example.com",
    "sessions": [
      {
        "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
        "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
        "active": true,
        "created_at": "2021-04-16T09:46:20.954863Z",
        "updated_at": "2021-04-16T10:24:55.962200Z",
        "participants": [],
        "record_type": "room_session"
      }
    ],
    "record_type": "room"
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status