Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const response = await client.rooms.sessions.retrieveParticipants('0ccc7b54-4df3-4bca-a65a-3da1ecc777f0'); console.log(response.data);

{ "data": [ { "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73", "context": "Alice", "joined_at": "2021-04-16T09:46:20.954863Z", "updated_at": "2021-04-16T10:24:55.962200Z", "left_at": "2021-04-16T10:24:55.962200Z", "record_type": "room_participant" } ], "meta": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

Authorizations

Authorization

string

header

required

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

Path Parameters

room_session_id

string<uuid>

required

The unique identifier of a room session.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[date_joined_at][eq], filter[date_joined_at][gte], filter[date_joined_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_left_at][eq], filter[date_left_at][gte], filter[date_left_at][lte], filter[context]

Show child attributes

filter[date_joined_at]

object

Show child attributes

filter[date_joined_at][eq]

string<date>

ISO 8601 date for filtering room participants that joined on that date.

Example:

"2021-04-25"

filter[date_joined_at][gte]

string<date>

ISO 8601 date for filtering room participants that joined on or after that date.

Example:

"2021-04-25"

filter[date_joined_at][lte]

string<date>

ISO 8601 date for filtering room participants that joined on or before that date.

Example:

"2021-04-25"

filter[date_updated_at]

object

Show child attributes

filter[date_updated_at][eq]

string<date>

ISO 8601 date for filtering room participants updated on that date.

Example:

"2021-04-25"

filter[date_updated_at][gte]

string<date>

ISO 8601 date for filtering room participants updated on or after that date.

Example:

"2021-04-25"

filter[date_updated_at][lte]

string<date>

ISO 8601 date for filtering room participants updated on or before that date.

Example:

"2021-04-25"

filter[date_left_at]

object

Show child attributes

filter[date_left_at][eq]

string<date>

ISO 8601 date for filtering room participants that left on that date.

Example:

"2021-04-25"

filter[date_left_at][gte]

string<date>

ISO 8601 date for filtering room participants that left on or after that date.

Example:

"2021-04-25"

filter[date_left_at][lte]

string<date>

ISO 8601 date for filtering room participants that left on or before that date.

Example:

"2021-04-25"

filter[context]

string

Filter room participants based on the context.

Example:

"Alice"

page

object

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

Show child attributes

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

200 - application/json

List room participants response.

data

object[]

Show child attributes

data.id

string<uuid>

A unique identifier for the room participant.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.session_id

string<uuid>

Identify the room session that participant is part of.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777b0"

data.context

string

Context provided to the given participant through the client SDK

Example:

"Alice"

data.joined_at

string<date-time>

ISO 8601 timestamp when the participant joined the session.

Example:

"2021-03-26T17:51:59.588408Z"

data.updated_at

string<date-time>

ISO 8601 timestamp when the participant was updated.

Example:

"2021-03-26T17:51:59.588408Z"

data.left_at

string<date-time>

ISO 8601 timestamp when the participant left the session.

Example:

"2021-03-26T17:51:59.588408Z"

data.record_type

string

Example:

"room_participant"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup