TWtwilio
Api20100401CallRecording

Create a recording for the call

Changed on

Create a recording for the call

post/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

The SID of the Account that will create the resource.

CallSidstring required

The SID of the Call to associate the resource with.

Request body application/x-www-form-urlencoded

RecordingStatusCallbackEventstring[]

The recording status events on which we should call the recording_status_callback URL. Can be: in-progress, completed and absent and the default is completed. Separate multiple event values with a space.

RecordingStatusCallbackstring uri

The URL we should call using the recording_status_callback_method on each recording event specified in recording_status_callback_event. For more information, see RecordingStatusCallback parameters.

RecordingStatusCallbackMethod'GET' | 'POST' http-method

The HTTP method we should use to call recording_status_callback. Can be: GET or POST and the default is POST.

Trimstring

Whether to trim any leading and trailing silence in the recording. Can be: trim-silence or do-not-trim and the default is do-not-trim. trim-silence trims the silence from the beginning and end of the recording and do-not-trim does not.

RecordingChannelsstring

The number of channels used in the recording. Can be: mono or dual and the default is mono. mono records all parties of the call into one channel. dual records each party of a 2-party call into separate channels.

RecordingTrackstring

The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is generated from Twilio. both records the audio that is received and generated by Twilio.

RecordingConfigurationIdstring

The identifier of the configuration to be used when creating and processing the recording

Response

OK

account_sidstring nullable

The SID of the Account that created the Recording resource.

api_versionstring nullable

The API version used to make the recording.

call_sidstring nullable

The SID of the Call the Recording resource is associated with.

conference_sidstring nullable

The Conference SID that identifies the conference associated with the recording, if a conference recording.

date_createdstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was last updated, specified in RFC 2822 format.

start_timestring date-time-rfc-2822 nullable

The start time of the recording in GMT and in RFC 2822 format.

durationstring nullable

The length of the recording in seconds.

sidstring nullable

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

pricenumber nullable

The one-time cost of creating the recording in the price_unit currency.

uristring nullable

The URI of the resource, relative to https://api.twilio.com.

encryption_detailsunknown
price_unitstring currency nullable

The currency used in the price property. Example: USD.

status'in-progress' | 'paused' | 'stopped' | 'processing' | 'completed' | 'absent'

The status of the recording. Can be: processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.

channelsinteger

The number of channels in the final recording file. Can be: 1, or 2. Separating a two leg call into two separate channels of the recording file is supported in Dial and Outbound Rest API record options.

source'DialVerb' | 'Conference' | 'OutboundAPI' | 'Trunking' | 'RecordVerb' | 'StartCallRecordingAPI' | 'StartConferenceRecordingAPI'

How the recording was created. Can be: DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, and StartConferenceRecordingAPI.

error_codeinteger nullable

The error code that describes why the recording is absent. The error code is described in our Error Dictionary. This value is null if the recording status is not absent.

trackstring nullable

The recorded track. Can be: inbound, outbound, or both.

Changes

  • v2010a6753266b8b0Revision changes
    • info

      added the new optional request property

  • v2010475b69553e34Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status