Record

The following actions can be performed with the Record APIs.

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

Record a Call

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

Parameters

There are no mandatory parameters for this API. The following optional parameters can be specified:

Optional Parameters
Parameter Description
time_limit Max recording duration in seconds. Defaults to 60.
file_format The format of the recording. The valid formats are mp3 and wav formats. Defaults to mp3.
transcription_type 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 The URL where the transcription is available.
transcription_method The method used to invoke the transcription_url. Defaults to POST.
callback_url 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 The method which is used to invoke the callback_url URL. Defaults to POST.

Response

HTTP Status: 202

JSON:
{
  "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"
}
JSON:
{
  "call_uuid": "cfa1e4c0-e21e-11e1-92d4-28373719f1a2",
  "record_url": "http://s3.amazonaws.com/recordings_2013/ffca7d3abcc0.mp3",
  "message": "record done",
  "api_id": "c7b69074-58be-11e1-86da-adf28403fe48"
}

Stop Recording a Call

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

Optional Parameters

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

Response

HTTP Status: 204

Asynchronous Mode

All Plivo APIs can be invoked in asynchronous mode with the inclusion of the callback_url parameter. Note: In asynchronous mode, you will only get back a response with the api_id. The response is sent to the callback_url which is fired immediately after execution of the Plivo API. See API Request and API Response for more information.

Asynchronous Parameters

Parameter Description
callback_url The URL that is notified by the API when the response is available and to which the response is sent.
callback_method The method used to notify the callback_url URL. Defaults to POST.

Asynchronous Response

The Asynchronous Response is sent in json format in the response field.

See the API Response section for more information.