Skip to main content

Retrieve a Recording.

GET 
/Accounts/:AccountSid/Recordings/:Sid

Retrieve a single recording media or its metadata.

Access to recording files with a direct URL is useful because they are public and do not require Basic Auth. This allows external applications to embed recording URLs without exposing their SignalWire API credentials. SignalWire recording URLs are long and random, making them difficult to guess or exploit unless you reveal the URL.

Retrieve WAV file

When a recording URI has no extension or a .wav extension, the request will return a binary WAV version of the recording file.

GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}

GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.wav

Retrieve MP3 file

Setting an extension of ".mp3" on the URI returns a binary MP3 version of the recording. For example:

GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.mp3

Retrieve Metadata

A recording's metadata, such as duration, cost, time, can be returned by setting the Recording URI's extension to .json. For example:

GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json

Permissions​

The API token must include the following scopes: Voice.

Request​

Path Parameters

    AccountSid uuidrequired

    The unique identifier for the account that is associated with this recording.

    Sid uuidrequired

    The unique identifier for the recording.

Responses​

OK

Schema

    account_siduuid

    The unique identifier for the account that is associated with this recording.

    Example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
    api_versionstring

    The version of the SignalWire API.

    Example: 2010-04-01
    call_sidstring

    The unique identifier for the call that is associated with this recording.

    Example: 43bb71ee-553f-4074-bb20-8e2747647cce
    conference_sidstring

    The unique identifier for the conference that is associated with this recording.

    Example: 2071320d-ee82-4578-84e0-379fb227eb77
    channelsinteger

    The number of channels in a recording. Possible values are 1 or 2.

    Possible values: [1, 2]

    Example: 1
    date_createdstring

    The date, in RFC 2822 format, this recording was created.

    Example: Tue, 25 Sept 2018 23:00:00 +0000
    date_updatedstring

    The date, in RFC 2822 format, this recording was updated.

    Example: Wed, 26 Sept 2018 23:00:04 +0000
    end_timestring

    The time, in RFC 2822 format, this recording endded.

    Example: Wed, 26 Sept 2018 23:00:04 +0000
    pricestring

    The cost for the recording.

    Example: -0.0025
    price_unitstring

    The currency of the price of the recording.

    Example: USD
    durationstring

    The length, in seconds, of the recording.

    Example: 4
    sidstring

    The unique identifier for the recording.

    Example: 19e436af-5688-4307-b03b-bdb2b42b8142
    sourcestring

    How the recording was made.

    Possible values: [DialVerb, Conference, OutBoundApi, Trunking, RecordVerb, StartCallRecordingApi, StartConferenceRecording]

    Example: DialVerb
    statusstring

    The status of the recording.

    Possible values: [paused, in-progress, stopped]

    Example: stopped
    error_codestring

    Further details about a failed recording.

    Example: null
    uristring

    The URI of the recording.

    Example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Calls/058a869c-d387-4bef-8e62-6b0bc0895bed/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json

    subresource_uris

    object

    Subresource URIs

    transcriptionsstring
    Example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json
Last updated on