Call Recording CSP(India) API

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

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

OpenAPI-Spezifikation herunterladen

Company Call Recording CSP(India)

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

Verfügbare Operationen

Get company call recordings

Get company call recordings for a CSP(India) account

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Ihr OAuth-Token. Lesen Sie mehr über OAuth-Tokens	Headers	`Bearer <access_token>`

Pfad Parameter

account_id

string

Erforderlich

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

Abfrage Parameter

call_direction

string

Filter recordings by call direction

Muss eines der folgenden sein: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

Standardstart:DESC

Sort recordings by field value

page

integer

Standard1

Requested page number

page_size

integer

Standard10

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]

Antworten
Inhalt Typ
application/json

_embedded

A list of recording objects

recordings

array

_links

object

self

object

href

string

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

URL for the current recording

call_direction

string

BeispielINBOUND

Direction of the recorded call

call_id

string

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

Call ID of the recorded call

caller_id

string

Beispiel17325550100

Caller ID of the caller of the recorded call

cnam

string

BeispielJOHN SMITH

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

dnis

string

Beispiel17325550100

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

download_url

string

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

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

duration

integer

Beispiel60000

Duration of the recorded call in milliseconds

end

string(date-time)

Beispiel2019-01-01T00:00:00+0000

End time of the recorded call

extensions

array

Extensions associated with the call recording

file_name

string

Beispiel730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes

integer

Beispiel100000

File size in bytes of the call recording

integer

Beispiel193228

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)

Beispiel2019-01-01T00:00:00+0000

Start time of the recorded call

_links

object

first

object

href

string

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

URL for the first page of recordings

object

href

string

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

URL for the previous page of recordings

self

object

href

string

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

URL for the current page of recordings

object

href

string

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

URL for the next page of recordings

last

object

href

string

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

URL for the last page of recordings

page

integer

page_size

integer

total_items

integer

total_pages

integer

Beispiel Antwort

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

Get single company call recording

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

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Ihr OAuth-Token. Lesen Sie mehr über OAuth-Tokens	Headers	`Bearer <access_token>`

Pfad Parameter

account_id

string

Erforderlich

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

recording_id

string

Erforderlich

The recording ID

Antworten
Inhalt Typ
application/json

_links

object

self

object

href

string

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

URL for the current recording

call_direction

string

BeispielINBOUND

Direction of the recorded call

call_id

string

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

Call ID of the recorded call

caller_id

string

Beispiel17325550100

Caller ID of the caller of the recorded call

cnam

string

BeispielJOHN SMITH

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

dnis

string

Beispiel17325550100

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

download_url

string

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

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

duration

integer

Beispiel60000

Duration of the recorded call in milliseconds

end

string(date-time)

Beispiel2019-01-01T00:00:00+0000

End time of the recorded call

extensions

array

Extensions associated with the call recording

file_name

string

Beispiel730048.11826465111463122315701.95a7584be856e34a582025d420c20d9d.1463122442148.mp3

File name of the call recording

file_size_in_bytes

integer

Beispiel100000

File size in bytes of the call recording

integer

Beispiel193228

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)

Beispiel2019-01-01T00:00:00+0000

Start time of the recorded call

Beispiel Antwort

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

Delete company call recording

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

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Ihr OAuth-Token. Lesen Sie mehr über OAuth-Tokens	Headers	`Bearer <access_token>`

Pfad Parameter

account_id

string

Erforderlich

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

recording_id

string

Erforderlich

The recording ID

Antworten

No Content

Export Job CSP(India)

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

Verfügbare Operationen

Create a company call recording export job

Create a company call recording export job

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

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Ihr OAuth-Token. Lesen Sie mehr über OAuth-Tokens	Headers	`Bearer <access_token>`

Pfad Parameter

account_id

string

Erforderlich

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

Anfrage Körper
Inhalt Typ
application/json

call_direction

string

BeispielINBOUND

Filter recordings by call direction

Muss eines der folgenden sein:INBOUNDOUTBOUNDINTRA_PBX

call_id

string

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

Filter recordings by Call ID

caller_id

string

Beispiel17325550100

Filter recordings by Caller ID

cnam

string

BeispielJOHN SMITH

Filter recordings by CNAM (Caller ID Name)

dnis

string

Beispiel17325550100

Filter recordings by DNIS (Dialed Number Identification Service)

duration:gte

integer

Beispiel60000

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

duration:lte

integer

Beispiel60000

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

extension

string

Beispiel999

Filter recordings by extension number

start:gte

string

Beispiel2019-01-01T00:00:00+0000

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

start:lte

string

Beispiel2019-01-01T00:00:00+0000

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

Beispiel Anfrage

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

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

Antworten
Inhalt Typ
application/json

Created

job_ids

array

Unique identifier of the created export jobs

Beispiel Antwort

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

Download CSP(India)

Download audio files for company call recordings.

Verfügbare Operationen

Download a call recording audio file

Download a call recording audio file in MP3 format.

Example Usage:

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

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Ihr OAuth-Token. Lesen Sie mehr über OAuth-Tokens	Headers	`Bearer <access_token>`

Pfad Parameter

recording_id

string

Erforderlich

The recording ID

Antworten

OK - Successfully returns the audio file as binary data.

Kopfzeile Parameter

Transfer-Encoding

string

Beispielchunked

Content-Type

string

Beispielaudio/mpeg

Download a call recording export Job

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

Example Usage:

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

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

Abfrage Parameter

jobId

string

Beispiel7a688e12-99ee-4816-8385-b21b90583838

The job ID

userName

string

Beispieljohn.doe

The login_name of the user

Antworten

Successfully returns the export job as a ZIP archive.

Kopfzeile Parameter

Transfer-Encoding

string

Beispielchunked

Content-Type

string

Beispielapplication/zip

Call Recording CSP(India) API

Company Call Recording CSP(India)

Verfügbare Operationen

Get company call recordings

Authentifizierung

Pfad Parameter

Abfrage Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Get single company call recording

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Delete company call recording

Authentifizierung

Pfad Parameter

Antworten

Export Job CSP(India)

Verfügbare Operationen

Create a company call recording export job

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Download CSP(India)

Verfügbare Operationen

Download a call recording audio file

Authentifizierung

Pfad Parameter

Antworten

Kopfzeile Parameter

Download a call recording export Job

Abfrage Parameter

Antworten

Kopfzeile Parameter

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json