Telnyx

JavaScript

import Telnyx from 'telnyx';

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

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

console.log(room.data);

{
  "data": {
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "max_participants": 50,
    "unique_name": "My Room",
    "created_at": "2021-04-16T09:46:20.954863Z",
    "updated_at": "2021-04-16T10:24:55.962200Z",
    "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
    "enable_recording": true,
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_timeout_secs": 25,
    "webhook_event_url": "https://www.example.com",
    "sessions": [
      {
        "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
        "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
        "active": true,
        "created_at": "2021-04-16T09:46:20.954863Z",
        "updated_at": "2021-04-16T10:24:55.962200Z",
        "participants": [],
        "record_type": "room_session"
      }
    ],
    "record_type": "room"
  }
}

GET

rooms

{room_id}

JavaScript

import Telnyx from 'telnyx';

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

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

console.log(room.data);

{
  "data": {
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "max_participants": 50,
    "unique_name": "My Room",
    "created_at": "2021-04-16T09:46:20.954863Z",
    "updated_at": "2021-04-16T10:24:55.962200Z",
    "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
    "enable_recording": true,
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_timeout_secs": 25,
    "webhook_event_url": "https://www.example.com",
    "sessions": [
      {
        "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
        "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
        "active": true,
        "created_at": "2021-04-16T09:46:20.954863Z",
        "updated_at": "2021-04-16T10:24:55.962200Z",
        "participants": [],
        "record_type": "room_session"
      }
    ],
    "record_type": "room"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

room_id

string<uuid>

required

The unique identifier of a room.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

Query Parameters

include_sessions

boolean

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

Example:

true

Response

Get room response.

data

object

Show child attributes

data.id

string<uuid>

A unique identifier for the room.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.max_participants

integer

Maximum participants allowed in the room.

Example:

50

data.unique_name

string

The unique (within the Telnyx account scope) name of the room.

Example:

"My room"

data.created_at

string<date-time>

ISO 8601 timestamp when the room was created.

Example:

"2021-03-26T17:51:59.588408Z"

data.updated_at

string<date-time>

ISO 8601 timestamp when the room was updated.

Example:

"2021-03-26T17:51:59.588408Z"

data.active_session_id

string<uuid>

The identifier of the active room session if any.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.sessions

object[]

Show child attributes

data.sessions.id

string<uuid>

A unique identifier for the room session.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.sessions.room_id

string<uuid>

Identify the room hosting that room session.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777b0"

data.sessions.active

boolean

Shows if the room session is active or not.

Example:

false

data.sessions.created_at

string<date-time>

ISO 8601 timestamp when the room session was created.

Example:

"2021-03-26T17:51:59.588408Z"

data.sessions.updated_at

string<date-time>

ISO 8601 timestamp when the room session was updated.

Example:

"2021-03-26T17:51:59.588408Z"

data.sessions.ended_at

string<date-time>

ISO 8601 timestamp when the room session has ended.

Example:

"2021-03-26T17:51:59.588408Z"

data.sessions.participants

object[]

Show child attributes

data.sessions.participants.id

string<uuid>

A unique identifier for the room participant.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.sessions.participants.session_id

string<uuid>

Identify the room session that participant is part of.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777b0"

data.sessions.participants.context

string

Context provided to the given participant through the client SDK

Example:

"Alice"

data.sessions.participants.joined_at

string<date-time>

ISO 8601 timestamp when the participant joined the session.

Example:

"2021-03-26T17:51:59.588408Z"

data.sessions.participants.updated_at

string<date-time>

ISO 8601 timestamp when the participant was updated.

Example:

"2021-03-26T17:51:59.588408Z"

data.sessions.participants.left_at

string<date-time>

ISO 8601 timestamp when the participant left the session.

Example:

"2021-03-26T17:51:59.588408Z"

data.sessions.participants.record_type

string

Example:

"room_participant"

data.sessions.record_type

string

Example:

"room_session"

data.enable_recording

boolean

default:false

Enable or disable recording for that room.

Example:

true

data.webhook_event_url

string<uri>

The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

data.webhook_event_failover_url

string<uri> | null

default:""

The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

data.webhook_timeout_secs

integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30

Example:

25

data.record_type

string

Example:

"room"

Example:

{
  "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
  "max_participants": 50,
  "unique_name": "My Room",
  "created_at": "2021-04-16T09:46:20.954863Z",
  "updated_at": "2021-04-16T10:24:55.962200Z",
  "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
  "enable_recording": true,
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_timeout_secs": 25,
  "webhook_event_url": "https://www.example.com",
  "sessions": [
    {
      "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
      "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      "active": true,
      "created_at": "2021-04-16T09:46:20.954863Z",
      "updated_at": "2021-04-16T10:24:55.962200Z",
      "participants": [],
      "record_type": "room_session"
    }
  ],
  "record_type": "room"
}

Create a room.Delete a room.

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

View a room.

Authorizations

Path Parameters

Query Parameters

Response