API Dashboard
Vonage.com
Pricing
Support
Documentation
Blog
Code Hub

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 OpenAPI Specification

Users

Available Operations

User info

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

Responses
Content Type
application/json

Success

id
integer
example522078

Unique identifier of the user

accountId
integer
example257073

Unique identifier of the user's account

acountLabel
string
exampleVonage

The name of the user's account

firstName
string
exampleRobert

First name of the user

lastName
string
exampleSmith

Last name of the user

emailAddress
string
examplejohn.smith@example.com

Email address of the user

contactNumber
string
example14155550100

Contact number of the user

status
string
exampleACTIVE

Status of the user

Must be one of:PENDINGACTIVEDELETEDARCHIVED
ucis
array
id
integer(int64)
ucpLabel
string
health
object
status
string
message
string
type
string
DefaultUSER_UCI
roles
array
code
string
exampleAU

Code for the role

name
string
exampleAccount User

Name for the role

Example Response

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

Accounts

Available Operations

Account info

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

Responses
Content Type
application/json

Successful

id
integer
example257073

Unique identifier of the account

name
string
exampleVonage

Name of the account

org
string
exampleVonage

Organization of the account

ucis
array
id
integer(int64)
ucpLabel
string
ucpAccountId
string
health
object
status
string
message
string
type
string
DefaultACCOUNT_UCI
status
string
exampleACTIVE

Status of the account

Must be one of:PENDINGACTIVEDELETEDARCHIVED

Example Response

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

Calls

Available Operations

Place a call

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

Request Body
Content Type
application/json

phoneNumber
string
Required

Phone number to call

Example Request

{
   "phoneNumber": "string"
}

Responses
Content Type
application/json

Successful

array
id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

[
   {
      "id": 0,
      "externalId": "string",
      "type": "CALL",
      "accountId": 0,
      "userId": 0,
      "uciId": 0,
      "direction": "INBOUND",
      "callerId": "string",
      "phoneNumber": "string",
      "duration": 0,
      "state": "INITIALIZING",
      "startTime": "2019-08-24",
      "answerTime": "2019-08-24",
      "endTime": "2019-08-24"
   }
]

List active calls

Lists currently active calls

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

Query Parameters

direction
string
exampleINBOUND,OUTBOUND

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

Must be one of:INBOUNDOUTBOUND
offset
integer(int64)

Page number of calls to return

size
integer
Default20

Return this amount of calls in the response

order
string
DefaultDESC

Sort in either ascending or descending order

Must be one of:DESCASC

Responses
Content Type
application/json

Successful

array
id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

[
   {
      "id": 0,
      "externalId": "string",
      "type": "CALL",
      "accountId": 0,
      "userId": 0,
      "uciId": 0,
      "direction": "INBOUND",
      "callerId": "string",
      "phoneNumber": "string",
      "duration": 0,
      "state": "INITIALIZING",
      "startTime": "2019-08-24",
      "answerTime": "2019-08-24",
      "endTime": "2019-08-24"
   }
]

Get calls count

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

Query Parameters

fromDate
integer

Return calls that occurred after this point in time

toDate
integer

Return calls that occurred before this point in time

direction
string
exampleINBOUND,OUTBOUND

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

Must be one of:INBOUNDOUTBOUND
states
string
DefaultACTIVE
exampleACTIVE,RINGING

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

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Responses
Content Type
application/json

Successful

count
integer(int64)

Number of events found

Example Response

{
   "count": 0
}

Get a call

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

Path Parameters

id
string
Required

Unique identifier of the call

Responses
Content Type
application/json

Successful

array
id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

[
   {
      "id": 0,
      "externalId": "string",
      "type": "CALL",
      "accountId": 0,
      "userId": 0,
      "uciId": 0,
      "direction": "INBOUND",
      "callerId": "string",
      "phoneNumber": "string",
      "duration": 0,
      "state": "INITIALIZING",
      "startTime": "2019-08-24",
      "answerTime": "2019-08-24",
      "endTime": "2019-08-24"
   }
]

End a call

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

Path Parameters

id
string
Required

Unique identifier of the call

Responses
Content Type
application/json

Successful

array
id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

[
   {
      "id": 0,
      "externalId": "string",
      "type": "CALL",
      "accountId": 0,
      "userId": 0,
      "uciId": 0,
      "direction": "INBOUND",
      "callerId": "string",
      "phoneNumber": "string",
      "duration": 0,
      "state": "INITIALIZING",
      "startTime": "2019-08-24",
      "answerTime": "2019-08-24",
      "endTime": "2019-08-24"
   }
]

Answer call (On supported devices)

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

Path Parameters

id
string
Required

Unique identifier of the call

Responses
Content Type
application/json

Successful

id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

{
   "id": 0,
   "externalId": "string",
   "type": "CALL",
   "accountId": 0,
   "userId": 0,
   "uciId": 0,
   "direction": "INBOUND",
   "callerId": "string",
   "phoneNumber": "string",
   "duration": 0,
   "state": "INITIALIZING",
   "startTime": "2019-08-24",
   "answerTime": "2019-08-24",
   "endTime": "2019-08-24"
}

Put call on hold

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

Path Parameters

id
string
Required

Unique identifier of the call

Responses
Content Type
application/json

Successful

id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

{
   "id": 0,
   "externalId": "string",
   "type": "CALL",
   "accountId": 0,
   "userId": 0,
   "uciId": 0,
   "direction": "INBOUND",
   "callerId": "string",
   "phoneNumber": "string",
   "duration": 0,
   "state": "INITIALIZING",
   "startTime": "2019-08-24",
   "answerTime": "2019-08-24",
   "endTime": "2019-08-24"
}

Unhold

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

Path Parameters

id
string
Required

Unique identifier of the call

Responses
Content Type
application/json

Successful

id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

{
   "id": 0,
   "externalId": "string",
   "type": "CALL",
   "accountId": 0,
   "userId": 0,
   "uciId": 0,
   "direction": "INBOUND",
   "callerId": "string",
   "phoneNumber": "string",
   "duration": 0,
   "state": "INITIALIZING",
   "startTime": "2019-08-24",
   "answerTime": "2019-08-24",
   "endTime": "2019-08-24"
}

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

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

Path Parameters

id
string
Required

Unique identifier of the call

Responses
Content Type
application/json

Successful

id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

{
   "id": 0,
   "externalId": "string",
   "type": "CALL",
   "accountId": 0,
   "userId": 0,
   "uciId": 0,
   "direction": "INBOUND",
   "callerId": "string",
   "phoneNumber": "string",
   "duration": 0,
   "state": "INITIALIZING",
   "startTime": "2019-08-24",
   "answerTime": "2019-08-24",
   "endTime": "2019-08-24"
}

Transfer call

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

Path Parameters

id
string
Required

Unique identifier of the call

Request Body
Content Type
application/json

phoneNumber
string
Required

Phone number to transfer to

Example Request

{
   "phoneNumber": "string"
}

Responses
Content Type
application/json

Successful

id
integer(int64)
Required

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the call

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)
Required

Duration of the call in milliseconds

state
string
Required

Status of the call

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Example Response

{
   "id": 0,
   "externalId": "string",
   "type": "CALL",
   "accountId": 0,
   "userId": 0,
   "uciId": 0,
   "direction": "INBOUND",
   "callerId": "string",
   "phoneNumber": "string",
   "duration": 0,
   "state": "INITIALIZING",
   "startTime": "2019-08-24",
   "answerTime": "2019-08-24",
   "endTime": "2019-08-24"
}

Events

Available Operations

List events

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

Query Parameters

types
string
exampleCALL

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
exampleINBOUND,OUTBOUND

Filter by event direction

Must be one of:INBOUNDOUTBOUND
states
string
exampleACTIVE,RINGING

Filter events by state

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
offset
integer(int64)

Page number of events to return

size
integer
Default20

Return this amount of events in the response

order
string
DefaultASC

Sort in either ascending or descending order'

Must be one of:DESCASC
sort
string

Sort events by property

Responses
Content Type
application/json

Successful

array
id
integer(int64)
Required

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the event

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Required

Status of the event

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Example Response

[
   {
      "id": 0,
      "externalId": "string",
      "type": "CALL",
      "accountId": 0,
      "userId": 0,
      "uciId": 0,
      "direction": "INBOUND",
      "callerId": "string",
      "phoneNumber": "string",
      "duration": 0,
      "smsData": "string",
      "state": "INITIALIZING",
      "startTime": "2019-08-24",
      "answerTime": "2019-08-24",
      "endTime": "2019-08-24"
   }
]

Get events count

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

Query Parameters

fromDate
integer

Return events that occurred after this point in time

toDate
integer

Return events that occurred before this point in time

direction
string
exampleINBOUND,OUTBOUND

Filter by event direction

Must be one of:INBOUNDOUTBOUND
states
string
exampleACTIVE,RINGING

Filter events by state

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Responses
Content Type
application/json

Successful

count
integer(int64)

Number of events found

Example Response

{
   "count": 0
}

Get event

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

Path Parameters

id
string
Required

Unique identifier of the event

Responses
Content Type
application/json

Successful

array
id
integer(int64)
Required

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Required

Record type

Must be one of:CALL
accountId
integer(int64)
Required

Unique identifier of the account

userId
integer(int64)
Required

Unique identifier of the user

uciId
integer(int64)
Required

Unique identifier of communications provider

direction
string
Required

Direction of the event

Must be one of:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Required

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Required

Status of the event

Must be one of:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Required

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Example Response

[
   {
      "id": 0,
      "externalId": "string",
      "type": "CALL",
      "accountId": 0,
      "userId": 0,
      "uciId": 0,
      "direction": "INBOUND",
      "callerId": "string",
      "phoneNumber": "string",
      "duration": 0,
      "smsData": "string",
      "state": "INITIALIZING",
      "startTime": "2019-08-24",
      "answerTime": "2019-08-24",
      "endTime": "2019-08-24"
   }
]

Webhooks

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

Available Operations

Create a new webhook subscription

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

Request Body
Content Type
application/json

url
string
examplehttps://www.example.com

Destination URL for events

events
array

Events to subscribe to the webhook

signingAlgo
string
exampleHMAC_SHA256

Signing algorithm for the webhook

Must be one of:HMAC_SHA256
signingKey
string

Signing key for the webhook

metadataPolicy
string
exampleNONE

Metadata policy for the webhook

Must be one of:NONEHEADERBODY

Example Request

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

Responses
Content Type
application/json

Successful

id
string
example184094

Unique identifier for the webhook

userId
string
example522078

Unique identifier of the user

accountId
string
example257073

Unique identifier of the account

url
string
examplehttps://www.example.com

Destination URL for events

status
string
exampleACTIVE

Status for the webhook

Must be one of:ACTIVEPAUSED
events
array

Subscribed events for the webhook

signingAlgo
string
exampleHMAC_SHA256

Signing algorithm for the webhook

Must be one of:HMAC_SHA256NONE
metadataPolicy
string
exampleNONE

Metadata policy for the webhook

Must be one of:NONEHEADERBODY
expireAt
string
example2019-01-01T00:00:00.000Z

Expiration time for the webhook

createdAt
string
example2019-01-01T00:00:00.000Z

Created time for the webhook

renewedAt
string
example2019-01-01T00:00:00.000Z

Last renewed time for the webhook

purgeAt
string
example2019-01-01T00:00:00.000Z

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
example10

Total delivery attempts

totalSuccesses
integer
example10

Total successful deliveries

totalFailures
integer
example10

Total failed deliveries

failed
boolean

Current delivery status

Example Response

{
   "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": "string",
   "statistics": {
      "totalAttempts": 10,
      "totalSuccesses": 10,
      "totalFailures": 10,
      "failed": false
   }
}

List web hooks

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

Responses
Content Type
application/json

Successful

array
id
string
example184094

Unique identifier for the webhook

userId
string
example522078

Unique identifier of the user

accountId
string
example257073

Unique identifier of the account

url
string
examplehttps://www.example.com

Destination URL for events

status
string
exampleACTIVE

Status for the webhook

Must be one of:ACTIVEPAUSED
events
array

Subscribed events for the webhook

signingAlgo
string
exampleHMAC_SHA256

Signing algorithm for the webhook

Must be one of:HMAC_SHA256NONE
metadataPolicy
string
exampleNONE

Metadata policy for the webhook

Must be one of:NONEHEADERBODY
expireAt
string
example2019-01-01T00:00:00.000Z

Expiration time for the webhook

createdAt
string
example2019-01-01T00:00:00.000Z

Created time for the webhook

renewedAt
string
example2019-01-01T00:00:00.000Z

Last renewed time for the webhook

purgeAt
string
example2019-01-01T00:00:00.000Z

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
example10

Total delivery attempts

totalSuccesses
integer
example10

Total successful deliveries

totalFailures
integer
example10

Total failed deliveries

failed
boolean

Current delivery status

Example Response

[
   {
      "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": "string",
      "statistics": {
         "totalAttempts": 10,
         "totalSuccesses": 10,
         "totalFailures": 10,
         "failed": false
      }
   }
]

Get web hook details

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

Path Parameters

id
string
Required

Unique identifier of the webhook

Responses
Content Type
application/json

Successful

id
string
example184094

Unique identifier for the webhook

userId
string
example522078

Unique identifier of the user

accountId
string
example257073

Unique identifier of the account

url
string
examplehttps://www.example.com

Destination URL for events

status
string
exampleACTIVE

Status for the webhook

Must be one of:ACTIVEPAUSED
events
array

Subscribed events for the webhook

signingAlgo
string
exampleHMAC_SHA256

Signing algorithm for the webhook

Must be one of:HMAC_SHA256NONE
metadataPolicy
string
exampleNONE

Metadata policy for the webhook

Must be one of:NONEHEADERBODY
expireAt
string
example2019-01-01T00:00:00.000Z

Expiration time for the webhook

createdAt
string
example2019-01-01T00:00:00.000Z

Created time for the webhook

renewedAt
string
example2019-01-01T00:00:00.000Z

Last renewed time for the webhook

purgeAt
string
example2019-01-01T00:00:00.000Z

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
example10

Total delivery attempts

totalSuccesses
integer
example10

Total successful deliveries

totalFailures
integer
example10

Total failed deliveries

failed
boolean

Current delivery status

Example Response

{
   "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": "string",
   "statistics": {
      "totalAttempts": 10,
      "totalSuccesses": 10,
      "totalFailures": 10,
      "failed": false
   }
}

Remove a web hook

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

Path Parameters

id
string
Required

Unique identifier of the webhook

Responses

Successful

Renews a web hook

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

Path Parameters

id
string
Required

Webhook ID

Responses
Content Type
application/json

Successful

id
string
example184094

Unique identifier for the webhook

userId
string
example522078

Unique identifier of the user

accountId
string
example257073

Unique identifier of the account

url
string
examplehttps://www.example.com

Destination URL for events

status
string
exampleACTIVE

Status for the webhook

Must be one of:ACTIVEPAUSED
events
array

Subscribed events for the webhook

signingAlgo
string
exampleHMAC_SHA256

Signing algorithm for the webhook

Must be one of:HMAC_SHA256NONE
metadataPolicy
string
exampleNONE

Metadata policy for the webhook

Must be one of:NONEHEADERBODY
expireAt
string
example2019-01-01T00:00:00.000Z

Expiration time for the webhook

createdAt
string
example2019-01-01T00:00:00.000Z

Created time for the webhook

renewedAt
string
example2019-01-01T00:00:00.000Z

Last renewed time for the webhook

purgeAt
string
example2019-01-01T00:00:00.000Z

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
example10

Total delivery attempts

totalSuccesses
integer
example10

Total successful deliveries

totalFailures
integer
example10

Total failed deliveries

failed
boolean

Current delivery status

Example Response

{
   "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": "string",
   "statistics": {
      "totalAttempts": 10,
      "totalSuccesses": 10,
      "totalFailures": 10,
      "failed": false
   }
}