Recording

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

List All Recordings

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

Arguments

Parameter Description
subaccount (optional) auth_id of the subaccount. Lists only those recordings of the main accounts which are tied to the specified subaccount.
call_uuid (optional) Used to filter recordings for a specific call.
add_time (optional) 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 (optional) Used to display the number of results per page. The maximum number of results that can be fetched is 20.
offset (optional) 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 Code: 200

{
    "api_id": "ff25223a-1c9f-11e4-80aa-12313f048015",
    "meta": {
        "limit": 3,
        "next": "/v1/Account/MANWVLYTK4ZWU1YTY4ZT/Recording/?limit=3&offset=3",
        "offset": 0,
        "previous": null,
        "total_count": 948
    },
    "objects": [
        {
            "add_time": "2014-08-05 16:15:15.852059+05:30",
            "call_uuid": "c2c128e2-1c8c-11e4-9bff-1db8a9db0432",
            "conference_name": "noname",
            "recording_duration_ms": "345100.00000",
            "recording_end_ms": "1407235509007.00000",
            "recording_format": "mp3",
            "recording_id": "c2186400-1c8c-1124-a664-0026b945b522",
            "recording_start_ms": "1407235163907.00000",
            "recording_type": "conference",
            "recording_url": "http://s3.amazonaws.com/recordings_2013/c2186400-1c8c-1124-a664-0026b945b522.mp3",
            "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4ZT/Recording/c2186400-1c8c-1124-a664-0026b945b522/"
        },
        {
            "add_time": "2014-08-05 16:05:21.993853+05:30",
            "call_uuid": "fc773e88-1c8b-11e4-b25a-0fe7bcc54670",
            "conference_name": "noname",
            "recording_duration_ms": "90700.00000",
            "recording_end_ms": "1407234920253.00000",
            "recording_format": "mp3",
            "recording_id": "fc2716b0-1c8b-11e4-bwad-842b2b17453e",
            "recording_start_ms": "1407234829553.00000",
            "recording_type": "conference",
            "recording_url": "http://s3.amazonaws.com/recordings_2013/fc2716b0-1c8b-11e4-bwad-842b2b17453e.mp3",
            "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4ZT/Recording/fc2716b0-1c8b-11e4-bwad-842b2b17453e/"
        },
        {
            "add_time": "2014-08-05 15:51:56.582492+05:30",
            "call_uuid": "3eb4c16e-1c8a-11e4-978e-0fe7bcc54670",
            "conference_name": "noname",
            "recording_duration_ms": "34100.00000",
            "recording_end_ms": "1407234115543.00000",
            "recording_format": "mp3",
            "recording_id": "3e701c9e-1c8a-11e4-bwad-842b2b17453e",
            "recording_start_ms": "1407234081443.00000",
            "recording_type": "conference",
            "recording_url": "http://s3.amazonaws.com/recordings_2013/3e701c9e-1c8a-11e4-bwad-842b2b17453e.mp3",
            "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4ZT/Recording/3e701c9e-1c8a-11e4-bwad-842b2b17453e/"
        }
    ]
}

List a Specific Recording

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

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

Arguments

None

Response

HTTP Status Code: 200

{
    "add_time": "2014-08-05 16:15:15.852059+05:30",
    "api_id": "7abf0744-1ca0-11e4-a2d1-22000ac5040c",
    "call_uuid": "c2c128e2-1c8c-11e4-9bff-1db8a9db0432",
    "conference_name": "noname",
    "recording_duration_ms": "345100.00000",
    "recording_end_ms": "1407235509007.00000",
    "recording_format": "mp3",
    "recording_id": "c2186400-1c8c-11e4-a664-0026b945b52x",
    "recording_start_ms": "1407235163907.00000",
    "recording_type": "conference",
    "recording_url": "http://s3.amazonaws.com/recordings_2013/c2186400-1c8c-11e4-a664-0026b945b52x.mp3",
    "resource_uri": "/v1/Account/MANWVLYTK4ZWU1YTY4ZT/Recording/c2186400-1c8c-11e4-a664-0026b945b52x/"
}

Response Attributes

add_time
string The datetime string on which the recording was created on your account.
call_uuid
string The ID of the call on Plivo which was recorded.
conference_name
string The name of the conference room which was recorded. This value will be null if it was a regular recording.
recording_duration_ms
string The duration of the recording in milliseconds.
recording_format
string The format of the recording file. This can be either 'wav' or 'mp3'.
recording_id
string The ID of the recording.
recording_type
string The type of the recording. In the case where a conference was recorded, this value will be 'conference' or it will be 'normal' in case of a regular call.
recording_url
string The URL of the recorded file. All our recordings are hosted on Amazon S3.

Delete a Specific Recording

This API lets you delete a recording from your Plivo account using the recording ID.

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

Parameters

None

Response

HTTP Status Code: 204