Skip to main content
GET
/
room_participants
JavaScript
import Telnyx from 'telnyx';

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

const roomParticipants = await client.roomParticipants.list();

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

Authorizations

Authorization
string
header
required

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

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], filter[session_id]

page
object

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

Response

200 - application/json

List room participants response.

data
object[]
meta
object