Call Recording CSP(India) API

The Vonage Business Communications Call Recording API enables you to manage your company recordings.

Your application must subscribe to the CallRecording API suite to use this API.

Download OpenAPI Specification

Company Call Recording CSP(India)

Company Call Recording lets administrators schedule call recording rules and recording parameters for your entire office.

Available Operations

Get company call recordings

Get company call recordings for a CSP(India) account

gethttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/:account_id/company_call_recordings

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.

Query Parameters

call_direction

string

Filter recordings by call direction

Must be one of:INBOUNDOUTBOUNDINTRA_PBX

call_id

string

Filter recordings by Call ID

caller_id

string

Filter recordings by Caller ID

cnam

string

Filter recordings by CNAM (Caller ID Name)

dnis

string

Filter recordings by DNIS (Dialed Number Identification Service)

duration:gte

integer

Filter recordings by duration in milliseconds (greater than or equal to)

duration:lte

integer

Filter recordings by duration in milliseconds (less than or equal to)

extension

string

Filter recordings by extension number

order

string

Defaultstart:DESC

Sort recordings by field value

page

integer

Default1

Requested page number

page_size

integer

Default10

Requested page size

start:gte

string

Filter recordings by start date (greater than or equal to) [yyyy-MM-ddTHH:mm:ssZ in ISO 8601]

start:lte

string

Filter recordings by start date (less than or equal to) [yyyy-MM-ddTHH:mm:ssZ in ISO 8601]

Responses
Content Type
application/json

_embedded

A list of recording objects

recordings

array

_links

object

self

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings/193228

URL for the current recording

call_direction

string

exampleINBOUND

Direction of the recorded call

call_id

string

examplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id

string

example17325550100

Caller ID of the caller of the recorded call

cnam

string

exampleJOHN SMITH

CNAM (Caller ID Name) of the caller of the recorded call

dnis

string

example17325550100

DNIS (Dialed Number Identification Service) of the caller of the recorded call

download_url

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/audio/recording/193228

URL to download the recording. This URL requires authorization with your OAuth token.

duration

integer

example60000

Duration of the recorded call in milliseconds

end

string(date-time)

example2019-01-01T00:00:00+0000

End time of the recorded call

extensions

array

Extensions associated with the call recording

file_name

string

example730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes

integer

example100000

File size in bytes of the call recording

integer

example193228

Unique identifier of the call recording

rule_ids

array

Identifier of the call recording rule(s) that triggered the call recording

start

string(date-time)

example2019-01-01T00:00:00+0000

Start time of the recorded call

_links

object

first

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=0

URL for the first page of recordings

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=1

URL for the previous page of recordings

self

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=2

URL for the current page of recordings

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recordingindia/api/accounts/549825/company_call_recordings?page=3

URL for the next page of recordings

last

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=4

URL for the last page of recordings

page

integer

page_size

integer

total_items

integer

total_pages

integer

Example Response

{
   "_embedded": {
      "recordings": [
         {
            "_links": {
               "self": {
                  "href": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings/193228"
               }
            },
            "call_direction": "INBOUND",
            "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
            "caller_id": 17325550100,
            "cnam": "JOHN SMITH",
            "dnis": "17325550100",
            "download_url": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/audio/recording/193228",
            "duration": 60000,
            "end": "2019-01-01T00:00:00+0000",
            "extensions": [
               999
            ],
            "file_name": "730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3",
            "file_size_in_bytes": 100000,
            "id": 193228,
            "rule_ids": [
               1989,
               2012,
               449
            ],
            "start": "2019-01-01T00:00:00+0000"
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=0"
      },
      "prev": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=1"
      },
      "self": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=2"
      },
      "next": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recordingindia/api/accounts/549825/company_call_recordings?page=3"
      },
      "last": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings?page=4"
      }
   },
   "page": 0,
   "page_size": 0,
   "total_items": 0,
   "total_pages": 0
}

Get single company call recording

Get a single company call recording for a CSP(India) account

gethttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/:account_id/company_call_recordings/:recording_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.

recording_id

string

Required

The recording ID

Responses
Content Type
application/json

_links

object

self

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings/193228

URL for the current recording

call_direction

string

exampleINBOUND

Direction of the recorded call

call_id

string

examplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id

string

example17325550100

Caller ID of the caller of the recorded call

cnam

string

exampleJOHN SMITH

CNAM (Caller ID Name) of the caller of the recorded call

dnis

string

example17325550100

DNIS (Dialed Number Identification Service) of the caller of the recorded call

download_url

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/audio/recording/193228

URL to download the recording. This URL requires authorization with your OAuth token.

duration

integer

example60000

Duration of the recorded call in milliseconds

end

string(date-time)

example2019-01-01T00:00:00+0000

End time of the recorded call

extensions

array

Extensions associated with the call recording

file_name

string

example730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes

integer

example100000

File size in bytes of the call recording

integer

example193228

Unique identifier of the call recording

rule_ids

array

Identifier of the call recording rule(s) that triggered the call recording

start

string(date-time)

example2019-01-01T00:00:00+0000

Start time of the recorded call

Example Response

{
   "_links": {
      "self": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/549825/company_call_recordings/193228"
      }
   },
   "call_direction": "INBOUND",
   "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
   "caller_id": 17325550100,
   "cnam": "JOHN SMITH",
   "dnis": "17325550100",
   "download_url": "https://api.vonage.com/t/vbc.prod/call_recording_india/api/audio/recording/193228",
   "duration": 60000,
   "end": "2019-01-01T00:00:00+0000",
   "extensions": [
      999
   ],
   "file_name": "730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3",
   "file_size_in_bytes": 100000,
   "id": 193228,
   "rule_ids": [
      1989,
      2012,
      449
   ],
   "start": "2019-01-01T00:00:00+0000"
}

Delete company call recording

Delete a single company call recording for a CSP(India) account

deletehttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/:account_id/company_call_recordings/:recording_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.

recording_id

string

Required

The recording ID

Responses

No Content

Export Job CSP(India)

Export jobs let users download recordings in bulk based on search criteria. Export jobs are initiated from the corresponding company and on-demand call recording export endpoints.

Available Operations

Create a company call recording export job

Create a company call recording export job

Create a company call recording export job for a CSP(India) account

posthttps://api.vonage.com/t/vbc.prod/call_recording_india/api/accounts/:account_id/company_call_recordings/export

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.

Request Body
Content Type
application/json

call_direction

string

exampleINBOUND

Filter recordings by call direction

Must be one of:INBOUNDOUTBOUNDINTRA_PBX

call_id

string

examplec91150a6-8cc4-4e73-9fef-17fd925c6448

Filter recordings by Call ID

caller_id

string

example17325550100

Filter recordings by Caller ID

cnam

string

exampleJOHN SMITH

Filter recordings by CNAM (Caller ID Name)

dnis

string

example17325550100

Filter recordings by DNIS (Dialed Number Identification Service)

duration:gte

integer

example60000

Filter recordings by duration in milliseconds (greater than or equal to)

duration:lte

integer

example60000

Filter recordings by duration in milliseconds (less than or equal to)

extension

string

example999

Filter recordings by extension number

start:gte

string

example2019-01-01T00:00:00+0000

Filter recordings by start date (greater than or equal to)

start:lte

string

example2019-01-01T00:00:00+0000

Filter recordings by start date (less than or equal to)

Example Request

{
   "call_direction": "INBOUND",
   "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
   "caller_id": 17325550100,
   "cnam": "JOHN SMITH",
   "dnis": "17325550100",
   "duration:gte": 60000,
   "duration:lte": 60000,
   "extension": 999,
   "start:gte": "2019-01-01T00:00:00+0000",
   "start:lte": "2019-01-01T00:00:00+0000"
}

{
   "call_direction": "INBOUND",
   "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
   "caller_id": 17325550100,
   "cnam": "JOHN SMITH",
   "dnis": "17325550100",
   "duration:gte": 60000,
   "duration:lte": 60000,
   "extension": 999,
   "start:gte": "2019-01-01T00:00:00+0000",
   "start:lte": "2019-01-01T00:00:00+0000"
}

Responses
Content Type
application/json

Created

job_ids

array

Unique identifier of the created export jobs

Example Response

{
   "job_ids": [
      "afa725fb-d418-4eaf-b3f9-0e66396fafdc"
   ]
}

Download CSP(India)

Download audio files for company call recordings.

Available Operations

Download a call recording audio file

Download a call recording audio file in MP3 format.

Example Usage:

curl -X GET "https://api.vonage.com/t/vbc.prod/call_recording_india/api/audio/recording/193228" \ -H "Authorization: Bearer YOUR_TOKEN" \ --output recording_193228.mp3

gethttps://api.vonage.com/t/vbc.prod/call_recording_india/api/audio/recording/:recording_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

recording_id

string

Required

The recording ID

Responses

OK - Successfully returns the audio file as binary data.

Header Parameters

Transfer-Encoding

string

examplechunked

Content-Type

string

exampleaudio/mpeg

Download a call recording export Job

Download a ZIP archive containing multiple call recordings from an export job.

Example Usage:

curl -X GET "https://api.vonage.com/t/vbc.prod/call_recording_india/api/bulkDownload/retrieve?jobId=7a688e12-99ee-4816-8385-b21b90583838&userName=john.doe" \ --output export_recordings.zip

gethttps://api.vonage.com/t/vbc.prod/call_recording_india/api/bulkDownload/retrieve

Query Parameters

jobId

string

example7a688e12-99ee-4816-8385-b21b90583838

The job ID

userName

string

examplejohn.doe

The login_name of the user

Responses

Successfully returns the export job as a ZIP archive.

Header Parameters

Transfer-Encoding

string

examplechunked

Content-Type

string

exampleapplication/zip

Call Recording CSP(India) API

Company Call Recording CSP(India)

Available Operations

Get company call recordings

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Get single company call recording

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Delete company call recording

Authentication

Path Parameters

Responses

Export Job CSP(India)

Available Operations

Create a company call recording export job

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Download CSP(India)

Available Operations

Download a call recording audio file

Authentication

Path Parameters

Responses

Header Parameters

Download a call recording export Job

Query Parameters

Responses

Header Parameters

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json