Skip to main content

View a list of room participants.

GET 
/room_participants

Request ​

Query Parameters

    filter[date_joined_at][eq] date

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

    filter[date_joined_at][gte] date

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

    filter[date_joined_at][lte] date

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

    filter[date_updated_at][eq] date

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

    filter[date_updated_at][gte] date

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

    filter[date_updated_at][lte] date

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

    filter[date_left_at][eq] date

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

    filter[date_left_at][gte] date

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

    filter[date_left_at][lte] date

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

    filter[context] string

    Filter room participants based on the context.

    filter[session_id] string

    Session_id for filtering room participants.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

Responses ​

200: List room participants response.

Schema

    data

    object[]

  • Array [

    • id uuid

    A unique identifier for the room participant.

    session_id uuid

    Identify the room session that participant is part of.

    context string

    Context provided to the given participant through the client SDK

    joined_at datetime

    ISO 8601 timestamp when the participant joined the session.

    updated_at datetime

    ISO 8601 timestamp when the participant was updated.

    left_at datetime

    ISO 8601 timestamp when the participant left the session.

    record_type string

  • ]

    • meta

    object

    page_number integer
    page_size integer
    total_pages integer
    total_results integer

Request samples

curl -L 'https://api.telnyx.com/v2/room_participants' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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
  }
}