Vonage Integration Suite

Vonage Integration Suite

Users

User info

GET https://api.vonage.com/vgis/self

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the user

accountId

Unique identifier of the user's account

acountLabel

The name of the user's account

firstName

First name of the user

lastName

Last name of the user

emailAddress

Email address of the user

contactNumber

Contact number of the user

status

Status of the user

One of: PENDING, ACTIVE, DELETED or ARCHIVED
ucis
array of objects
Field Description
id
ucpLabel
health
Field Description
status
message
type
roles
array of objects
Field Description
code

Code for the role

name

Name for the role

{
  "id": 123456,
  "accountId": 123456,
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Accounts

Account info

GET https://api.vonage.com/vgis/self/account

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the account

name

Name of the account

org

Organization of the account

ucis
array of objects
Field Description
id
ucpLabel
ucpAccountId
health
Field Description
status
message
type
status

Status of the account

One of: PENDING, ACTIVE, DELETED or ARCHIVED
{
  "id": 123456,
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Calls

Place a call

POST https://api.vonage.com/vgis/self/calls

Request body application/json

Key Description Example Default
phoneNumber
Required | string

Phone number to call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

[
  {
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

List active calls

Lists currently active calls

GET https://api.vonage.com/vgis/self/calls

Query Parameter

Key Description Example Default
fromDate
integer

Return calls that occurred after this point in time

None None
toDate
integer

Return calls that occurred before this point in time

None None
direction
string

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


Must be one of: INBOUND or OUTBOUND
INBOUND,OUTBOUND None
states
string

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


Must be one of: INITIALIZING, RINGING, ACTIVE, HELD or REMOTE_HELD
ACTIVE,RINGING ACTIVE
offset
integer | (int64)

Page number of calls to return

None None
size
integer

Return this amount of calls in the response

None 20
order
string

Sort in either ascending or descending order


Must be one of: DESC or ASC
None ASC
sort
string

Sort calls by property

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

[
  {
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Get calls count

GET https://api.vonage.com/vgis/self/calls/count

Query Parameter

Key Description Example Default
fromDate
integer

Return calls that occurred after this point in time

None None
toDate
integer

Return calls that occurred before this point in time

None None
direction
string

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


Must be one of: INBOUND or OUTBOUND
INBOUND,OUTBOUND None
states
string

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


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

View response field descriptions

Response Fields

Field Description
count

Number of events found

{
  "count": 1
}
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Get a call

GET https://api.vonage.com/vgis/self/calls/{id}

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

[
  {
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

End a call

DELETE https://api.vonage.com/vgis/self/calls/{id}

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

[
  {
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Answer call (On supported devices)

PUT https://api.vonage.com/vgis/self/calls/{id}/answer

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

{
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Put call on hold

PUT https://api.vonage.com/vgis/self/calls/{id}/hold

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

{
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Unhold

DELETE https://api.vonage.com/vgis/self/calls/{id}/hold

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

{
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Send call to voicemail

PUT https://api.vonage.com/vgis/self/calls/{id}/vmtransfer

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

{
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Transfer call

POST https://api.vonage.com/vgis/self/calls/{id}/transfer

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the call

None None

Request body application/json

Key Description Example Default
phoneNumber
Required | string

Phone number to transfer to

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the call

externalId

External identifier of the call

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the call

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

state

Status of the call

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

Start time of the call

answerTime

Time to answer the call

endTime

End time of the call

{
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Events

List events

GET https://api.vonage.com/vgis/self/events

Query Parameter

Key Description Example Default
types
string

Record type


Must be one of: CALL
CALL None
fromDate
integer

Return events that occurred after this point in time

None None
toDate
integer

Return events that occurred before this point in time

None None
direction
string

Filter by event direction


Must be one of: INBOUND or OUTBOUND
INBOUND,OUTBOUND None
states
string

Filter events by state


Must be one of: INITIALIZING, RINGING, ACTIVE, HELD, REMOTE_HELD, DETACHED, REJECTED, CANCELLED, ANSWERED or MISSED
ACTIVE,RINGING None
offset
integer | (int64)

Page number of events to return

None None
size
integer

Return this amount of events in the response

None 20
order
string

Sort in either ascending or descending order'


Must be one of: DESC or ASC
None ASC
sort
string

Sort events by property

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the event

externalId

External identifier of the event

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the event

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

smsData
state

Status of the event

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

Start time of the event

answerTime

Time to answer the event

endTime

End time of the event

[
  {
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Get events count

GET https://api.vonage.com/vgis/self/events/count

Query Parameter

Key Description Example Default
fromDate
integer

Return events that occurred after this point in time

None None
toDate
integer

Return events that occurred before this point in time

None None
direction
string

Filter by event direction


Must be one of: INBOUND or OUTBOUND
INBOUND,OUTBOUND None
states
string

Filter events by state


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

View response field descriptions

Response Fields

Field Description
count

Number of events found

{
  "count": 1
}
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Get event

GET https://api.vonage.com/vgis/self/events/{id}

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the event

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier of the event

externalId

External identifier of the event

type

Record type

One of: CALL
accountId

Unique identifier of the account

userId

Unique identifier of the user

uciId

Unique identifier of communications provider

direction

Direction of the event

One of: INBOUND or OUTBOUND
callerId

Remote caller ID

phoneNumber

Unique identifier of the account

duration

Duration of the call in milliseconds

smsData
state

Status of the event

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

Start time of the event

answerTime

Time to answer the event

endTime

End time of the event

[
  {
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

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/vgis/self/webhooks

Request body application/json

Key Description Example Default
url
string

Destination URL for events

https://www.example.com None
events
array
of strings
None
signingAlgo
string

Signing algorithm for the webhook


Must be one of: HMAC_SHA256
HMAC_SHA256 None
signingKey
string

Signing key for the webhook

None None
metadataPolicy
string

Metadata policy for the webhook


Must be one of: NONE, HEADER or BODY
NONE None

View response field descriptions

Response Fields

Field Description
id

Unique identifier for the webhook

userId

Unique identifier of the user

accountId

Unique identifier of the account

url

Destination URL for events

status

Status for the webhook

One of: ACTIVE or PAUSED
events
array of strings

Subscribed events for the webhook

signingAlgo

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE
metadataPolicy

Metadata policy for the webhook

One of: NONE, HEADER or BODY
expireAt

Expiration time for the webhook

createdAt

Created time for the webhook

renewedAt

Last renewed time for the webhook

purgeAt

Scheduled purge time for the webhook

signingKey

Signing key for the webhook

statistics
Field Description
totalAttempts

Total delivery attempts

totalSuccesses

Total successful deliveries

totalFailures

Total failed deliveries

failed

Current delivery status

{
  "id": 123456,
  "userId": 123456,
  "accountId": 123456,
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

List web hooks

GET https://api.vonage.com/vgis/self/webhooks

View response field descriptions

Response Fields

Field Description
id

Unique identifier for the webhook

userId

Unique identifier of the user

accountId

Unique identifier of the account

url

Destination URL for events

status

Status for the webhook

One of: ACTIVE or PAUSED
events
array of strings

Subscribed events for the webhook

signingAlgo

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE
metadataPolicy

Metadata policy for the webhook

One of: NONE, HEADER or BODY
expireAt

Expiration time for the webhook

createdAt

Created time for the webhook

renewedAt

Last renewed time for the webhook

purgeAt

Scheduled purge time for the webhook

signingKey

Signing key for the webhook

statistics
Field Description
totalAttempts

Total delivery attempts

totalSuccesses

Total successful deliveries

totalFailures

Total failed deliveries

failed

Current delivery status

[
  {
    "id": 123456,
    "userId": 123456,
    "accountId": 123456,
    "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Get web hook details

GET https://api.vonage.com/vgis/self/webhooks/{id}

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the webhook

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier for the webhook

userId

Unique identifier of the user

accountId

Unique identifier of the account

url

Destination URL for events

status

Status for the webhook

One of: ACTIVE or PAUSED
events
array of strings

Subscribed events for the webhook

signingAlgo

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE
metadataPolicy

Metadata policy for the webhook

One of: NONE, HEADER or BODY
expireAt

Expiration time for the webhook

createdAt

Created time for the webhook

renewedAt

Last renewed time for the webhook

purgeAt

Scheduled purge time for the webhook

signingKey

Signing key for the webhook

statistics
Field Description
totalAttempts

Total delivery attempts

totalSuccesses

Total successful deliveries

totalFailures

Total failed deliveries

failed

Current delivery status

{
  "id": 123456,
  "userId": 123456,
  "accountId": 123456,
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content

Remove a web hook

DELETE https://api.vonage.com/vgis/self/webhooks/{id}

Path Parameters

Key Description Example Default
id
Required | string

Unique identifier of the webhook

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

Renews a web hook

PUT https://api.vonage.com/vgis/self/webhooks/{id}/renew

Path Parameters

Key Description Example Default
id
Required | string

Webhook ID

None None

View response field descriptions

Response Fields

Field Description
id

Unique identifier for the webhook

userId

Unique identifier of the user

accountId

Unique identifier of the account

url

Destination URL for events

status

Status for the webhook

One of: ACTIVE or PAUSED
events
array of strings

Subscribed events for the webhook

signingAlgo

Signing algorithm for the webhook

One of: HMAC_SHA256 or NONE
metadataPolicy

Metadata policy for the webhook

One of: NONE, HEADER or BODY
expireAt

Expiration time for the webhook

createdAt

Created time for the webhook

renewedAt

Last renewed time for the webhook

purgeAt

Scheduled purge time for the webhook

signingKey

Signing key for the webhook

statistics
Field Description
totalAttempts

Total delivery attempts

totalSuccesses

Total successful deliveries

totalFailures

Total failed deliveries

failed

Current delivery status

{
  "id": 123456,
  "userId": 123456,
  "accountId": 123456,
  "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"
    }
  ]
}
No content
No content
No content
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
No content
No content