Recording

The following actions can be performed with the Recording APIs:

  BaseURI: https://api.plivo.com/v1/Account/{auth_id}/Recording/

List All Recordings

  URI: https://api.plivo.com/v1/Account/{auth_id}/Recording/
  Method: GET

Parameters

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

Optional Parameters
Parameter Description
subaccount auth_id of the subaccount. Lists only those recordings of the main accounts which are tied to the specified subaccount.
call_uuid Used to filter recordings for a specific call.
add_time Used to filter out recordings according to the time they were added.The add_time filter is a comparative filter that can be used in the following four forms:
  • add_time__gt: gt stands for greater than. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started after 2012-03-21 11:47, use add_time__gt=2012-03-21 11:47
  • add_time__gte: gte stands for greater than or equal. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started after or exactly at 2012-03-21 11:47[:30], use add_time__gte=2012-03-21 11:47[:30]
  • add_time__lt: lt stands for lesser than. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started before 2012-03-21 11:47, use add_time__lt=2012-03-21 11:47
  • add_time__gte: lte stands for lesser than or equal. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started before or exactly at 2012-03-21 11:47[:30], use add_time__lte=2012-03-21 11:47[:30]
Note: The above filters can be combined to get recordings that started in a particular time range.
limit Used to display the number of results per page. The maximum number of results that can be fetched is 20.
offset Denotes the number of value items by which the results should be offset. Eg:- If the result contains a 1000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results.

Response

HTTP Status: 200

JSON: 
{
  "meta": {
    "previous": null,
    "total_count": 2,
    "offset": 0,
    "limit": 20,
    "next": null
  },
  "api_id": "40b5a864-58cb-11e1-86da-adf28403fe48",
  "objects": [
    {
      "call_uuid": "84c638ab-f2f0-464a-a55d-898c7310f8a3",
      "recording_id": "8d5cd396-4f88-11e1-829f-5b9cbd2c7acd",
      "recording_type": "mp3",
      "recording_format": "mp3",
      "conference_name": "",
      "recording_url": "http://s3.amazonaws.com/plivocloud/8d5cd396-4f88-11e1-829f-5b9cbd2c7acd.mp3",
      "resource_uri": "/v1/Account/MAGWNTM3ZTK1M2YZMDUU/Recording/8d5cd396-4f88-11e1-829f-5b9cbd2c7acd/",
      "add_time": "2012-02-04T23:33:08.079231"
    },
    {
      "call_uuid": "1f2ca11c-ec69-4599-89b8-4a14fba3ccd6",
      "recording_id": "c7b71d14-58be-11e1-b7e1-ffca7d3abcc0",
      "recording_type": "mp3",
      "recording_format": "mp3",
      "conference_name": "",
      "recording_url": "http://s3.amazonaws.com/plivocloud/c7b71d14-58be-11e1-b7e1-ffca7d3abcc0.mp3",
      "resource_uri": "/v1/Account/MAGWNTM3ZTK1M2YZMDUU/Recording/c7b71d14-58be-11e1-b7e1-ffca7d3abcc0/",
      "add_time": "2012-02-16T16:53:56.574859"
    }
  ]
}

List a Particular Recording

The following API is used to retrieve a specific recording based on the recording_id.

  URI: https://api.plivo.com/v1/Account/{auth_id}/Recording/{recording_id}/
  Method: GET

Parameters

There are no parameters required for this API call.

Response

HTTP Status: 200

JSON: 
{
  "recording_id": "c7b71d14-58be-11e1-b7e1-ffca7d3abcc0",
  "api_id": "9f9d30fe-58cb-11e1-86da-adf28403fe48",
  "conference_name": "",
  "recording_type": "mp3",
  "recording_format": "mp3",
  "call_uuid": "1f2ca11c-ec69-4599-89b8-4a14fba3ccd6",
  "recording_url": "http://s3.amazonaws.com/plivocloud/c7b71d14-58be-11e1-b7e1-ffca7d3abcc0.mp3",
  "resource_uri": "/v1/Account/MAGWNTM3ZTK1M2YZMDUU/Recording/c7b71d14-58be-11e1-b7e1-ffca7d3abcc0/",
  "add_time": "2012-02-16T16:53:56.574859"
}

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.

Developers

Navigation