Skip to main content
POST
/
room_compositions
JavaScript
import Telnyx from 'telnyx';

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

const roomComposition = await client.roomCompositions.create();

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.

Body

application/json

Parameters that can be defined during room composition creation.

​
format
string | null
default:mp4

The desired format of the room composition.

Example:

"mp4"

​
resolution
string | null
default:1280x720

The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720

Example:

"800x600"

​
session_id
string<uuid> | null

id of the room session associated with the room composition.

Example:

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

​
video_layout
object

Describes the video layout of the room composition in terms of regions.

​
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"

​
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"

​
webhook_timeout_secs
integer | null

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

Required range: 0 <= x <= 30
Example:

25

Response

Create room composition response.

​
data
object
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"
}