View a room session.

GET /room_sessions/{room_session_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const session = await client.rooms.sessions.retrieve('0ccc7b54-4df3-4bca-a65a-3da1ecc777f0');

console.log(session.data);

200

{
  "data": {
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
    "active": false,
    "created_at": "2021-04-16T09:46:20.954863Z",
    "updated_at": "2021-04-16T10:24:55.962200Z",
    "ended_at": "2021-04-16T10:24:55.962200Z",
    "participants": [],
    "record_type": "room_session"
  }
}

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

include_participants · boolean

To decide if room participants should be included in the response.

Example:

true

Response

200

application/json

Get room session response.

data · object

Show child attributes

Example:

{
  "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
  "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
  "active": false,
  "created_at": "2021-04-16T09:46:20.954863Z",
  "updated_at": "2021-04-16T10:24:55.962200Z",
  "ended_at": "2021-04-16T10:24:55.962200Z",
  "participants": [],
  "record_type": "room_session"
}