Call Recording API

Version 1
Version 1

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.

For more information, see Call-Recording

Télécharger la spécification OpenAPI

Company Call Recording

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

Opérations disponibles

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

Demande de renseignements Paramètres

call_direction
string

Filter recordings by call direction

Il doit s'agir de l'un d'entre eux :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
Défautstart:DESC

Sort recordings by field value

page
integer
Défaut1

Requested page number

page_size
integer
Défaut10

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]

Réponses
Type de contenu
application/json

OK

_embedded

A list of recording objects

recordings
array
_links
object
self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/193228

URL for the current recording

call_direction
string
exempleINBOUND

Direction of the recorded call

call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id
string
exemple17325550100

Caller ID of the caller of the recorded call

cnam
string
exempleJOHN SMITH

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

dnis
string
exemple17325550100

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

download_url
string
exemplehttps://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
exemple60000

Duration of the recorded call in milliseconds

end
string(date-time)
exemple2019-01-01T00:00:00+0000

End time of the recorded call

extensions
array

Extensions associated with the call recording

file_name
string
exemple730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes
integer
exemple100000

File size in bytes of the call recording

id
integer
exemple193228

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)
exemple2019-01-01T00:00:00+0000

Start time of the recorded call

_links
object
first
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings?page=0

URL for the first page of recordings

prev
object
href
string
exemplehttps://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
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings?page=2

URL for the current page of recordings

next
object
href
string
exemplehttps://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
exemplehttps://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
exemple1
page_size
integer
exemple10
total_items
integer
exemple100
total_pages
integer
exemple10

Exemple Réponse

{
   "_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": 10,
   "total_items": 100,
   "total_pages": 10
}

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

recording_id
string
Exigée

The recording ID

Réponses
Type de contenu
application/json

OK

_links
object
self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/193228

URL for the current recording

call_direction
string
exempleINBOUND

Direction of the recorded call

call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id
string
exemple17325550100

Caller ID of the caller of the recorded call

cnam
string
exempleJOHN SMITH

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

dnis
string
exemple17325550100

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

download_url
string
exemplehttps://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
exemple60000

Duration of the recorded call in milliseconds

end
string(date-time)
exemple2019-01-01T00:00:00+0000

End time of the recorded call

extensions
array

Extensions associated with the call recording

file_name
string
exemple730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes
integer
exemple100000

File size in bytes of the call recording

id
integer
exemple193228

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)
exemple2019-01-01T00:00:00+0000

Start time of the recorded call

Exemple Réponse

{
   "_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"
}

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

recording_id
string
Exigée

The recording ID

Réponses

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

Corps de la demande
Type de contenu
application/json

call_direction
string
exempleINBOUND

Filter recordings by call direction

Il doit s'agir de l'un d'entre eux :INBOUNDOUTBOUNDINTRA_PBX
call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Filter recordings by Call ID

caller_id
string
exemple17325550100

Filter recordings by Caller ID

cnam
string
exempleJOHN SMITH

Filter recordings by CNAM (Caller ID Name)

dnis
string
exemple17325550100

Filter recordings by DNIS (Dialed Number Identification Service)

duration:gte
integer
exemple60000

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

duration:lte
integer
exemple60000

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

extension
string
exemple999

Filter recordings by extension number

start:gte
string
exemple2019-01-01T00:00:00+0000

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

start:lte
string
exemple2019-01-01T00:00:00+0000

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

Exemple Demande

{
   "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"
}

Réponses
Type de contenu
application/json

Created

job_ids
array

Unique identifier of the created export jobs

Exemple Réponse

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

Get company call recording Transcriptions

Get company call recording Transcriptions for an account

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

Demande de renseignements Paramètres

call_direction
string

Filter recordings by call direction

Il doit s'agir de l'un d'entre eux :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
Défautstart:DESC

Sort recordings by field value

page
integer
Défaut1

Requested page number

page_size
integer
Défaut10

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]

transcription_ready
boolean

Filter Transcriptions by Transcription Status

Réponses
Type de contenu
application/json

OK

_embedded

A list of transcription objects

transcriptions
array
recording_id
integer
exemple1069241910

Unique identifier of the call recording

call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id
string
exemple17325550100

Caller ID of the caller of the recorded call

call_date
string(date-time)
exemple2019-01-01T00:00:00+0000

Date and time of the recorded call

duration
integer
exemple60000

Duration of the recorded call in milliseconds

direction
string
exempleINBOUND

Direction of the recorded call

cnam
string
exempleJOHN SMITH

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

dnis
string
exemple17325550100

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

transcription_ready
boolean
exempletrue

Indicates if the transcription is ready

transcription_url
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/v1/api/transcription/193228

URL to get the transcription when transcription_ready is true. This URL requires authorization with your OAuth token. Only present in response when transcription has completed successfully.

transcription_error
string
exempleTranscription job failed at AI

Error message if the transcription failed. Only present in response when transcription_ready is false and processing encountered an error.

_links
object
first
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=0

URL for the first page of transcriptions

prev
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=1

URL for the previous page of transcriptions

self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=2

URL for the current page of transcriptions

next
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=3

URL for the next page of transcriptions

last
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=4

URL for the last page of transcriptions

page
integer
exemple1
page_size
integer
exemple10
total_items
integer
exemple100
total_pages
integer
exemple10

Exemple Réponse

{
   "_embedded": {
      "transcriptions": [
         {
            "recording_id": 1069241910,
            "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
            "caller_id": "17325550100",
            "call_date": "2019-01-01T00:00:00+0000",
            "duration": 60000,
            "direction": "INBOUND",
            "cnam": "JOHN SMITH",
            "dnis": "17325550100",
            "transcription_ready": true,
            "transcription_url": "https://api.vonage.com/t/vbc.prod/call_recording/v1/api/transcription/193228",
            "transcription_error": "Transcription job failed at AI"
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=0"
      },
      "prev": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=1"
      },
      "self": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=2"
      },
      "next": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=3"
      },
      "last": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/transcriptions?page=4"
      }
   },
   "page": 1,
   "page_size": 10,
   "total_items": 100,
   "total_pages": 10
}

Create a company call recording and transcription export job

Create a company call recording and transcription export job containing recordings and transcriptions(if available for recording) for an account.

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

Corps de la demande
Type de contenu
application/json

call_direction
string
exempleINBOUND

Filter recordings by call direction

Il doit s'agir de l'un d'entre eux :INBOUNDOUTBOUNDINTRA_PBX
call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Filter recordings by Call ID

caller_id
string
exemple17325550100

Filter recordings by Caller ID

cnam
string
exempleJOHN SMITH

Filter recordings by CNAM (Caller ID Name)

dnis
string
exemple17325550100

Filter recordings by DNIS (Dialed Number Identification Service)

duration:gte
integer
exemple60000

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

duration:lte
integer
exemple60000

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

extension
string
exemple999

Filter recordings by extension number

start:gte
string
exemple2019-01-01T00:00:00+0000

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

start:lte
string
exemple2019-01-01T00:00:00+0000

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

Exemple Demande

{
   "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"
}

Réponses
Type de contenu
application/json

Created

job_ids
array

Unique identifier of the created export jobs

Exemple Réponse

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

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

Opérations disponibles

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

Demande de renseignements Paramètres

call_direction
string

Filter recordings by call direction

Il doit s'agir de l'un d'entre eux :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
Défautstart:DESC

Sort recordings by field value

page
integer
Défaut1

Requested page number

page_size
integer
Défaut10

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]

Réponses
Type de contenu
application/json

OK

_embedded

A list of recording objects

recordings
array
_links
object
self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/company_call_recordings/193228

URL for the current recording

call_direction
string
exempleINBOUND

Direction of the recorded call

call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id
string
exemple17325550100

Caller ID of the caller of the recorded call

cnam
string
exempleJOHN SMITH

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

dnis
string
exemple17325550100

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

download_url
string
exemplehttps://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
exemple60000

Duration of the recorded call in milliseconds

end
string(date-time)
exemple2019-01-01T00:00:00+0000

End time of the recorded call

extensions
array

Extensions associated with the call recording

file_name
string
exemple730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes
integer
exemple100000

File size in bytes of the call recording

id
integer
exemple193228

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)
exemple2019-01-01T00:00:00+0000

Start time of the recorded call

_links
object
first
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=0

URL for the first page of recordings

prev
object
href
string
exemplehttps://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
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings?page=2

URL for the current page of recordings

next
object
href
string
exemplehttps://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
exemplehttps://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
exemple1
page_size
integer
exemple10
total_items
integer
exemple100
total_pages
integer
exemple10

Exemple Réponse

{
   "_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": 10,
   "total_items": 100,
   "total_pages": 10
}

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

recording_id
string
Exigée

The recording ID

Réponses
Type de contenu
application/json

OK

_links
object
self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/193228

URL for the current recording

call_direction
string
exempleINBOUND

Direction of the recorded call

call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Call ID of the recorded call

caller_id
string
exemple17325550100

Caller ID of the caller of the recorded call

cnam
string
exempleJOHN SMITH

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

dnis
string
exemple17325550100

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

download_url
string
exemplehttps://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
exemple60000

Duration of the recorded call in milliseconds

end
string(date-time)
exemple2019-01-01T00:00:00+0000

End time of the recorded call

extensions
array

Extensions associated with the call recording

file_name
string
exemple730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes
integer
exemple100000

File size in bytes of the call recording

id
integer
exemple193228

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)
exemple2019-01-01T00:00:00+0000

Start time of the recorded call

Exemple Réponse

{
   "_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": [
      0
   ],
   "start": "2019-01-01T00:00:00+0000"
}

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

recording_id
string
Exigée

The recording ID

Réponses

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

Corps de la demande
Type de contenu
application/json

call_direction
string
exempleINBOUND

Filter recordings by call direction

Il doit s'agir de l'un d'entre eux :INBOUNDOUTBOUNDINTRA_PBX
call_id
string
exemplec91150a6-8cc4-4e73-9fef-17fd925c6448

Filter recordings by Call ID

caller_id
string
exemple17325550100

Filter recordings by Caller ID

cnam
string
exempleJOHN SMITH

Filter recordings by CNAM (Caller ID Name)

dnis
string
exemple17325550100

Filter recordings by DNIS (Dialed Number Identification Service)

duration:gte
integer
exemple60000

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

duration:lte
integer
exemple60000

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

extension
string
exemple999

Filter recordings by extension number

start:gte
string
exemple2019-01-01T00:00:00+0000

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

start:lte
string
exemple2019-01-01T00:00:00+0000

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

Exemple Demande

{
   "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"
}

Réponses
Type de contenu
application/json

Created

job_ids
array

Unique identifier of the created export jobs

Exemple Réponse

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

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.

Opérations disponibles

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

Demande de renseignements Paramètres

status
string

Filter export jobs by status

Réponses
Type de contenu
application/json

OK

_embedded

A list of job objects

jobs
array
_links
object
self
object
href
string
exemplehttps://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
exemplehttps://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
exemple5

Number of files completed by the export job

files_total
integer
exemple10

Number of files included in the export job

id
string
exempleafa725fb-d418-4eaf-b3f9-0e66396fafdc

Unique identifier of the export job

status
string
exemplecomplete

Status of the export job

valid_until
string(date-time)
exemple2019-01-01T00:00:00+0000

Expiration time for the complete export job contents

_links
object
first
object
href
string
exemplehttps://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

prev
object
href
string
exemplehttps://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
exemplehttps://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

next
object
href
string
exemplehttps://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
exemplehttps://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
exemple1
page_size
integer
exemple10
total_items
integer
exemple100
total_pages
integer
exemple10

Exemple Réponse

{
   "_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": 5,
            "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": 10,
   "total_items": 100,
   "total_pages": 10
}

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

job_id
string
Exigée

The job ID

Réponses
Type de contenu
application/json

OK

_links
object
self
object
href
string
exemplehttps://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
exemplehttps://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
exemple5

Number of files completed by the export job

files_total
integer
exemple10

Number of files included in the export job

id
string
exempleafa725fb-d418-4eaf-b3f9-0e66396fafdc

Unique identifier of the export job

status
string
exemplecomplete

Status of the export job

valid_until
string(date-time)
exemple2019-01-01T00:00:00+0000

Expiration time for the complete export job contents

Exemple Réponse

{
   "_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": 5,
   "files_total": 10,
   "id": "afa725fb-d418-4eaf-b3f9-0e66396fafdc",
   "status": "complete",
   "valid_until": "2019-01-01T00:00:00+0000"
}

Get call recording and transcription export jobs

Get call recording and transcription export jobs for an account user that were initiated from the company call recording and transcription export endpoint. These jobs include both call recordings and their transcriptions (if available).

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

Demande de renseignements Paramètres

status
string

Filter export jobs by status

Réponses
Type de contenu
application/json

OK

_embedded

A list of job objects

jobs
array
_links
object
self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs/5e667ef2-2860-4471-8813-320980a55c20

URL for the current export job

download_url
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/recordings_transcriptions/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
exemple5

Number of files completed by the export job

files_total
integer
exemple10

Number of files included in the export job

id
string
exempleafa725fb-d418-4eaf-b3f9-0e66396fafdc

Unique identifier of the export job

status
string
exemplecomplete

Status of the export job

valid_until
string(date-time)
exemple2019-01-01T00:00:00+0000

Expiration time for the complete export job contents

_links
object
first
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=0

URL for the first page of export jobs

prev
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=1

URL for the previous page of export jobs

self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=2

URL for the current page of export jobs

next
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=3

URL for the next page of export jobs

last
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=4

URL for the last page of export jobs

page
integer
exemple1
page_size
integer
exemple10
total_items
integer
exemple100
total_pages
integer
exemple10

Exemple Réponse

{
   "_embedded": {
      "jobs": [
         {
            "_links": {
               "self": {
                  "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs/5e667ef2-2860-4471-8813-320980a55c20"
               }
            },
            "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/recordings_transcriptions/retrieve?jobId=afa725fb-d418-4eaf-b3f9-0e66396fafdc",
            "files_completed": 5,
            "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/recordings_transcriptions/jobs?page=0"
      },
      "prev": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=1"
      },
      "self": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=2"
      },
      "next": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=3"
      },
      "last": {
         "href": "https://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs?page=4"
      }
   },
   "page": 1,
   "page_size": 10,
   "total_items": 100,
   "total_pages": 10
}

Get call recording and transcription export job

Get call recording and transcription export job for an account user that was initiated from the company call recording and transcription export endpoint. This job include both company call recordings and their transcriptions (if available).

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

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

user_id
string
Exigée

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

job_id
string
Exigée

The job ID

Réponses
Type de contenu
application/json

OK

_links
object
self
object
href
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/accounts/549825/users/745249/call_recordings/recordings_transcriptions/jobs/5e667ef2-2860-4471-8813-320980a55c20

URL for the current export job

download_url
string
exemplehttps://api.vonage.com/t/vbc.prod/call_recording/api/bulkDownload/recordings_transcriptions/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
exemple5

Number of files completed by the export job

files_total
integer
exemple10

Number of files included in the export job

id
string
exempleafa725fb-d418-4eaf-b3f9-0e66396fafdc

Unique identifier of the export job

status
string
exemplecomplete

Status of the export job

valid_until
string(date-time)
exemple2019-01-01T00:00:00+0000

Expiration time for the complete export job contents

Exemple Réponse

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