View a list of rooms.
GET/rooms
Request
Query Parameters
ISO 8601 date for filtering rooms created on that date.
ISO 8601 date for filtering rooms created after that date.
ISO 8601 date for filtering rooms created before that date.
ISO 8601 date for filtering rooms updated on that date.
ISO 8601 date for filtering rooms updated after that date.
ISO 8601 date for filtering rooms updated before that date.
Unique_name for filtering rooms.
To decide if room sessions should be included in the response.
Possible values: >= 1
and <= 250
Default value: 20
The size of the page.
Possible values: >= 1
Default value: 1
The page number to load.
Responses
200: List rooms response.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
data
object[]
A unique identifier for the room.
Maximum participants allowed in the room.
The unique (within the Telnyx account scope) name of the room.
ISO 8601 timestamp when the room was created.
ISO 8601 timestamp when the room was updated.
The identifier of the active room session if any.
sessions
object[]
A unique identifier for the room session.
Identify the room hosting that room session.
Shows if the room session is active or not.
ISO 8601 timestamp when the room session was created.
ISO 8601 timestamp when the room session was updated.
ISO 8601 timestamp when the room session has ended.
participants
object[]
A unique identifier for the room participant.
Identify the room session that participant is part of.
Context provided to the given participant through the client SDK
ISO 8601 timestamp when the participant joined the session.
ISO 8601 timestamp when the participant was updated.
ISO 8601 timestamp when the participant left the session.
Default value: false
Enable or disable recording for that room.
The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.
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'.
Possible values: <= 30
Specifies how many seconds to wait before timing out a webhook.
meta
object
{
"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"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}