Vonage Integration Platform

The Vonage Integration Platform API enables call control and webhooks for call events.

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

Download OAS 3 Definition

Improve this specification

Users

Available Operations:

get User info

User info

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self

Responses

200 Success

id

integer

Unique identifier of the user

accountId

integer

Unique identifier of the user's account

acountLabel

string

The name of the user's account

firstName

string

First name of the user

lastName

string

Last name of the user

emailAddress

string

Email address of the user

contactNumber

string

Contact number of the user

status

string

Status of the user

One of: PENDING, ACTIVE, DELETED or ARCHIVED

ucis

array of objects

integer

string

object

string

roles

array of objects

string

Code for the role

string

Name for the role

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 522078,
  "accountId": 257073,
  "acountLabel": "Vonage",
  "firstName": "Robert",
  "lastName": "Smith",
  "emailAddress": "john.smith@example.com",
  "contactNumber": 14155550100,
  "status": "ACTIVE",
  "ucis": [
    {
      "id": 1,
      "ucpLabel": "abc123",
      "health": {
        "status": "abc123",
        "message": "abc123"
      },
      "type": "abc123"
    }
  ],
  "roles": [
    {
      "code": "AU",
      "name": "Account User"
    }
  ]
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Accounts

Available Operations:

get Account info

Account info

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/account

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/account

Responses

200 Successful

id

integer

Unique identifier of the account

name

string

Name of the account

org

string

Organization of the account

ucis

array of objects

integer

string

object

string

status

string

Status of the account

One of: PENDING, ACTIVE, DELETED or ARCHIVED

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 257073,
  "name": "Vonage",
  "org": "Vonage",
  "ucis": [
    {
      "id": 1,
      "ucpLabel": "abc123",
      "ucpAccountId": "abc123",
      "health": {
        "status": "abc123",
        "message": "abc123"
      },
      "type": "abc123"
    }
  ],
  "status": "ACTIVE"
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Calls

Available Operations:

post Place a call
get List active calls
get Get calls count
get Get a call
delete End a call
put Answer call (On supported devices)
put Put call on hold
delete Unhold
put Send call to voicemail (not available for Vonage Business Enterprise (VBE) customers)
post Transfer call

Place a call

POST


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls

Host


        https://api.vonage.com

POST


        /t/vbc.prod/vis/v1/self/calls

Request body application/json

Place call parameters

phoneNumber

string | Required

Phone number to call

Responses

201 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Request

{
}

Example Responses

201 400 401 403 408 422 500 502

[
  {
    "id": 1,
    "externalId": "abc123",
    "type": "abc123",
    "accountId": 1,
    "userId": 1,
    "uciId": 1,
    "direction": "abc123",
    "callerId": "abc123",
    "phoneNumber": "abc123",
    "duration": 1,
    "state": "abc123",
    "startTime": "abc123",
    "answerTime": "abc123",
    "endTime": "abc123"
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

List active calls

Lists currently active calls

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/calls

Query Parameter

direction

string

Filter by call direction. For multiple criteria, seperate values by a comma.

Must be one of: INBOUND or OUTBOUND

offset

integer (int64)

Page number of calls to return

size

integer | Default: 20

Return this amount of calls in the response

order

string | Default: DESC

Sort in either ascending or descending order

Must be one of: DESC or ASC

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

[
  {
    "id": 1,
    "externalId": "abc123",
    "type": "abc123",
    "accountId": 1,
    "userId": 1,
    "uciId": 1,
    "direction": "abc123",
    "callerId": "abc123",
    "phoneNumber": "abc123",
    "duration": 1,
    "state": "abc123",
    "startTime": "abc123",
    "answerTime": "abc123",
    "endTime": "abc123"
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Get calls count

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/count

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/calls/count

Query Parameter

fromDate

integer

Return calls that occurred after this point in time

toDate

integer

Return calls that occurred before this point in time

direction

string

Filter by call direction. For multiple criteria, seperate values by a comma.

Must be one of: INBOUND or OUTBOUND

states

string | Default: ACTIVE

Filter calls by state. For multiple criteria, seperate values by a comma.

Must be one of: INITIALIZING, RINGING, ACTIVE, HELD or REMOTE_HELD

Responses

200 Successful

count

integer

Number of events found

Example Responses

200 400 401 403 408 422 500 502

{
  "count": 1
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Get a call

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/calls/:id

Path Parameters

id

string | Required

Unique identifier of the call

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

[
  {
    "id": 1,
    "externalId": "abc123",
    "type": "abc123",
    "accountId": 1,
    "userId": 1,
    "uciId": 1,
    "direction": "abc123",
    "callerId": "abc123",
    "phoneNumber": "abc123",
    "duration": 1,
    "state": "abc123",
    "startTime": "abc123",
    "answerTime": "abc123",
    "endTime": "abc123"
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

End a call

DELETE


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id

Host


        https://api.vonage.com

DELETE


        /t/vbc.prod/vis/v1/self/calls/:id

Path Parameters

id

string | Required

Unique identifier of the call

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

[
  {
    "id": 1,
    "externalId": "abc123",
    "type": "abc123",
    "accountId": 1,
    "userId": 1,
    "uciId": 1,
    "direction": "abc123",
    "callerId": "abc123",
    "phoneNumber": "abc123",
    "duration": 1,
    "state": "abc123",
    "startTime": "abc123",
    "answerTime": "abc123",
    "endTime": "abc123"
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Answer call (On supported devices)

PUT


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id/answer

Host


        https://api.vonage.com

PUT


        /t/vbc.prod/vis/v1/self/calls/:id/answer

Path Parameters

id

string | Required

Unique identifier of the call

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 1,
  "externalId": "abc123",
  "type": "abc123",
  "accountId": 1,
  "userId": 1,
  "uciId": 1,
  "direction": "abc123",
  "callerId": "abc123",
  "phoneNumber": "abc123",
  "duration": 1,
  "state": "abc123",
  "startTime": "abc123",
  "answerTime": "abc123",
  "endTime": "abc123"
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Put call on hold

PUT


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id/hold

Host


        https://api.vonage.com

PUT


        /t/vbc.prod/vis/v1/self/calls/:id/hold

Path Parameters

id

string | Required

Unique identifier of the call

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 1,
  "externalId": "abc123",
  "type": "abc123",
  "accountId": 1,
  "userId": 1,
  "uciId": 1,
  "direction": "abc123",
  "callerId": "abc123",
  "phoneNumber": "abc123",
  "duration": 1,
  "state": "abc123",
  "startTime": "abc123",
  "answerTime": "abc123",
  "endTime": "abc123"
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Unhold

DELETE


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id/hold

Host


        https://api.vonage.com

DELETE


        /t/vbc.prod/vis/v1/self/calls/:id/hold

Path Parameters

id

string | Required

Unique identifier of the call

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 1,
  "externalId": "abc123",
  "type": "abc123",
  "accountId": 1,
  "userId": 1,
  "uciId": 1,
  "direction": "abc123",
  "callerId": "abc123",
  "phoneNumber": "abc123",
  "duration": 1,
  "state": "abc123",
  "startTime": "abc123",
  "answerTime": "abc123",
  "endTime": "abc123"
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Send call to voicemail (not available for Vonage Business Enterprise (VBE) customers)

PUT


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id/vmtransfer

Host


        https://api.vonage.com

PUT


        /t/vbc.prod/vis/v1/self/calls/:id/vmtransfer

Path Parameters

id

string | Required

Unique identifier of the call

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 1,
  "externalId": "abc123",
  "type": "abc123",
  "accountId": 1,
  "userId": 1,
  "uciId": 1,
  "direction": "abc123",
  "callerId": "abc123",
  "phoneNumber": "abc123",
  "duration": 1,
  "state": "abc123",
  "startTime": "abc123",
  "answerTime": "abc123",
  "endTime": "abc123"
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Transfer call

POST


        https://api.vonage.com/t/vbc.prod/vis/v1/self/calls/:id/transfer

Host


        https://api.vonage.com

POST


        /t/vbc.prod/vis/v1/self/calls/:id/transfer

Path Parameters

id

string | Required

Unique identifier of the call

Request body application/json

Call transfer parameters

phoneNumber

string | Required

Phone number to transfer to

Responses

200 Successful

id

integer

Unique identifier of the call

externalId

string

External identifier of the call

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the call

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

state

string

Status of the call

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the call

answerTime

string

Time to answer the call

endTime

string

End time of the call

Example Request

{
}

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 1,
  "externalId": "abc123",
  "type": "abc123",
  "accountId": 1,
  "userId": 1,
  "uciId": 1,
  "direction": "abc123",
  "callerId": "abc123",
  "phoneNumber": "abc123",
  "duration": 1,
  "state": "abc123",
  "startTime": "abc123",
  "answerTime": "abc123",
  "endTime": "abc123"
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Events

Available Operations:

get List events
get Get events count
get Get event

List events

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/events

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/events

Query Parameter

types

string

Record type

Must be one of: CALL

fromDate

integer

Return events that occurred after this point in time

toDate

integer

Return events that occurred before this point in time

direction

string

Filter by event direction

Must be one of: INBOUND or OUTBOUND

states

string

Filter events by state

Must be one of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

offset

integer (int64)

Page number of events to return

size

integer | Default: 20

Return this amount of events in the response

order

string | Default: ASC

Sort in either ascending or descending order'

Must be one of: DESC or ASC

sort

string

Sort events by property

Responses

200 Successful

id

integer

Unique identifier of the event

externalId

string

External identifier of the event

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the event

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

smsData

string

state

string

Status of the event

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the event

answerTime

string

Time to answer the event

endTime

string

End time of the event

Example Responses

200 400 401 403 408 422 500 502

[
  {
    "id": 1,
    "externalId": "abc123",
    "type": "abc123",
    "accountId": 1,
    "userId": 1,
    "uciId": 1,
    "direction": "abc123",
    "callerId": "abc123",
    "phoneNumber": "abc123",
    "duration": 1,
    "smsData": "abc123",
    "state": "abc123",
    "startTime": "abc123",
    "answerTime": "abc123",
    "endTime": "abc123"
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Get events count

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/events/count

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/events/count

Query Parameter

fromDate

integer

Return events that occurred after this point in time

toDate

integer

Return events that occurred before this point in time

direction

string

Filter by event direction

Must be one of: INBOUND or OUTBOUND

states

string

Filter events by state

Must be one of: INITIALIZING, RINGING, ACTIVE, HELD or REMOTE_HELD

Responses

200 Successful

count

integer

Number of events found

Example Responses

200 400 401 403 408 422 500 502

{
  "count": 1
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Get event

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/events/:id

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/events/:id

Path Parameters

id

string | Required

Unique identifier of the event

Responses

200 Successful

id

integer

Unique identifier of the event

externalId

string

External identifier of the event

type

string

Record type

One of: CALL

accountId

integer

Unique identifier of the account

userId

integer

Unique identifier of the user

uciId

integer

Unique identifier of communications provider

direction

string

Direction of the event

One of: INBOUND or OUTBOUND

callerId

string

Remote caller ID

phoneNumber

string

Unique identifier of the account

duration

integer

Duration of the call in milliseconds

smsData

string

state

string

Status of the event

One of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED

startTime

string

Start time of the event

answerTime

string

Time to answer the event

endTime

string

End time of the event

Example Responses

200 400 401 403 408 422 500 502

[
  {
    "id": 1,
    "externalId": "abc123",
    "type": "abc123",
    "accountId": 1,
    "userId": 1,
    "uciId": 1,
    "direction": "abc123",
    "callerId": "abc123",
    "phoneNumber": "abc123",
    "duration": 1,
    "smsData": "abc123",
    "state": "abc123",
    "startTime": "abc123",
    "answerTime": "abc123",
    "endTime": "abc123"
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Webhooks

Webhooks are external URLs which subscribe to receive events via HTTP POST for a specified set of events.

Create a new webhook subscription

POST


        https://api.vonage.com/t/vbc.prod/vis/v1/self/webhooks

Host


        https://api.vonage.com

POST


        /t/vbc.prod/vis/v1/self/webhooks

Request body application/json

Webhook create parameters

url

string

Destination URL for events

events

array of strings

Events to subscribe to the webhook

signingAlgo

string

Signing algorithm for the webhook

Must be one of: HMAC_SHA256

signingKey

string

Signing key for the webhook

metadataPolicy

string

Metadata policy for the webhook

Must be one of: NONE, HEADER or BODY

Responses

201 Successful

id

string

Unique identifier for the webhook

userId

string

Unique identifier of the user

accountId

string

Unique identifier of the account

url

string

Destination URL for events

status

string

Status for the webhook

One of: ACTIVE or PAUSED

events

array of strings

Subscribed events for the webhook

signingAlgo

string

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE

metadataPolicy

string

Metadata policy for the webhook

One of: NONE, HEADER or BODY

expireAt

string

Expiration time for the webhook

createdAt

string

Created time for the webhook

renewedAt

string

Last renewed time for the webhook

purgeAt

string

Scheduled purge time for the webhook

signingKey

string

Signing key for the webhook

statistics

object

integer

Total delivery attempts

integer

Total successful deliveries

integer

Total failed deliveries

boolean

Current delivery status

Example Request

{
  "url": "https://www.example.com",
  "events": [
    "CALL"
  ],
  "signingAlgo": "HMAC_SHA256",
  "metadataPolicy": "NONE"
}

Example Responses

201 400 401 403 408 422 500 502

{
  "id": 184094,
  "userId": 522078,
  "accountId": 257073,
  "url": "https://www.example.com",
  "status": "ACTIVE",
  "events": [
    "CALL"
  ],
  "signingAlgo": "HMAC_SHA256",
  "metadataPolicy": "NONE",
  "expireAt": "2019-01-01T00:00:00.000Z",
  "createdAt": "2019-01-01T00:00:00.000Z",
  "renewedAt": "2019-01-01T00:00:00.000Z",
  "purgeAt": "2019-01-01T00:00:00.000Z",
  "signingKey": "abc123",
  "statistics": {
    "totalAttempts": 10,
    "totalSuccesses": 10,
    "totalFailures": 10,
    "failed": false
  }
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

List web hooks

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/webhooks

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/webhooks

Responses

200 Successful

id

string

Unique identifier for the webhook

userId

string

Unique identifier of the user

accountId

string

Unique identifier of the account

url

string

Destination URL for events

status

string

Status for the webhook

One of: ACTIVE or PAUSED

events

array of strings

Subscribed events for the webhook

signingAlgo

string

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE

metadataPolicy

string

Metadata policy for the webhook

One of: NONE, HEADER or BODY

expireAt

string

Expiration time for the webhook

createdAt

string

Created time for the webhook

renewedAt

string

Last renewed time for the webhook

purgeAt

string

Scheduled purge time for the webhook

signingKey

string

Signing key for the webhook

statistics

object

integer

Total delivery attempts

integer

Total successful deliveries

integer

Total failed deliveries

boolean

Current delivery status

Example Responses

200 400 401 403 408 422 500 502

[
  {
    "id": 184094,
    "userId": 522078,
    "accountId": 257073,
    "url": "https://www.example.com",
    "status": "ACTIVE",
    "events": [
      "CALL"
    ],
    "signingAlgo": "HMAC_SHA256",
    "metadataPolicy": "NONE",
    "expireAt": "2019-01-01T00:00:00.000Z",
    "createdAt": "2019-01-01T00:00:00.000Z",
    "renewedAt": "2019-01-01T00:00:00.000Z",
    "purgeAt": "2019-01-01T00:00:00.000Z",
    "signingKey": "abc123",
    "statistics": {
      "totalAttempts": 10,
      "totalSuccesses": 10,
      "totalFailures": 10,
      "failed": false
    }
  }
]

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Get web hook details

GET


        https://api.vonage.com/t/vbc.prod/vis/v1/self/webhooks/:id

Host


        https://api.vonage.com

GET


        /t/vbc.prod/vis/v1/self/webhooks/:id

Path Parameters

id

string | Required

Unique identifier of the webhook

Responses

200 Successful

id

string

Unique identifier for the webhook

userId

string

Unique identifier of the user

accountId

string

Unique identifier of the account

url

string

Destination URL for events

status

string

Status for the webhook

One of: ACTIVE or PAUSED

events

array of strings

Subscribed events for the webhook

signingAlgo

string

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE

metadataPolicy

string

Metadata policy for the webhook

One of: NONE, HEADER or BODY

expireAt

string

Expiration time for the webhook

createdAt

string

Created time for the webhook

renewedAt

string

Last renewed time for the webhook

purgeAt

string

Scheduled purge time for the webhook

signingKey

string

Signing key for the webhook

statistics

object

integer

Total delivery attempts

integer

Total successful deliveries

integer

Total failed deliveries

boolean

Current delivery status

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 184094,
  "userId": 522078,
  "accountId": 257073,
  "url": "https://www.example.com",
  "status": "ACTIVE",
  "events": [
    "CALL"
  ],
  "signingAlgo": "HMAC_SHA256",
  "metadataPolicy": "NONE",
  "expireAt": "2019-01-01T00:00:00.000Z",
  "createdAt": "2019-01-01T00:00:00.000Z",
  "renewedAt": "2019-01-01T00:00:00.000Z",
  "purgeAt": "2019-01-01T00:00:00.000Z",
  "signingKey": "abc123",
  "statistics": {
    "totalAttempts": 10,
    "totalSuccesses": 10,
    "totalFailures": 10,
    "failed": false
  }
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Remove a web hook

DELETE


        https://api.vonage.com/t/vbc.prod/vis/v1/self/webhooks/:id

Host


        https://api.vonage.com

DELETE


        /t/vbc.prod/vis/v1/self/webhooks/:id

Path Parameters

id

string | Required

Unique identifier of the webhook

Example Responses

204 400 401 403 408 422 500 502

Successful

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Renews a web hook

PUT


        https://api.vonage.com/t/vbc.prod/vis/v1/self/webhooks/:id/renew

Host


        https://api.vonage.com

PUT


        /t/vbc.prod/vis/v1/self/webhooks/:id/renew

Path Parameters

id

string | Required

Webhook ID

Responses

200 Successful

id

string

Unique identifier for the webhook

userId

string

Unique identifier of the user

accountId

string

Unique identifier of the account

url

string

Destination URL for events

status

string

Status for the webhook

One of: ACTIVE or PAUSED

events

array of strings

Subscribed events for the webhook

signingAlgo

string

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE

metadataPolicy

string

Metadata policy for the webhook

One of: NONE, HEADER or BODY

expireAt

string

Expiration time for the webhook

createdAt

string

Created time for the webhook

renewedAt

string

Last renewed time for the webhook

purgeAt

string

Scheduled purge time for the webhook

signingKey

string

Signing key for the webhook

statistics

object

integer

Total delivery attempts

integer

Total successful deliveries

integer

Total failed deliveries

boolean

Current delivery status

Example Responses

200 400 401 403 408 422 500 502

{
  "id": 184094,
  "userId": 522078,
  "accountId": 257073,
  "url": "https://www.example.com",
  "status": "ACTIVE",
  "events": [
    "CALL"
  ],
  "signingAlgo": "HMAC_SHA256",
  "metadataPolicy": "NONE",
  "expireAt": "2019-01-01T00:00:00.000Z",
  "createdAt": "2019-01-01T00:00:00.000Z",
  "renewedAt": "2019-01-01T00:00:00.000Z",
  "purgeAt": "2019-01-01T00:00:00.000Z",
  "signingKey": "abc123",
  "statistics": {
    "totalAttempts": 10,
    "totalSuccesses": 10,
    "totalFailures": 10,
    "failed": false
  }
}

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}

This endpoint does not support application/json

Vonage Integration Platform

Jump to:

Users

Available Operations:

User info

Responses

Example Responses

Accounts

Available Operations:

Account info

Responses

Example Responses

Calls

Available Operations:

Place a call

Request body application/json

Responses

Example Request

Example Responses

List active calls

Query Parameter

Responses

Example Responses

Get calls count

Query Parameter

Responses

Example Responses

Get a call

Path Parameters

Responses

Example Responses

End a call

Path Parameters

Responses

Example Responses

Answer call (On supported devices)

Path Parameters

Responses

Example Responses

Put call on hold

Path Parameters

Responses

Example Responses

Unhold

Path Parameters

Responses

Example Responses

Send call to voicemail (not available for Vonage Business Enterprise (VBE) customers)

Path Parameters

Responses

Example Responses

Transfer call

Path Parameters

Request body application/json

Responses

Example Request

Example Responses

Events

Available Operations:

List events

Query Parameter

Responses

Example Responses

Get events count

Query Parameter

Responses

Example Responses

Get event

Path Parameters

Responses

Example Responses

Webhooks

Available Operations:

Create a new webhook subscription

Request body application/json

Responses

Example Request

Example Responses

List web hooks

Responses