View a list of room compositions.

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

View a list of room compositions.

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_compositions?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 compositions created on that date.
Example: "2021-04-25"
filter[date_created_at][gte]
string
(date)
optional
ISO 8601 date for filtering room compositions created after that date.
Example: "2021-04-25"
filter[date_created_at][lte]
string
(date)
optional
ISO 8601 date for filtering room compositions created before that date.
Example: "2021-04-25"
filter[session_id]
string
(uuid)
optional
The session_id for filtering room compositions.
Example: "92e7d459-bcc5-4386-9f5f-6dd14a82588d"
filter[status]
string
optional
The status for filtering room compositions.
Example: "completed"Options: [ "completed", "processing", "enqueued" ]
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 compositions response.

Success Response

{
  "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"
  },
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/room_compositions

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/room_compositions/{room_composition_id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/room_compositions/{room_composition_id}

...

...

Parameters

Responses

Success Response

Was this page helpful?