List of all Recording compositions

GET /v1/Compositions

Recording compositions

List of all Recording compositions.

Query parameters

  • Status string

    Read only Composition resources with this status. Can be: enqueued, processing, completed, deleted, or failed.

    Values are enqueued, processing, completed, deleted, or failed.

  • DateCreatedAfter string(date-time)

    Read only Composition resources created on or after this ISO 8601 date-time with time zone.

  • DateCreatedBefore string(date-time)

    Read only Composition resources created before this ISO 8601 date-time with time zone.

  • RoomSid string

    Read only Composition resources with this Room SID.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • compositions array[object]
      Hide compositions attributes Show compositions attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • audio_sources array[string] | null

        The array of track names to include in the composition

      • audio_sources_excluded array[string] | null

        The array of track names to exclude from the composition

      • bitrate integer | null

        The average bit rate of the composition's media

      • date_completed string(date-time) | null

        Date when the media processing task finished

      • date_created string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was created

      • date_deleted string(date-time) | null

        The ISO 8601 date and time in GMT when the composition generated media was deleted

      • duration integer | null

        The duration of the composition's media file in seconds

      • format string | null

        The container format of the composition's media files as specified in the POST request that created the Composition resource

        Values are mp4 or webm.

      • links object(uri-map) | null

        The URL of the media file associated with the composition

      • media_external_location string(uri) | null

        The URL of the media file associated with the composition when stored externally

      • resolution string | null

        The dimensions of the video image in pixels expressed as columns (width) and rows (height)

      • room_sid string | null

        The SID of the Group Room that generated the audio and video tracks used in the composition

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RM[0-9a-fA-F]{32}$.

      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CJ[0-9a-fA-F]{32}$.

      • size integer | null

        The size of the composed media file in bytes

      • status string | null

        The status of the composition

        Values are enqueued, processing, completed, deleted, or failed.

      • status_callback string(uri) | null

        The URL called to send status information on every composition event.

      • status_callback_method string(http-method) | null

        The HTTP method used to call status_callback

        Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

      • trim boolean | null

        Whether to remove intervals with no media

      • url string(uri) | null

        The absolute URL of the resource

      • video_layout

        An object that describes the video layout of the composition

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Compositions 
curl \
 -X GET https://video.twilio.com/v1/Compositions \
 --user "username:password"
Response examples (200) 
{
  "compositions": [
    {
      "account_sid": "string",
      "audio_sources": [
        "string"
      ],
      "audio_sources_excluded": [
        "string"
      ],
      "bitrate": 42,
      "date_completed": "2023-05-04T09:42:00+00:00",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_deleted": "2023-05-04T09:42:00+00:00",
      "duration": 42,
      "format": "mp4",
      "links": {},
      "media_external_location": "https://example.com",
      "resolution": "string",
      "room_sid": "string",
      "sid": "string",
      "size": 42,
      "status": "enqueued",
      "status_callback": "https://example.com",
      "status_callback_method": "HEAD",
      "trim": true,
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}