import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const conference = await client.conferences.retrieve('id');
console.log(conference.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"
}
}Retrieve an existing conference
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const conference = await client.conferences.retrieve('id');
console.log(conference.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"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Uniquely identifies the conference by id
Region where the conference data is located
Australia, Europe, Middle East, US Successful response with details about a conference.
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"
{
"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"
}Was this page helpful?