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.
Company Call Recording lets administrators schedule call recording rules and recording parameters for your entire office.
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
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.
Company Call Recording lets administrators schedule call recording rules and recording parameters for your entire office.
Get company call recordings for an account
GET
https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings
Host
https://api.vonage.com
GET
/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
Filter recordings by call direction
Must be one of:INBOUND
, OUTBOUND
or INTRA_PBX
Filter recordings by Call ID
Filter recordings by Caller ID
Filter recordings by CNAM (Caller ID Name)
Filter recordings by DNIS (Dialed Number Identification Service)
Filter recordings by duration in milliseconds (greater than or equal to)
Filter recordings by duration in milliseconds (less than or equal to)
Filter recordings by extension number
Sort recordings by field value
Requested page number
Requested page size
Filter recordings by start date (greater than or equal to) [yyyy-MM-ddTHH:mm:ssZ in ISO 8601]
Filter recordings by start date (less than or equal to) [yyyy-MM-ddTHH:mm:ssZ in ISO 8601]
A list of recording objects
Direction of the recorded call
Call ID of the recorded call
Caller ID of the caller of the recorded call
CNAM (Caller ID Name) of the caller of the recorded call
DNIS (Dialed Number Identification Service) of the caller of the recorded call
URL to download the recording. This URL requires authorization with your OAuth token.
Duration of the recorded call in milliseconds
End time of the recorded call
Extensions associated with the call recording
File name of the call recording
File size in bytes of the call recording
Unique identifier of the call recording
Identifier of the call recording rule(s) that triggered the call recording
Start time of the recorded call
{
"_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
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
GET
/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings/:recording_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The recording ID
Direction of the recorded call
Call ID of the recorded call
Caller ID of the caller of the recorded call
CNAM (Caller ID Name) of the caller of the recorded call
DNIS (Dialed Number Identification Service) of the caller of the recorded call
URL to download the recording. This URL requires authorization with your OAuth token.
Duration of the recorded call in milliseconds
End time of the recorded call
Extensions associated with the call recording
File name of the call recording
File size in bytes of the call recording
Unique identifier of the call recording
Identifier of the call recording rule(s) that triggered the call recording
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"
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
DELETE
/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings/:recording_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The recording ID
No Content
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
POST
/t/vbc.prod/call_recording/api/accounts/:account_id/company_call_recordings/export
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
Filter recordings by call direction
Must be one of:INBOUND
, OUTBOUND
or INTRA_PBX
Filter recordings by Call ID
Filter recordings by Caller ID
Filter recordings by CNAM (Caller ID Name)
Filter recordings by DNIS (Dialed Number Identification Service)
Filter recordings by duration in milliseconds (greater than or equal to)
Filter recordings by duration in milliseconds (less than or equal to)
Filter recordings by extension number
Filter recordings by start date (greater than or equal to)
Filter recordings by start date (less than or equal to)
Unique identifier of the created export jobs
{
"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"
}
{
"job_ids": [
"afa725fb-d418-4eaf-b3f9-0e66396fafdc"
]
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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 for an account user
GET
https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings
Host
https://api.vonage.com
GET
/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The Vonage Business Communications user ID. You can use 'self' to refer to the authenticated user.
Filter recordings by call direction
Must be one of:INBOUND
, OUTBOUND
or INTRA_PBX
Filter recordings by Call ID
Filter recordings by Caller ID
Filter recordings by CNAM (Caller ID Name)
Filter recordings by DNIS (Dialed Number Identification Service)
Filter recordings by duration in milliseconds (greater than or equal to)
Filter recordings by duration in milliseconds (less than or equal to)
Filter recordings by extension number
Sort recordings by field value
Requested page number
Requested page size
Filter recordings by start date (greater than or equal to) [yyyy-MM-ddTHH:mm:ssZ in ISO 8601]
Filter recordings by start date (less than or equal to) [yyyy-MM-ddTHH:mm:ssZ in ISO 8601]
A list of recording objects
Direction of the recorded call
Call ID of the recorded call
Caller ID of the caller of the recorded call
CNAM (Caller ID Name) of the caller of the recorded call
DNIS (Dialed Number Identification Service) of the caller of the recorded call
URL to download the recording. This URL requires authorization with your OAuth token.
Duration of the recorded call in milliseconds
End time of the recorded call
Extensions associated with the call recording
File name of the call recording
File size in bytes of the call recording
Unique identifier of the call recording
Identifier of the call recording rule(s) that triggered the call recording
Start time of the recorded call
{
"_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
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
GET
/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/:recording_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The Vonage Business Communications user ID. You can use 'self' to refer to the authenticated user.
The recording ID
Direction of the recorded call
Call ID of the recorded call
Caller ID of the caller of the recorded call
CNAM (Caller ID Name) of the caller of the recorded call
DNIS (Dialed Number Identification Service) of the caller of the recorded call
URL to download the recording. This URL requires authorization with your OAuth token.
Duration of the recorded call in milliseconds
End time of the recorded call
Extensions associated with the call recording
File name of the call recording
File size in bytes of the call recording
Unique identifier of the call recording
Identifier of the call recording rule(s) that triggered the call recording
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"
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
DELETE
/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/:recording_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The Vonage Business Communications user ID. You can use 'self' to refer to the authenticated user.
The recording ID
No Content
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
POST
/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/export
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The Vonage Business Communications user ID. You can use 'self' to refer to the authenticated user.
Filter recordings by call direction
Must be one of:INBOUND
, OUTBOUND
or INTRA_PBX
Filter recordings by Call ID
Filter recordings by Caller ID
Filter recordings by CNAM (Caller ID Name)
Filter recordings by DNIS (Dialed Number Identification Service)
Filter recordings by duration in milliseconds (greater than or equal to)
Filter recordings by duration in milliseconds (less than or equal to)
Filter recordings by extension number
Filter recordings by start date (greater than or equal to)
Filter recordings by start date (less than or equal to)
Unique identifier of the created export jobs
{
"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"
}
{
"job_ids": [
"afa725fb-d418-4eaf-b3f9-0e66396fafdc"
]
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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 for an account user
GET
https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/jobs
Host
https://api.vonage.com
GET
/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/jobs
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The Vonage Business Communications user ID. You can use 'self' to refer to the authenticated user.
Filter export jobs by status
A list of job objects
URL to download the completed export job. This URL requires authorization with your OAuth token.
Number of files completed by the export job
Number of files included in the export job
Unique identifier of the export job
Status of the export job
Expiration time for the complete export job contents
{
"_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+0000"
}
]
},
"_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
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json
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
Host
https://api.vonage.com
GET
/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/jobs/:job_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID. You can use 'self' to refer to the authenticated user's account.
The Vonage Business Communications user ID. You can use 'self' to refer to the authenticated user.
The job ID
URL to download the completed export job. This URL requires authorization with your OAuth token.
Number of files completed by the export job
Number of files included in the export job
Unique identifier of the export job
Status of the export job
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+0000"
}
This endpoint does not support application/json
This endpoint does not support application/json
This endpoint does not support application/json