Path parameters

• RoomSid string Required

  The SID of the room with the RoomRecording resources to read.

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

Query parameters

• Status string

  Read only the recordings with 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.

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

• DateCreatedAfter string(date-time)

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

• DateCreatedBefore string(date-time)

  Read only Recordings that started before this ISO 8601 datetime with time zone.

• PageSize integer(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • recordings array[object]
    Hide recordings attributes Show recordings attributes object

    • account_sid string | null

      The SID of the Account that created the RoomRecording resource.

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

    • status string

      The status of the recording. Can be: processing, completed, or deleted. processing indicates the Recording is still being captured. completed indicates the Recording has been captured and is now available for download. deleted means the recording media has been deleted from the system, but its metadata is still available for historical purposes.

      Values are processing, completed, deleted, or failed.

    • date_created string(date-time) | null

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

    • sid string | null

      The unique string that we created to identify the RoomRecording resource.

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

    • source_sid string | null

      The SID of the recording source. For a Room Recording, this value is a track_sid.

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

    • size integer(int64) | null

      The size of the recorded track in bytes.

    • url string(uri) | null

      The absolute URL of the resource.

    • type string

      The recording's media type. Can be: audio or video.

      Values are audio, video, or data.

    • duration integer | null

      The duration of the recording rounded to the nearest second. Sub-second duration tracks have a duration of 1 second

    • container_format string

      Values are mka or mkv.

    • codec string

      The codec used for the recording. Can be: VP8 or H264.

      Values are VP8, H264, OPUS, or PCMU.

    • grouping_sids object | null

      A list of SIDs related to the Recording. Includes the room_sid and participant_sid.

    • track_name string | null

      The name that was given to the source track of the recording. If no name is given, the source_sid is used.

    • offset integer(int64) | null

      The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room.

    • media_external_location string(uri) | null

      The URL of the media file associated with the recording when stored externally. See External S3 Recordings for more details.

    • room_sid string | null

      The SID of the Room resource the recording is associated with.

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

    • links object(uri-map) | null

      The URLs of related resources.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)