Sign in
Rooms

Create a room.

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

post/rooms

Request body

enable_recordingboolean

Enable or disable recording for that 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.

unique_namestring

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

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_event_urlstring uri

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

webhook_timeout_secsinteger

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

Example request

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

Response

Create room response.

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.2

  • 1571b0380bd71See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379941See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog