Get a list of Programmable Video Rooms
TODO: Resource-level docs
Get a list of Programmable Video Rooms.
Query parameters
-
RoomType array[string]
Type of room. Can be
go
,peer_to_peer
,group
, orgroup_small
. -
Codec array[string]
Codecs used by participants in the room. Can be
VP8
,H264
, orVP9
. -
RoomName string
Room friendly name.
-
CreatedAfter string(date-time)
Only read rooms that started on or after this ISO 8601 timestamp.
-
CreatedBefore string(date-time)
Only read rooms that started before this ISO 8601 timestamp.
-
PageSize integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum value is
1
, maximum value is1000
.
GET /v1/Video/Rooms
curl \
-X GET https://insights.twilio.com/v1/Video/Rooms \
--user "username:password"
Response examples (200)
{
"meta": {
"first_page_url": "https://example.com",
"key": "string",
"next_page_url": "https://example.com",
"page": 42,
"page_size": 42,
"previous_page_url": "https://example.com",
"url": "https://example.com"
},
"rooms": [
{
"account_sid": "string",
"codecs": [
"VP8"
],
"concurrent_participants": 42,
"create_time": "2023-05-04T09:42:00+00:00",
"created_method": "sdk",
"duration_sec": 42,
"edge_location": "ashburn",
"end_reason": "room_ended_via_api",
"end_time": "2023-05-04T09:42:00+00:00",
"links": {},
"max_concurrent_participants": 42,
"max_participants": 42,
"media_region": "us1",
"processing_state": "complete",
"recording_enabled": true,
"room_name": "string",
"room_sid": "string",
"room_status": "in_progress",
"room_type": "go",
"status_callback": "https://example.com",
"status_callback_method": "HEAD",
"total_participant_duration_sec": 42,
"total_recording_duration_sec": 42,
"unique_participant_identities": 42,
"unique_participants": 42,
"url": "https://example.com"
}
]
}
Response examples (200)
{
"meta": {
"first_page_url": "https://example.com",
"key": "string",
"next_page_url": "https://example.com",
"page": 42,
"page_size": 42,
"previous_page_url": "https://example.com",
"url": "https://example.com"
},
"rooms": [
{
"account_sid": "string",
"codecs": [
"VP8"
],
"concurrent_participants": 42,
"create_time": "2024-05-04T09:42:00+00:00",
"created_method": "sdk",
"duration_sec": 42,
"edge_location": "ashburn",
"end_reason": "room_ended_via_api",
"end_time": "2024-05-04T09:42:00+00:00",
"links": {},
"max_concurrent_participants": 42,
"max_participants": 42,
"media_region": "us1",
"processing_state": "complete",
"recording_enabled": true,
"room_name": "string",
"room_sid": "string",
"room_status": "in_progress",
"room_type": "go",
"status_callback": "https://example.com",
"status_callback_method": "HEAD",
"total_participant_duration_sec": 42,
"total_recording_duration_sec": 42,
"unique_participant_identities": 42,
"unique_participants": 42,
"url": "https://example.com"
}
]
}