List of all Track recordings

GET /v1/Recordings

Single-track, single-media recordings

List of all Track recordings.

Query parameters

  • Status string

    Read only the recordings that have this status. Can be: processing, completed, or deleted.

    Values are processing, completed, deleted, or failed.

  • SourceSid string

    Read only the recordings that have this source_sid.

  • GroupingSid array[string]

    Read only recordings with this grouping_sid, which may include a participant_sid and/or a room_sid.

  • DateCreatedAfter string(date-time)

    Read only recordings that started on or after this ISO 8601 date-time with time zone.

  • DateCreatedBefore string(date-time)

    Read only recordings that started before this ISO 8601 date-time with time zone, given as YYYY-MM-DDThh:mm:ss+|-hh:mm or YYYY-MM-DDThh:mm:ssZ.

  • MediaType string

    Read only recordings that have this media type. Can be either audio or video.

    Values are audio, video, or data.

  • 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
    • meta object
      Hide meta attributes Show meta attributes
    • recordings array[object]
      Hide recordings attributes Show recordings 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}$.

      • codec string | null

        The codec used to encode the track

        Values are VP8, H264, OPUS, or PCMU.

      • container_format string | null

        The file format for the recording

        Values are mka or mkv.

      • date_created string(date-time) | null

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

      • duration integer | null

        The duration of the recording in seconds

      • grouping_sids

        A list of SIDs related to the recording

      • links object(uri-map) | null

        The URLs of related resources

      • media_external_location string(uri) | null

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

      • offset integer | null

        The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started

      • sid string | null

        The unique string that identifies the resource

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

      • size integer | null

        The size of the recorded track, in bytes

      • source_sid string | null

        The SID of the recording source

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

      • status string | null

        The status of the recording

        Values are processing, completed, deleted, or failed.

      • status_callback string(uri) | null

        The URL called to send status information on every recording 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.

      • track_name string | null

        The name that was given to the source track of the recording

      • type string | null

        The recording's media type

        Values are audio, video, or data.

      • url string(uri) | null

        The absolute URL of the resource
GET /v1/Recordings 
curl \
 -X GET https://video.twilio.com/v1/Recordings \
 --user "username:password"
Response examples (200) 
{
  "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"
  },
  "recordings": [
    {
      "account_sid": "string",
      "codec": "VP8",
      "container_format": "mka",
      "date_created": "2023-05-04T09:42:00+00:00",
      "duration": 42,
      "links": {},
      "media_external_location": "https://example.com",
      "offset": 42,
      "sid": "string",
      "size": 42,
      "source_sid": "string",
      "status": "processing",
      "status_callback": "https://example.com",
      "status_callback_method": "HEAD",
      "track_name": "string",
      "type": "audio",
      "url": "https://example.com"
    }
  ]
}