View a list of room participants.

gethttps://api.telnyx.com/v2/room_participants

View a list of room participants.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/room_participants?filter[date_joined_at][eq]=2021-04-25&filter[date_joined_at][gte]=2021-04-25"

Parameters

In Query
filter[date_joined_at][eq]
string
(date)
optional
ISO 8601 date for filtering room participants that joined on that date.
Example: "2021-04-25"
filter[date_joined_at][gte]
string
(date)
optional
ISO 8601 date for filtering room participants that joined after that date.
Example: "2021-04-25"
filter[date_joined_at][lte]
string
(date)
optional
ISO 8601 date for filtering room participants that joined before that date.
Example: "2021-04-25"
filter[date_updated_at][eq]
string
(date)
optional
ISO 8601 date for filtering room participants updated on that date.
Example: "2021-04-25"
filter[date_updated_at][gte]
string
(date)
optional
ISO 8601 date for filtering room participants updated after that date.
Example: "2021-04-25"
filter[date_updated_at][lte]
string
(date)
optional
ISO 8601 date for filtering room participants updated before that date.
Example: "2021-04-25"
filter[date_left_at][eq]
string
(date)
optional
ISO 8601 date for filtering room participants that left on that date.
Example: "2021-04-25"
filter[date_left_at][gte]
string
(date)
optional
ISO 8601 date for filtering room participants that left after that date.
Example: "2021-04-25"
filter[date_left_at][lte]
string
(date)
optional
ISO 8601 date for filtering room participants that left before that date.
Example: "2021-04-25"
filter[context]
string
optional
Filter room participants based on the context.
Example: "Alice"
filter[session_id]
string
optional
Session_id for filtering room participants.
Example: "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20
page[number]
integer
(1)
optional
The page number to load
Default:
1

Responses

200
List room participants response.

Success Response

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

...

gethttps://api.telnyx.com/v2/room_participants/{room_participant_id}

...

...

Parameters

Responses

Success Response

Was this page helpful?