Telnyx

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const conference of client.conferences.list()) {
  console.log(conference.id);
}

{
  "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": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

conferences

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const conference of client.conferences.list()) {
  console.log(conference.id);
}

{
  "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": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

region

enum<string>

Region where the conference data is located

Available options:

Australia,

Europe,

Middle East,

US

filter

object

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

filter[application_name]

object

Application name filters

Show child attributes

filter[application_name][contains]

string

default:null

If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[outbound.outbound_voice_profile_id]

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

filter[leg_id]

string<uuid>

The unique identifier of an individual call leg.

filter[application_session_id]

string<uuid>

The unique identifier of the call session. A session may include multiple call leg events.

filter[connection_id]

string

The unique identifier of the conection.

filter[product]

enum<string>

Filter by product.

Available options:

call_control,

fax,

texml

Example:

"texml"

filter[failed]

boolean

Delivery failed or not.

Example:

false

filter[from]

string

Filter by From number.

Example:

"+12025550142"

filter[to]

string

Filter by To number.

Example:

"+12025550142"

filter[name]

string

If present, conferences will be filtered to those with a matching name attribute. Matching is case-sensitive

filter[type]

enum<string>

Event type

Available options:

command,

webhook

Example:

"webhook"

filter[occurred_at]

object

Event occurred_at filters

Show child attributes

filter[occurred_at][eq]

string

Event occurred_at: equal

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][gt]

string

Event occurred_at: greater than

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][gte]

string

Event occurred_at: greater than or equal

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][lt]

string

Event occurred_at: lower than

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][lte]

string

Event occurred_at: lower than or equal

Example:

"2019-03-29T11:10:00Z"

filter[status]

enum<string>

If present, conferences will be filtered by status.

Available options:

init,

in_progress,

completed

page

object

Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]

Show child attributes

page[after]

string

default:null

Opaque identifier of next page

page[before]

string

default:null

Opaque identifier of previous page

page[limit]

integer

default:20

Limit of records per single page

Required range: 1 <= x <= 250

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

Response

Successful response with a list of conferences.

data

Conference · object[]

Show child attributes

data.record_type

enum<string>

required

Available options:

conference

Example:

"conference"

data.id

string

required

Uniquely identifies the conference

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

data.name

string

required

Name of the conference

Example:

"All hands meeting"

data.created_at

string

required

ISO 8601 formatted date of when the conference was created

Example:

"2019-01-23T18:10:02.574Z"

data.expires_at

string

required

ISO 8601 formatted date of when the conference will expire

Example:

"2019-01-23T18:10:02.574Z"

data.updated_at

string

ISO 8601 formatted date of when the conference was last updated

Example:

"2019-01-23T18:10:02.574Z"

data.region

string

Region where the conference is hosted

Example:

"sv1"

data.status

enum<string>

Status of the conference

Available options:

init,

in_progress,

completed

Example:

"completed"

data.end_reason

enum<string>

Reason why the conference ended

Available options:

all_left,

ended_via_api,

host_left,

time_exceeded

Example:

"all_left"

data.ended_by

object

IDs related to who ended the conference. It is expected for them to all be there or all be null

Show child attributes

data.ended_by.call_control_id

string

Call Control ID which ended the conference

Example:

"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ=="

data.ended_by.call_session_id

string

Call Session ID which ended the conference

Example:

"428c31b6-abf3-3bc1-b7f4-5013ef9657c1"

data.connection_id

string

Identifies the connection associated with the conference

Example:

"3fa85f64-9191-4567-b3fc-2c963f66afa6"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List conferences

Authorizations

Query Parameters

Response