Skip to main content
GET
/
texml
/
Accounts
/
{account_sid}
/
Conferences
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

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[]
​
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"