Call Recording API

The Vonage Business Cloud Call Recording API enables you to manage your company and on-demand call recordings.

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

Company Call Recording

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

Get company call recordings

Get company call recordings for an account

GET https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None

Query Parameter

Key Description Example Default
call_direction
string

Filter recordings by call direction


Must be one of: INBOUND, OUTBOUND or INTRA_PBX
INBOUND None
call_id
string

Filter recordings by Call ID

c91150a6-8cc4-4e73-9fef-17fd925c6448 None
caller_id
string

Filter recordings by Caller ID

17325550100 None
cnam
string

Filter recordings by CNAM (Caller ID Name)

JOHN SMITH None
dnis
string

Filter recordings by DNIS (Dialed Number Identification Service)

17325550100 None
duration:gte
integer

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

60000 None
duration:lte
integer

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

60000 None
extension
string

Filter recordings by extension number

999 None
order
string

Sort recordings by field value

start:DESC start:DESC
page
integer

Requested page number

1 1
page_size
integer

Requested page size

10 10
start:gte
string

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

2019-01-01T00:00:00+0000 None
start:lte
string

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

2019-01-01T00:00:00+0000 None

View response field descriptions

Response Fields

Field Description
_embedded

A list of recording objects

Field Description
recordings
array of objects
Field Description
call_direction
string

Direction of the recorded call

call_id
string

Call ID of the recorded call

caller_id
string

Caller ID of the caller of the recorded call

cnam
string

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

dnis
string

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

download_url
string

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

duration
integer

Duration of the recorded call in milliseconds

end
string

End time of the recorded call

extensions
array of strings

Extensions associated with the call recording

Field Description
file_name
string

File name of the call recording

file_size_in_bytes
integer

File size in bytes of the call recording

id
integer

Unique identifier of the call recording

rule_ids
array of integers

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

Field Description
start
string

Start time of the recorded call

page
integer
page_size
integer
total_items
integer
total_pages
integer
{
  "_embedded": {
    "recordings": [
      {
        "_links": {
          "self": {
            "href": "https://api.vonage.com/t/vbc.prod/call_recording/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/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/api/accounts/549825/company_call_recordings?page=0"
    },
    "prev": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings?page=1"
    },
    "self": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings?page=2"
    },
    "next": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings?page=3"
    },
    "last": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings?page=4"
    }
  },
  "page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}
Unauthorized
Forbidden
Not Found

Get single company call recording

Get a single company call recording for an account

GET https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings/:recording_id

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
recording_id
Required | string

The recording ID

193228 None

View response field descriptions

Response Fields

Field Description
call_direction
string

Direction of the recorded call

call_id
string

Call ID of the recorded call

caller_id
string

Caller ID of the caller of the recorded call

cnam
string

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

dnis
string

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

download_url
string

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

duration
integer

Duration of the recorded call in milliseconds

end
string

End time of the recorded call

extensions
array of strings

Extensions associated with the call recording

Field Description
file_name
string

File name of the call recording

file_size_in_bytes
integer

File size in bytes of the call recording

id
integer

Unique identifier of the call recording

rule_ids
array of integers

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

Field Description
start
string

Start time of the recorded call

{
  "_links": {
    "self": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/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/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"
}
Unauthorized
Forbidden
Not Found

Delete company call recording

Delete a single company call recording for an account

DELETE https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings/:recording_id

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
recording_id
Required | string

The recording ID

193228 None
No Content
Unauthorized
Forbidden
Not Found

Create a company call recording export job

Create a company call recording export job for an account

POST https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings/export

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None

Request body application/json

Key Description Example Default
call_direction
string

Filter recordings by call direction


Must be one of: INBOUND, OUTBOUND or INTRA_PBX
INBOUND None
call_id
string

Filter recordings by Call ID

c91150a6-8cc4-4e73-9fef-17fd925c6448 None
caller_id
string

Filter recordings by Caller ID

17325550100 None
cnam
string

Filter recordings by CNAM (Caller ID Name)

JOHN SMITH None
dnis
string

Filter recordings by DNIS (Dialed Number Identification Service)

17325550100 None
duration:gte
integer

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

60000 None
duration:lte
integer

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

60000 None
extension
string

Filter recordings by extension number

999 None
start:gte
string

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

2019-01-01 00:00:00 None
start:lte
string

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

2019-01-01 00:00:00 None

View response field descriptions

Response Fields

Field Description
job_ids
array of strings

Unique identifier of the created export jobs

Field Description
{
  "job_ids": [
    "afa725fb-d418-4eaf-b3f9-0e66396fafdc"
  ]
}
Unauthorized
Forbidden
Not Found

On-Demand Call Recording

On-Demand Call Recording lets employees decide when to record calls. It’s a particularly useful phone recording system for businesses when you need to verify the details of a conversation or when it’s essential that you capture accurate notes

Get on-demand call recordings

Get on-demand call recordings for an account user

GET https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
user_id
Required | string

The Vonage Business Cloud user ID. You can use 'self' to refer to the authenticated user.

745249 None

Query Parameter

Key Description Example Default
call_direction
string

Filter recordings by call direction


Must be one of: INBOUND, OUTBOUND or INTRA_PBX
INBOUND None
call_id
string

Filter recordings by Call ID

c91150a6-8cc4-4e73-9fef-17fd925c6448 None
caller_id
string

Filter recordings by Caller ID

17325550100 None
cnam
string

Filter recordings by CNAM (Caller ID Name)

JOHN SMITH None
dnis
string

Filter recordings by DNIS (Dialed Number Identification Service)

17325550100 None
duration:gte
integer

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

60000 None
duration:lte
integer

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

60000 None
extension
string

Filter recordings by extension number

999 None
order
string

Sort recordings by field value

start:DESC start:DESC
page
integer

Requested page number

1 1
page_size
integer

Requested page size

10 10
start:gte
string

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

2019-01-01T00:00:00+0000 None
start:lte
string

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

2019-01-01T00:00:00+0000 None

View response field descriptions

Response Fields

Field Description
_embedded

A list of recording objects

Field Description
recordings
array of objects
Field Description
call_direction
string

Direction of the recorded call

call_id
string

Call ID of the recorded call

caller_id
string

Caller ID of the caller of the recorded call

cnam
string

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

dnis
string

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

download_url
string

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

duration
integer

Duration of the recorded call in milliseconds

end
string

End time of the recorded call

extensions
array of strings

Extensions associated with the call recording

Field Description
file_name
string

File name of the call recording

file_size_in_bytes
integer

File size in bytes of the call recording

id
integer

Unique identifier of the call recording

rule_ids
array of integers

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

Field Description
start
string

Start time of the recorded call

page
integer
page_size
integer
total_items
integer
total_pages
integer
{
  "_embedded": {
    "recordings": [
      {
        "_links": {
          "self": {
            "href": "https://api.vonage.com/t/vbc.prod/call_recording/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/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/api/accounts/549825/users/745249/call_recordings?page=0"
    },
    "prev": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=1"
    },
    "self": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=2"
    },
    "next": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=3"
    },
    "last": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=4"
    }
  },
  "page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}
Unauthorized
Forbidden
Not Found

Get single on-demand call recording

Get a single on-demand call recording for an account user

GET https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/:recording_id

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
user_id
Required | string

The Vonage Business Cloud user ID. You can use 'self' to refer to the authenticated user.

745249 None
recording_id
Required | string

The recording ID

193228 None

View response field descriptions

Response Fields

Field Description
call_direction
string

Direction of the recorded call

call_id
string

Call ID of the recorded call

caller_id
string

Caller ID of the caller of the recorded call

cnam
string

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

dnis
string

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

download_url
string

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

duration
integer

Duration of the recorded call in milliseconds

end
string

End time of the recorded call

extensions
array of strings

Extensions associated with the call recording

Field Description
file_name
string

File name of the call recording

file_size_in_bytes
integer

File size in bytes of the call recording

id
integer

Unique identifier of the call recording

rule_ids
array of integers

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

Field Description
start
string

Start time of the recorded call

{
  "_links": {
    "self": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/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/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": [
    {}
  ],
  "start": "2019-01-01T00:00:00+0000"
}
Unauthorized
Forbidden
Not Found

Delete on-demand call recording

Delete a single on-demand call recording for an account user

DELETE https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/:recording_id

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
user_id
Required | string

The Vonage Business Cloud user ID. You can use 'self' to refer to the authenticated user.

745249 None
recording_id
Required | string

The recording ID

193228 None
No Content
Unauthorized
Forbidden
Not Found

Create an on-demand call recording export job

Create an on-demand call recording export job for an account user

POST https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/export

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
user_id
Required | string

The Vonage Business Cloud user ID. You can use 'self' to refer to the authenticated user.

745249 None

Request body application/json

Key Description Example Default
call_direction
string

Filter recordings by call direction


Must be one of: INBOUND, OUTBOUND or INTRA_PBX
INBOUND None
call_id
string

Filter recordings by Call ID

c91150a6-8cc4-4e73-9fef-17fd925c6448 None
caller_id
string

Filter recordings by Caller ID

17325550100 None
cnam
string

Filter recordings by CNAM (Caller ID Name)

JOHN SMITH None
dnis
string

Filter recordings by DNIS (Dialed Number Identification Service)

17325550100 None
duration:gte
integer

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

60000 None
duration:lte
integer

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

60000 None
extension
string

Filter recordings by extension number

999 None
start:gte
string

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

2019-01-01 00:00:00 None
start:lte
string

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

2019-01-01 00:00:00 None

View response field descriptions

Response Fields

Field Description
job_ids
array of strings

Unique identifier of the created export jobs

Field Description
{
  "job_ids": [
    "afa725fb-d418-4eaf-b3f9-0e66396fafdc"
  ]
}
Unauthorized
Forbidden
Not Found

Export Job

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.

Get call recording export jobs

Get call recording export jobs for an account user

GET https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/jobs

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
user_id
Required | string

The Vonage Business Cloud user ID. You can use 'self' to refer to the authenticated user.

745249 None

Query Parameter

Key Description Example Default
status
string

Filter export jobs by status

None None

View response field descriptions

Response Fields

Field Description
_embedded

A list of job objects

Field Description
jobs
array of objects
Field Description
download_url
string

URL to download the completed export job. This URL requires authorization with your OAuth token.

files_completed
integer

Number of files completed by the export job

files_total
integer

Number of files included in the export job

id
string

Unique identifier of the export job

status
string

Status of the export job

valid_until
string

Expiration time for the complete export job contents

page
integer
page_size
integer
total_items
integer
total_pages
integer
{
  "_embedded": {
    "jobs": [
      {
        "_links": {
          "self": {
            "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs/5e667ef2-2860-4471-8813-320980a55c20"
          }
        },
        "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/retrieve?jobId=afa725fb-d418-4eaf-b3f9-0e66396fafdc",
        "files_completed": 1,
        "files_total": 10,
        "id": "afa725fb-d418-4eaf-b3f9-0e66396fafdc",
        "status": "complete",
        "valid_until": "2019-01-01T00:00:00.000+00:00"
      }
    ]
  },
  "_links": {
    "first": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=0"
    },
    "prev": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=1"
    },
    "self": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=2"
    },
    "next": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=3"
    },
    "last": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=4"
    }
  },
  "page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}
Unauthorized
Forbidden
Not Found

Get call recording export job

Get a single call recording export job for an account user

GET https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/jobs/:job_id

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

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

549825 None
user_id
Required | string

The Vonage Business Cloud user ID. You can use 'self' to refer to the authenticated user.

745249 None
job_id
Required | string

The job ID

7a688e12-99ee-4816-8385-b21b90583838 None

View response field descriptions

Response Fields

Field Description
download_url
string

URL to download the completed export job. This URL requires authorization with your OAuth token.

files_completed
integer

Number of files completed by the export job

files_total
integer

Number of files included in the export job

id
string

Unique identifier of the export job

status
string

Status of the export job

valid_until
string

Expiration time for the complete export job contents

{
  "_links": {
    "self": {
      "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs/5e667ef2-2860-4471-8813-320980a55c20"
    }
  },
  "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/retrieve?jobId=afa725fb-d418-4eaf-b3f9-0e66396fafdc",
  "files_completed": 1,
  "files_total": 10,
  "id": "afa725fb-d418-4eaf-b3f9-0e66396fafdc",
  "status": "complete",
  "valid_until": "2019-01-01T00:00:00.000+00:00"
}
Unauthorized
Forbidden
Not Found