Record

The Record API lets start recording a live call at any time during the call. It also lets you stop the recording. You could use this API if you don’t want to record the whole call due to some sensitive information being exchanged on the call.

BaseURI: https://api.plivo.com/v1/Account/{auth_id}/Call/{call_uuid}/Record/

Record a Call

POST https://api.plivo.com/v1/Account/{auth_id}/Call/{call_uuid}/Record/

Arguments

Parameter Description
time_limit (optional) Max recording duration in seconds. Defaults to 60.
file_format (optional) The format of the recording. The valid formats are mp3 and wav formats. Defaults to mp3.
transcription_type (optional) The type of transcription required. The following values are allowed:
  • auto - This is the default value. Transcription is completely automated; turnaround time is about 5 minutes.
  • hybrid - Transcription is a combination of automated and human verification processes; turnaround time is about 10-15 minutes.
  • *Our transcription service is primarily for the voicemail use case (limited to recorded files lasting for up to 2 minutes). Currently the service is available only in English and you will be charged for the usage. Please check out the price details.
transcription_url (optional) The URL where the transcription is available.
transcription_method (optional) The method used to invoke the transcription_url. Defaults to POST.
callback_url (optional) The URL invoked by the API when the recording ends. The following parameters are sent to the callback_url:
  • api_id - the same API ID returned by the call record API.
  • record_url - the URL to access the recorded file.
  • call_uuid - the call uuid of the recorded call.
  • recording_id - the recording ID of the recorded call.
  • recording_duration - duration in seconds of the recording.
  • recording_duration_ms - duration in milliseconds of the recording.
  • recording_start_ms - when the recording started (epoch time UTC) in milliseconds.
  • recording_end_ms - when the recording ended (epoch time UTC) in milliseconds.
callback_method (optional) The method which is used to invoke the callback_url URL. Defaults to POST.

Response

HTTP Status Code: 202

{
  "url": "http://s3.amazonaws.com/recordings_2013/48dfaf60-3b2a-11e3.mp3",
  "message": "call recording started",
  "recording_id": "48dfaf60-3b2a-11e3",
  "api_id": "c7b69074-58be-11e1-86da-adf28403fe48"
}

Stop Recording a Call

DELETE https://api.plivo.com/v1/Account/{auth_id}/Call/{call_uuid}/Record/

Arguments

Parameter Description
URL (optional) You can specify a record URL to stop only one record. By default all recordings are stopped.

Response

HTTP Status Code: 204