Retrieve a conference

Retrieve an existing conference

GET /conferences/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const conference = await client.conferences.retrieve('id');

console.log(conference.data);

200

Example

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Uniquely identifies the conference by id

Query Parameters

region · enum<string>

Region where the conference data is located

Available options: Australia, Europe, Middle East, US

Response

200

application/json

Successful response with details about a conference.

data · Conference · object

Show child attributes

Example:

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