Skip to main content

Create a room.

POST 
/rooms

Synchronously create a Room.

Request

Body

required

Parameters that can be defined during room creation.

    unique_name string

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

    max_participants integer

    Possible values: >= 2 and <= 50

    Default value: 10

    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_recording boolean

    Enable or disable recording for that room.

    webhook_event_url url

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

    webhook_event_failover_url urlnullable

    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_secs integernullable

    Possible values: <= 30

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

Responses

201: Create room response.

422: Unprocessable entity. Check the 'detail' field in response for details.

Request samples


curl -L 'https://api.telnyx.com/v2/rooms' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"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 samples


{
"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"
}
}