Telnyx

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.texml.accounts.conferences.retrieveConferences('account_sid');

console.log(response.conferences);

{
  "conferences": [],
  "end": 0,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
  "page": 0,
  "page_size": 1,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1"
}

GET

texml

Accounts

{account_sid}

Conferences

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.texml.accounts.conferences.retrieveConferences('account_sid');

console.log(response.conferences);

{
  "conferences": [],
  "end": 0,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
  "page": 0,
  "page_size": 1,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

account_sid

string

required

The id of the account the resource belongs to.

Query Parameters

Page

integer

The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.

PageSize

integer

The number of records to be displayed on a page

PageToken

string

Used to request the next page of results.

FriendlyName

string

Filters conferences by their friendly name.

Status

enum<string>

Filters conferences by status.

Available options:

init,

in-progress,

completed

DateCreated

string

Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22.

DateUpdated

string

Filters conferences by the time they were last updated. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateUpdated>=2023-05-22.

Response

Multiple conference resources.

conferences

Conference resource · object[]

Show child attributes

conferences.account_sid

string

The id of the account the resource belongs to.

Example:

"61bf923e-5e4d-4595-a110-56190ea18a1b"

conferences.api_version

string

The version of the API that was used to make the request.

Example:

"v2/texml"

conferences.call_sid_ending_conference

string

Caller ID, if present.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

conferences.date_created

string

The timestamp of when the resource was created.

Example:

"Thu, 15 Jun 2023 09:56:45 +0000"

conferences.date_updated

string

The timestamp of when the resource was last updated.

Example:

"Thu, 15 Jun 2023 09:56:45 +0000"

conferences.friendly_name

string

A string that you assigned to describe this conference room.

Example:

"weekly_review_call"

conferences.reason_conference_ended

enum<string>

The reason why a conference ended. When a conference is in progress, will be null.

Available options:

participant-with-end-conference-on-exit-left,

last-participant-left,

conference-ended-via-api,

time-exceeded

Example:

"time-exceeded"

conferences.region

string

A string representing the region where the conference is hosted.

Example:

"dc2"

conferences.sid

string

The unique identifier of the conference.

Example:

"cd5a70f4-759b-4d5e-9c06-88c00f16f3c1"

conferences.status

enum<string>

The status of this conference.

Available options:

init,

in-progress,

completed

Example:

"in-progress"

conferences.subresource_uris

object

A list of related resources identified by their relative URIs.

Example:

{
  "participants": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json",
  "recordings": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json"
}

conferences.uri

string

The relative URI for this conference.

Example:

"/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json"

end

integer

The number of the last element on the page, zero-indexed.

Example:

19

first_page_uri

string

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1

Example:

"accepted"

next_page_uri

string

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ

Example:

"accepted"

page

integer

Current page number, zero-indexed.

Example:

0

page_size

integer

The number of items on the page

Example:

20

start

integer

The number of the first element on the page, zero-indexed.

Example:

0

uri

string

The URI of the current page.

Example:

"/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1"

Update streaming on a call Fetch a conference resource

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List conference resources

Authorizations

Path Parameters

Query Parameters

Response