Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Call Recording

Call Recording

Description:

Call Recording allows you to switch Voice Call Recording ON or OFF at any point during a call flow.

Warning!

The Call recording widget cannot be placed as the first widget - it must come after another widget like an initial Say/Play or Gather. It is important to consider whether your use case requires that your customers be warned before a call is recorded.

Required Configuration:

You must choose whether the Recording is to be switched on or off.

Name

Description

Default

RECORD CALL

A toggle button (boolean) to allow users to Toggle Call Recording to On or Off within a Call Flow

  1. Start Recording
  2. Stop Recording

Please note that these options are not for pausing and resuming a Voice Recording, they are specifcally meant for Start and Stop.

Please do read Legal Considerations with Recording Voice and Video Communications

False

Optional Configuration:

You may optionally decide to declare recording Status Call back Url, Recording Channels, trim behaviour and a for the request initiated by this Widget.

Name/Key

Description

Default

RECORDING STATUS CALLBACK URL

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

empty

RECORDING STATUS CALLBACK METHOD

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

POST

RECORDING STATUS EVENT

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

completed

RECORDING CHANNELS

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

TRIM

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.

do-not-trim



Transitions:

These are the events that trigger transitions from this widget:

Name

Key

Description

Success

success

The call recording was successfully toggled

Failed

failed

Could not toggle call recording

Variables:

The following variables will be added to the Execution context (where MY_WIDGET_NAMEis the name of your actual widget):

Status

widgets.MY_WIDGET_NAME.Status

Conference SID

widgets.MY_WIDGET_NAME.ConferenceSid

Price Unit

widgets.MY_WIDGET_NAME.PriceUnit

Date Updated

widgets.MY_WIDGET_NAME.DateUpdated

Start Time

widgets.MY_WIDGET_NAME.StartTime

Recording Uri

widgets.MY_WIDGET_NAME.Uri

Account SID

widgets.MY_WIDGET_NAME.AccountSid

Channels

widgets.MY_WIDGET_NAME.Channels

Source of Recoring Start

widgets.MY_WIDGET_NAME.Source

Encryption Details

widgets.MY_WIDGET_NAME.EncryptionDetails

Call SID

widgets.MY_WIDGET_NAME.CallSid

Recording SID

widgets.MY_WIDGET_NAME.Sid

Duration

widgets.MY_WIDGET_NAME.Duration

Date Created

widgets.MY_WIDGET_NAME.DateCreated

Error Code

widgets.MY_WIDGET_NAME.ErrorCcode

Price

widgets.MY_WIDGET_NAME.Price

API Version

widgets.MY_WIDGET_NAME.ApiVersion

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.