import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const conferences = await client.conferences.list();
console.log(conferences.data);{
"data": [
{
"record_type": "conference",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "All hands meeting",
"created_at": "2019-01-23T18:10:02.574Z",
"expires_at": "2019-01-23T18:10:02.574Z",
"updated_at": "2019-01-23T18:10:02.574Z",
"region": "sv1",
"status": "completed",
"end_reason": "all_left",
"ended_by": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
"call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
},
"connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by expires_at.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const conferences = await client.conferences.list();
console.log(conferences.data);{
"data": [
{
"record_type": "conference",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "All hands meeting",
"created_at": "2019-01-23T18:10:02.574Z",
"expires_at": "2019-01-23T18:10:02.574Z",
"updated_at": "2019-01-23T18:10:02.574Z",
"region": "sv1",
"status": "completed",
"end_reason": "all_left",
"ended_by": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
"call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
},
"connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Region where the conference data is located
Australia, Europe, Middle East, US Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]
Show child attributes
Application name filters
Show child attributes
If present, applications with <code>application_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Identifies the associated outbound voice profile.
"1293384261075731499"
The unique identifier of an individual call leg.
The unique identifier of the call session. A session may include multiple call leg events.
The unique identifier of the conection.
Filter by product.
call_control, fax, texml "texml"
Delivery failed or not.
false
Filter by From number.
"+12025550142"
Filter by To number.
"+12025550142"
If present, conferences will be filtered to those with a matching name attribute. Matching is case-sensitive
Event type
command, webhook "webhook"
Event occurred_at filters
Show child attributes
Event occurred_at: equal
"2019-03-29T11:10:00Z"
Event occurred_at: greater than
"2019-03-29T11:10:00Z"
Event occurred_at: greater than or equal
"2019-03-29T11:10:00Z"
Event occurred_at: lower than
"2019-03-29T11:10:00Z"
Event occurred_at: lower than or equal
"2019-03-29T11:10:00Z"
If present, conferences will be filtered by status.
init, in_progress, completed Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]
Show child attributes
Opaque identifier of next page
Opaque identifier of previous page
Limit of records per single page
1 <= x <= 250The size of the page
1 <= x <= 250The page number to load
x >= 1Successful response with a list of conferences.
Show child attributes
conference "conference"
Uniquely identifies the conference
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Name of the conference
"All hands meeting"
ISO 8601 formatted date of when the conference was created
"2019-01-23T18:10:02.574Z"
ISO 8601 formatted date of when the conference will expire
"2019-01-23T18:10:02.574Z"
ISO 8601 formatted date of when the conference was last updated
"2019-01-23T18:10:02.574Z"
Region where the conference is hosted
"sv1"
Status of the conference
init, in_progress, completed "completed"
Reason why the conference ended
all_left, ended_via_api, host_left, time_exceeded "all_left"
IDs related to who ended the conference. It is expected for them to all be there or all be null
Show child attributes
Identifies the connection associated with the conference
"3fa85f64-9191-4567-b3fc-2c963f66afa6"
Was this page helpful?