View a list of room sessions.

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

View a list of room sessions.

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_sessions?filter[date_created_at][eq]=2021-04-25&filter[date_created_at][gte]=2021-04-25"

Parameters

In Query
filter[date_created_at][eq]
string
(date)
optional
ISO 8601 date for filtering room sessions created on that date.
Example: "2021-04-25"
filter[date_created_at][gte]
string
(date)
optional
ISO 8601 date for filtering room sessions created after that date.
Example: "2021-04-25"
filter[date_created_at][lte]
string
(date)
optional
ISO 8601 date for filtering room sessions created before that date.
Example: "2021-04-25"
filter[date_updated_at][eq]
string
(date)
optional
ISO 8601 date for filtering room sessions updated on that date.
Example: "2021-04-25"
filter[date_updated_at][gte]
string
(date)
optional
ISO 8601 date for filtering room sessions updated after that date.
Example: "2021-04-25"
filter[date_updated_at][lte]
string
(date)
optional
ISO 8601 date for filtering room sessions updated before that date.
Example: "2021-04-25"
filter[date_ended_at][eq]
string
(date)
optional
ISO 8601 date for filtering room sessions ended on that date.
Example: "2021-04-25"
filter[date_ended_at][gte]
string
(date)
optional
ISO 8601 date for filtering room sessions ended after that date.
Example: "2021-04-25"
filter[date_ended_at][lte]
string
(date)
optional
ISO 8601 date for filtering room sessions ended before that date.
Example: "2021-04-25"
filter[room_id]
string
optional
Room_id for filtering room sessions.
Example: "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
filter[active]
boolean
optional
Filter active or inactive room sessions.
Example: true
include_participants
boolean
optional
To decide if room participants should be included in the response.
Example: true
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 sessions response.

Success Response

{
  "data": {
    "active": false,
    "created_at": "2021-04-16T09:46:20.954863Z",
    "ended_at": "2021-04-16T10:24:55.962200Z",
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "participants": [],
    "record_type": "room_session",
    "room_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_sessions/{room_session_id}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/room_sessions/{room_session_id}/actions/end

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/room_sessions/{room_session_id}/actions/mute

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/room_sessions/{room_session_id}/actions/unmute

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/room_sessions/{room_session_id}/actions/kick

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/room_sessions/{room_session_id}/participants

...

...

Parameters

Responses

Success Response

Next:
Rooms
Was this page helpful?