Skip to main content

Create a Recording.

POST 

/Accounts/:AccountSid/Calls/:CallSid/Recordings

Create a recording.

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.

    CallSid uuidrequired

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

Body

required

    RecordingChannelsstring

    The number of channels in the recording. Can be mono (both legs of call recorded under one channel into one recording file) or dual (each leg of call recorded in separate channels into one recording file).

    Possible values: [mono, dual]

    RecordingStatusCallbackstring

    The URL to request to when recording is available.

    Example: null
    RecordingStatusCallbackEventstring

    The different recording statuses. Possible values are completed, in-progress, and absent. To specify multiple events, separate with a space. Defaults to completed.

    Possible values: [completed, in-progress, absent]

    Example: completed
    RecordingStatusCallbackMethodstring

    Whether the request to RecordingStatusCallback URL is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    RecordingTrackstring

    Specifies whether to record the inbound audio to SignalWire from the called party or the outbound audio from SignalWire to the called party or both the inbound and outbound audio. Defaults to both.

    Possible values: [inbound, outbound, both]

    Example: inbound
    Trimstring

    Whether leading and trailing silence is trimmed from a recording. Possible values are trim-silence and do-not-trim. Default is trim-silence.

    Possible values: [trim-silence, do-not-trim]

    Example: trim-silence

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