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 conferenceListParticipantsResponse of client.conferences.listParticipants('conference_id')) {
  console.log(conferenceListParticipantsResponse.id);
}

{
  "data": [
    {
      "record_type": "participant",
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "end_conference_on_exit": true,
      "soft_end_conference_on_exit": true,
      "status": "joining",
      "muted": false,
      "on_hold": true,
      "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
      "whisper_call_control_ids": [
        "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
        "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
      ],
      "id": "dfadada7-af74-47bc-83a4-554275f55f5c",
      "call_leg_id": "3a15df2d-c801-4729-adf5-b56dd42e2abb",
      "conference": {
        "id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46",
        "name": "1"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

conferences

{conference_id}

participants

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 conferenceListParticipantsResponse of client.conferences.listParticipants('conference_id')) {
  console.log(conferenceListParticipantsResponse.id);
}

{
  "data": [
    {
      "record_type": "participant",
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "end_conference_on_exit": true,
      "soft_end_conference_on_exit": true,
      "status": "joining",
      "muted": false,
      "on_hold": true,
      "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
      "whisper_call_control_ids": [
        "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
        "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
      ],
      "id": "dfadada7-af74-47bc-83a4-554275f55f5c",
      "call_leg_id": "3a15df2d-c801-4729-adf5-b56dd42e2abb",
      "conference": {
        "id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46",
        "name": "1"
      }
    }
  ],
  "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.

Path Parameters

conference_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

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

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[muted], filter[on_hold], filter[whispering]

Show child attributes

filter[muted]

boolean

If present, participants will be filtered to those who are/are not muted

filter[on_hold]

boolean

If present, participants will be filtered to those who are/are not put on hold

filter[whispering]

boolean

If present, participants will be filtered to those who are whispering or are not

Response

Successful response with a list of conference participants.

data

Participant · object[]

Show child attributes

data.record_type

enum<string>

required

Available options:

participant

Example:

"participant"

data.id

string

required

Uniquely identifies the participant

Example:

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

data.call_leg_id

string

required

Uniquely identifies the call leg associated with the participant

Example:

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

data.call_control_id

string

required

Call Control ID associated with the partiipant of the conference

Example:

"v2:v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ"

data.conference

object

required

Info about the conference that the participant is in

Show child attributes

data.conference.id

string

Uniquely identifies the conference

Example:

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

data.conference.name

string

Name of the conference

Example:

"All hands meeting"

data.whisper_call_control_ids

string[]

required

Array of unique call_control_ids the participant can whisper to..

Example:

[
  "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
  "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
]

data.created_at

string

required

ISO 8601 formatted date of when the participant was created

Example:

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

data.updated_at

string

required

ISO 8601 formatted date of when the participant was last updated

Example:

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

data.end_conference_on_exit

boolean

required

Whether the conference will end and all remaining participants be hung up after the participant leaves the conference.

Example:

true

data.soft_end_conference_on_exit

boolean

required

Whether the conference will end after the participant leaves the conference.

Example:

true

data.status

enum<string>

required

The status of the participant with respect to the lifecycle within the conference

Available options:

joining,

joined,

left

Example:

"joining"

data.muted

boolean

required

Whether the participant is muted.

Example:

true

data.on_hold

boolean

required

Whether the participant is put on_hold.

Example:

true

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List conference participants

Authorizations

Path Parameters

Query Parameters

Response