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.

OpenAPI-Spezifikation herunterladen

Users

Verfügbare Operationen

User info

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

Antworten
Inhalt Typ
application/json

Success

id
integer
Beispiel522078

Unique identifier of the user

accountId
integer
Beispiel257073

Unique identifier of the user's account

acountLabel
string
BeispielVonage

The name of the user's account

firstName
string
BeispielRobert

First name of the user

lastName
string
BeispielSmith

Last name of the user

emailAddress
string
Beispieljohn.smith@example.com

Email address of the user

contactNumber
string
Beispiel14155550100

Contact number of the user

status
string
BeispielACTIVE

Status of the user

Muss eines der folgenden sein:PENDINGACTIVEDELETEDARCHIVED
ucis
array
id
integer(int64)
ucpLabel
string
health
object
status
string
message
string
type
string
StandardUSER_UCI
roles
array
code
string
BeispielAU

Code for the role

name
string
BeispielAccount User

Name for the role

Beispiel Antwort

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

Verfügbare Operationen

Account info

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

Antworten
Inhalt Typ
application/json

Successful

id
integer
Beispiel257073

Unique identifier of the account

name
string
BeispielVonage

Name of the account

org
string
BeispielVonage

Organization of the account

ucis
array
id
integer(int64)
ucpLabel
string
ucpAccountId
string
health
object
status
string
message
string
type
string
StandardACCOUNT_UCI
status
string
BeispielACTIVE

Status of the account

Muss eines der folgenden sein:PENDINGACTIVEDELETEDARCHIVED

Beispiel Antwort

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

Calls

Verfügbare Operationen

Place a call

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

Anfrage Körper
Inhalt Typ
application/json

phoneNumber
string
Erforderlich

Phone number to call

Beispiel Anfrage

{
   "phoneNumber": "string"
}

Antworten
Inhalt Typ
application/json

Successful

array
id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

[
   {
      "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

Abfrage Parameter

direction
string
BeispielINBOUND,OUTBOUND

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

Muss eines der folgenden sein:INBOUNDOUTBOUND
offset
integer(int64)

Page number of calls to return

size
integer
Standard20

Return this amount of calls in the response

order
string
StandardDESC

Sort in either ascending or descending order

Muss eines der folgenden sein:DESCASC

Antworten
Inhalt Typ
application/json

Successful

array
id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

[
   {
      "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

Abfrage Parameter

fromDate
integer

Return calls that occurred after this point in time

toDate
integer

Return calls that occurred before this point in time

direction
string
BeispielINBOUND,OUTBOUND

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

Muss eines der folgenden sein:INBOUNDOUTBOUND
states
string
StandardACTIVE
BeispielACTIVE,RINGING

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

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Antworten
Inhalt Typ
application/json

Successful

count
integer(int64)

Number of events found

Beispiel Antwort

{
   "count": 0
}

Get a call

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Antworten
Inhalt Typ
application/json

Successful

array
id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

[
   {
      "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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Antworten
Inhalt Typ
application/json

Successful

array
id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

[
   {
      "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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Antworten
Inhalt Typ
application/json

Successful

id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Antworten
Inhalt Typ
application/json

Successful

id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Antworten
Inhalt Typ
application/json

Successful

id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Antworten
Inhalt Typ
application/json

Successful

id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the call

Anfrage Körper
Inhalt Typ
application/json

phoneNumber
string
Erforderlich

Phone number to transfer to

Beispiel Anfrage

{
   "phoneNumber": "string"
}

Antworten
Inhalt Typ
application/json

Successful

id
integer(int64)
Erforderlich

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the call

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)
Erforderlich

Duration of the call in milliseconds

state
string
Erforderlich

Status of the call

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Beispiel Antwort

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

Verfügbare Operationen

List events

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

Abfrage Parameter

types
string
BeispielCALL

Record type

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

Filter by event direction

Muss eines der folgenden sein:INBOUNDOUTBOUND
states
string
BeispielACTIVE,RINGING

Filter events by state

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
offset
integer(int64)

Page number of events to return

size
integer
Standard20

Return this amount of events in the response

order
string
StandardASC

Sort in either ascending or descending order'

Muss eines der folgenden sein:DESCASC
sort
string

Sort events by property

Antworten
Inhalt Typ
application/json

Successful

array
id
integer(int64)
Erforderlich

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the event

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Erforderlich

Status of the event

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Beispiel Antwort

[
   {
      "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

Abfrage Parameter

fromDate
integer

Return events that occurred after this point in time

toDate
integer

Return events that occurred before this point in time

direction
string
BeispielINBOUND,OUTBOUND

Filter by event direction

Muss eines der folgenden sein:INBOUNDOUTBOUND
states
string
BeispielACTIVE,RINGING

Filter events by state

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Antworten
Inhalt Typ
application/json

Successful

count
integer(int64)

Number of events found

Beispiel Antwort

{
   "count": 0
}

Get event

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the event

Antworten
Inhalt Typ
application/json

Successful

array
id
integer(int64)
Erforderlich

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Erforderlich

Record type

Muss eines der folgenden sein:CALL
accountId
integer(int64)
Erforderlich

Unique identifier of the account

userId
integer(int64)
Erforderlich

Unique identifier of the user

uciId
integer(int64)
Erforderlich

Unique identifier of communications provider

direction
string
Erforderlich

Direction of the event

Muss eines der folgenden sein:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Erforderlich

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Erforderlich

Status of the event

Muss eines der folgenden sein:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Erforderlich

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Beispiel Antwort

[
   {
      "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.

Verfügbare Operationen

Create a new webhook subscription

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

Anfrage Körper
Inhalt Typ
application/json

url
string
Beispielhttps://www.example.com

Destination URL for events

events
array

Events to subscribe to the webhook

Verfügbare Werte:
CALL
signingAlgo
string
BeispielHMAC_SHA256

Signing algorithm for the webhook

Muss eines der folgenden sein:HMAC_SHA256
signingKey
string

Signing key for the webhook

metadataPolicy
string
BeispielNONE

Metadata policy for the webhook

Muss eines der folgenden sein:NONEHEADERBODY

Beispiel Anfrage

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

Antworten
Inhalt Typ
application/json

Successful

id
string
Beispiel184094

Unique identifier for the webhook

userId
string
Beispiel522078

Unique identifier of the user

accountId
string
Beispiel257073

Unique identifier of the account

url
string
Beispielhttps://www.example.com

Destination URL for events

status
string
BeispielACTIVE

Status for the webhook

Muss eines der folgenden sein:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Verfügbare Werte:
CALL
signingAlgo
string
BeispielHMAC_SHA256

Signing algorithm for the webhook

Muss eines der folgenden sein:HMAC_SHA256NONE
metadataPolicy
string
BeispielNONE

Metadata policy for the webhook

Muss eines der folgenden sein:NONEHEADERBODY
expireAt
string
Beispiel2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
Beispiel10

Total delivery attempts

totalSuccesses
integer
Beispiel10

Total successful deliveries

totalFailures
integer
Beispiel10

Total failed deliveries

failed
boolean

Current delivery status

Beispiel Antwort

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

Antworten
Inhalt Typ
application/json

Successful

array
id
string
Beispiel184094

Unique identifier for the webhook

userId
string
Beispiel522078

Unique identifier of the user

accountId
string
Beispiel257073

Unique identifier of the account

url
string
Beispielhttps://www.example.com

Destination URL for events

status
string
BeispielACTIVE

Status for the webhook

Muss eines der folgenden sein:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Verfügbare Werte:
CALL
signingAlgo
string
BeispielHMAC_SHA256

Signing algorithm for the webhook

Muss eines der folgenden sein:HMAC_SHA256NONE
metadataPolicy
string
BeispielNONE

Metadata policy for the webhook

Muss eines der folgenden sein:NONEHEADERBODY
expireAt
string
Beispiel2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
Beispiel10

Total delivery attempts

totalSuccesses
integer
Beispiel10

Total successful deliveries

totalFailures
integer
Beispiel10

Total failed deliveries

failed
boolean

Current delivery status

Beispiel Antwort

[
   {
      "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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the webhook

Antworten
Inhalt Typ
application/json

Successful

id
string
Beispiel184094

Unique identifier for the webhook

userId
string
Beispiel522078

Unique identifier of the user

accountId
string
Beispiel257073

Unique identifier of the account

url
string
Beispielhttps://www.example.com

Destination URL for events

status
string
BeispielACTIVE

Status for the webhook

Muss eines der folgenden sein:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Verfügbare Werte:
CALL
signingAlgo
string
BeispielHMAC_SHA256

Signing algorithm for the webhook

Muss eines der folgenden sein:HMAC_SHA256NONE
metadataPolicy
string
BeispielNONE

Metadata policy for the webhook

Muss eines der folgenden sein:NONEHEADERBODY
expireAt
string
Beispiel2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
Beispiel10

Total delivery attempts

totalSuccesses
integer
Beispiel10

Total successful deliveries

totalFailures
integer
Beispiel10

Total failed deliveries

failed
boolean

Current delivery status

Beispiel Antwort

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

Pfad Parameter

id
string
Erforderlich

Unique identifier of the webhook

Antworten

Successful

Renews a web hook

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

Pfad Parameter

id
string
Erforderlich

Webhook ID

Antworten
Inhalt Typ
application/json

Successful

id
string
Beispiel184094

Unique identifier for the webhook

userId
string
Beispiel522078

Unique identifier of the user

accountId
string
Beispiel257073

Unique identifier of the account

url
string
Beispielhttps://www.example.com

Destination URL for events

status
string
BeispielACTIVE

Status for the webhook

Muss eines der folgenden sein:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Verfügbare Werte:
CALL
signingAlgo
string
BeispielHMAC_SHA256

Signing algorithm for the webhook

Muss eines der folgenden sein:HMAC_SHA256NONE
metadataPolicy
string
BeispielNONE

Metadata policy for the webhook

Muss eines der folgenden sein:NONEHEADERBODY
expireAt
string
Beispiel2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
Beispiel10

Total delivery attempts

totalSuccesses
integer
Beispiel10

Total successful deliveries

totalFailures
integer
Beispiel10

Total failed deliveries

failed
boolean

Current delivery status

Beispiel Antwort

{
   "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
   }
}