Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const roomComposition = await client.roomCompositions.retrieve('5219b3af-87c6-4c08-9b58-5a533d893e21');

console.log(roomComposition.data);

{
  "data": {
    "completed_at": "2022-02-25T05:39:56.377426Z",
    "download_url": null,
    "duration_secs": 84,
    "ended_at": "2022-02-24T23:22:24.577677Z",
    "format": "mp4",
    "id": "7103dc53-ee59-4b54-a58b-c77d99ceb037",
    "record_type": "composition",
    "resolution": "1280x720",
    "room_id": "f981dbb3-228a-44e9-ac54-e87f0e2658b0",
    "session_id": "8f728d7b-00e2-4c59-8c27-f564b828df87",
    "size_mb": 6,
    "started_at": "2022-02-24T23:21:00.077209Z",
    "status": "enqueued",
    "user_id": "12a04ec9-0f91-4a91-9f3a-a19d9931182e",
    "video_layout": {
      "first": {
        "height": 720,
        "video_sources": [
          "*"
        ],
        "width": 1280,
        "x_pos": 0,
        "y_pos": 0,
        "z_pos": 0
      }
    },
    "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
  }
}

GET

/

room_compositions

/

{room_composition_id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const roomComposition = await client.roomCompositions.retrieve('5219b3af-87c6-4c08-9b58-5a533d893e21');

console.log(roomComposition.data);

{
  "data": {
    "completed_at": "2022-02-25T05:39:56.377426Z",
    "download_url": null,
    "duration_secs": 84,
    "ended_at": "2022-02-24T23:22:24.577677Z",
    "format": "mp4",
    "id": "7103dc53-ee59-4b54-a58b-c77d99ceb037",
    "record_type": "composition",
    "resolution": "1280x720",
    "room_id": "f981dbb3-228a-44e9-ac54-e87f0e2658b0",
    "session_id": "8f728d7b-00e2-4c59-8c27-f564b828df87",
    "size_mb": 6,
    "started_at": "2022-02-24T23:21:00.077209Z",
    "status": "enqueued",
    "user_id": "12a04ec9-0f91-4a91-9f3a-a19d9931182e",
    "video_layout": {
      "first": {
        "height": 720,
        "video_sources": [
          "*"
        ],
        "width": 1280,
        "x_pos": 0,
        "y_pos": 0,
        "z_pos": 0
      }
    },
    "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

room_composition_id

string<uuid>

required

The unique identifier of a room composition.

Example:

"5219b3af-87c6-4c08-9b58-5a533d893e21"

Response

Get room composition response.

data

object

Show child attributes

data.id

string<uuid>

A unique identifier for the room composition.

Example:

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

data.room_id

string<uuid>

Identify the room associated with the room composition.

Example:

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

data.session_id

string<uuid>

Identify the room session associated with the room composition.

Example:

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

data.user_id

string<uuid>

Identify the user associated with the room composition.

Example:

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

data.status

enum<string>

Shows the room composition status.

Available options:

completed,

enqueued,

processing

Example:

"completed"

data.size_mb

number<float>

Shows the room composition size in MB.

Example:

10.5

data.download_url

string

Url to download the composition.

Example:

"https://www.example.com"

data.duration_secs

integer

Shows the room composition duration in seconds.

Example:

67

data.format

enum<string>

Shows format of the room composition.

Available options:

mp4

Example:

"mp4"

data.created_at

string<date-time>

ISO 8601 timestamp when the room composition was created.

Example:

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

data.updated_at

string<date-time>

ISO 8601 timestamp when the room composition was updated.

Example:

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

data.ended_at

string<date-time>

ISO 8601 timestamp when the room composition has ended.

Example:

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

data.started_at

string<date-time>

ISO 8601 timestamp when the room composition has stated.

Example:

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

data.completed_at

string<date-time>

ISO 8601 timestamp when the room composition has completed.

Example:

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

data.video_layout

object

Describes the video layout of the room composition in terms of regions. Limited to 2 regions.

Show child attributes

data.video_layout.{key}

object

Show child attributes

data.video_layout.{key}.x_pos

integer | null

default:0

X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.

Example:

100

data.video_layout.{key}.y_pos

integer | null

default:0

Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.

Example:

100

data.video_layout.{key}.z_pos

integer | null

default:0

Regions with higher z_pos values are stacked on top of regions with lower z_pos values

Required range: -99 <= x <= 99

Example:

1

data.video_layout.{key}.height

integer | null

Height of the video region

Required range: x >= 16

Example:

360

data.video_layout.{key}.width

integer | null

Width of the video region

Required range: x >= 16

Example:

480

data.video_layout.{key}.max_columns

integer | null

Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources.

Required range: 1 <= x <= 1000

Example:

3

data.video_layout.{key}.max_rows

integer | null

Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources.

Required range: 1 <= x <= 1000

Example:

3

data.video_layout.{key}.video_sources

string<uuid>[]

Array of video recording ids to be composed in the region. Can be "*" to specify all video recordings in the session

data.webhook_event_url

string<uri>

The URL where webhooks related to this room composition 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 composition 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_composition"

Example:

{
  "completed_at": "2022-02-25T05:39:56.377426Z",
  "download_url": null,
  "duration_secs": 84,
  "ended_at": "2022-02-24T23:22:24.577677Z",
  "format": "mp4",
  "id": "7103dc53-ee59-4b54-a58b-c77d99ceb037",
  "record_type": "composition",
  "resolution": "1280x720",
  "room_id": "f981dbb3-228a-44e9-ac54-e87f0e2658b0",
  "session_id": "8f728d7b-00e2-4c59-8c27-f564b828df87",
  "size_mb": 6,
  "started_at": "2022-02-24T23:21:00.077209Z",
  "status": "enqueued",
  "user_id": "12a04ec9-0f91-4a91-9f3a-a19d9931182e",
  "video_layout": {
    "first": {
      "height": 720,
      "video_sources": ["*"],
      "width": 1280,
      "x_pos": 0,
      "y_pos": 0,
      "z_pos": 0
    }
  },
  "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
}

Create a room composition.Delete a room composition.

⌘I