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
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
Field Description
id
integer
ucpLabel
string
health
object
Field Description
status
string
message
string
type
string
roles
array of objects
Field Description
code
string

Code for the role

name
string

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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

Accounts

Account info

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

View response field descriptions

Response Fields

Field Description
id
integer

Unique identifier of the account

name
string

Name of the account

org
string

Organization of the account

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

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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

Calls

Place a call

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

Request body application/json

Place call parameters

Key Description Example Default
phoneNumber
Required | string

Phone number to call

None None

View response field descriptions

Response Fields

Field Description
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

[
  {
    "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

[
  {
    "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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
integer

Number of events found

{
  "count": 1
}
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

[
  {
    "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

[
  {
    "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

{
  "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

{
  "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

{
  "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

{
  "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

Call transfer parameters

Key Description Example Default
phoneNumber
Required | string

Phone number to transfer to

None None

View response field descriptions

Response Fields

Field Description
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

{
  "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

[
  {
    "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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
integer

Number of events found

{
  "count": 1
}
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

[
  {
    "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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

Webhook create parameters

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

Field Description
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
Field Description
totalAttempts
integer

Total delivery attempts

totalSuccesses
integer

Total successful deliveries

totalFailures
integer

Total failed deliveries

failed
boolean

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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

List web hooks

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

View response field descriptions

Response Fields

Field Description
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

Field Description
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
Field Description
totalAttempts
integer

Total delivery attempts

totalSuccesses
integer

Total successful deliveries

totalFailures
integer

Total failed deliveries

failed
boolean

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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

Field Description
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
Field Description
totalAttempts
integer

Total delivery attempts

totalSuccesses
integer

Total successful deliveries

totalFailures
integer

Total failed deliveries

failed
boolean

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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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
Successful
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway

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

Field Description
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
Field Description
totalAttempts
integer

Total delivery attempts

totalSuccesses
integer

Total successful deliveries

totalFailures
integer

Total failed deliveries

failed
boolean

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"
    }
  ]
}
Unauthorized: Invalid access token
Forbidden: The user has no rights to access the resource(s)
Timeout: The client may repeat the request without modifications
{
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "errors": [
    {
      "field": "abc123",
      "message": "abc123"
    }
  ]
}
Internal Server Error
Bad Gateway