Call Recording 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

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 an account

gethttps://api.vonage.com/t/vbc.prod/call_recording/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/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/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/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/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/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_recording/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/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

Get single company call recording

Get a single company call recording for an account

gethttps://api.vonage.com/t/vbc.prod/call_recording/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/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/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

Delete company call recording

Delete a single company call recording for an account

deletehttps://api.vonage.com/t/vbc.prod/call_recording/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

Create a company call recording export job

Create a company call recording export job for an account

posthttps://api.vonage.com/t/vbc.prod/call_recording/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

Responses
Content Type
application/json

Created

job_ids

array

Unique identifier of the created export jobs

Example Response

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

Available Operations

Get on-demand call recordings

Get on-demand call recordings for an account user

gethttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/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.

user_id

string

Required

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

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/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/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/api/accounts/549825/users/745249/call_recordings?page=0

URL for the first page of recordings

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=1

URL for the previous page of recordings

self

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=2

URL for the current page of recordings

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=3

URL for the next page of recordings

last

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=4

URL for the last page of recordings

page

integer

page_size

integer

total_items

integer

total_pages

integer

Example Response

Get single on-demand call recording

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

gethttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/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.

user_id

string

Required

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

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/api/accounts/549825/users/745249/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/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

Delete on-demand call recording

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

deletehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/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.

user_id

string

Required

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

recording_id

string

Required

The recording ID

Responses

No Content

Create an on-demand call recording export job

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

posthttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/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.

user_id

string

Required

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

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

Responses
Content Type
application/json

Created

job_ids

array

Unique identifier of the created export jobs

Example Response

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.

Available Operations

Get call recording export jobs

Get call recording export jobs for an account user

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

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.

user_id

string

Required

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

Query Parameters

status

string

Filter export jobs by status

Responses
Content Type
application/json

_embedded

A list of job objects

jobs

array

_links

object

self

object

href

string

example

https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs/5e667ef2-2860-4471-8813-320980a55c20

URL for the current export job

download_url

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/retrieve?jobId=afa725fb-d418-4eaf-b3f9-0e66396fafdc

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

example10

Number of files included in the export job

string

exampleafa725fb-d418-4eaf-b3f9-0e66396fafdc

Unique identifier of the export job

status

string

examplecomplete

Status of the export job

valid_until

string(date-time)

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

Expiration time for the complete export job contents

_links

object

first

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=0

URL for the first page of export jobs

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=1

URL for the previous page of export jobs

self

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=2

URL for the current page of export jobs

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=3

URL for the next page of export jobs

last

object

href

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs?page=4

URL for the last page of export jobs

page

integer

page_size

integer

total_items

integer

total_pages

integer

Example Response

Get call recording export job

Get a single call recording export job for an account user

gethttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/:account_id/users/:user_id/call_recordings/jobs/:job_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.

user_id

string

Required

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

job_id

string

Required

The job ID

Responses
Content Type
application/json

_links

object

self

object

href

string

example

https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/jobs/5e667ef2-2860-4471-8813-320980a55c20

URL for the current export job

download_url

string

examplehttps://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/retrieve?jobId=afa725fb-d418-4eaf-b3f9-0e66396fafdc

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

example10

Number of files included in the export job

string

exampleafa725fb-d418-4eaf-b3f9-0e66396fafdc

Unique identifier of the export job

status

string

examplecomplete

Status of the export job

valid_until

string(date-time)

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

Expiration time for the complete export job contents

Call Recording API

Company Call Recording

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

Create a company call recording export job

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

On-Demand Call Recording

Available Operations

Get on-demand call recordings

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Get single on-demand call recording

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Delete on-demand call recording

Authentication

Path Parameters

Responses

Create an on-demand call recording export job

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

Export Job

Available Operations

Get call recording export jobs

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Get call recording export job

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json