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.

Descargar la especificación OpenAPI

Users

Operaciones disponibles

User info

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

Respuestas
Tipo de contenido
application/json

Success

id
integer
ejemplo522078

Unique identifier of the user

accountId
integer
ejemplo257073

Unique identifier of the user's account

acountLabel
string
ejemploVonage

The name of the user's account

firstName
string
ejemploRobert

First name of the user

lastName
string
ejemploSmith

Last name of the user

emailAddress
string
ejemplojohn.smith@example.com

Email address of the user

contactNumber
string
ejemplo14155550100

Contact number of the user

status
string
ejemploACTIVE

Status of the user

Debe ser uno de:PENDINGACTIVEDELETEDARCHIVED
ucis
array
id
integer(int64)
ucpLabel
string
health
object
status
string
message
string
type
string
Por defectoUSER_UCI
roles
array
code
string
ejemploAU

Code for the role

name
string
ejemploAccount User

Name for the role

Ejemplo Respuesta

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

Operaciones disponibles

Account info

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

Respuestas
Tipo de contenido
application/json

Successful

id
integer
ejemplo257073

Unique identifier of the account

name
string
ejemploVonage

Name of the account

org
string
ejemploVonage

Organization of the account

ucis
array
id
integer(int64)
ucpLabel
string
ucpAccountId
string
health
object
status
string
message
string
type
string
Por defectoACCOUNT_UCI
status
string
ejemploACTIVE

Status of the account

Debe ser uno de:PENDINGACTIVEDELETEDARCHIVED

Ejemplo Respuesta

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

Calls

Operaciones disponibles

Place a call

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

Cuerpo de la solicitud
Tipo de contenido
application/json

phoneNumber
string
Requerido

Phone number to call

Ejemplo Solicitar

{
   "phoneNumber": "string"
}

Respuestas
Tipo de contenido
application/json

Successful

array
id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Consulta Parámetros

direction
string
ejemploINBOUND,OUTBOUND

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

Debe ser uno de:INBOUNDOUTBOUND
offset
integer(int64)

Page number of calls to return

size
integer
Por defecto20

Return this amount of calls in the response

order
string
Por defectoDESC

Sort in either ascending or descending order

Debe ser uno de:DESCASC

Respuestas
Tipo de contenido
application/json

Successful

array
id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Consulta Parámetros

fromDate
integer

Return calls that occurred after this point in time

toDate
integer

Return calls that occurred before this point in time

direction
string
ejemploINBOUND,OUTBOUND

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

Debe ser uno de:INBOUNDOUTBOUND
states
string
Por defectoACTIVE
ejemploACTIVE,RINGING

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

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Respuestas
Tipo de contenido
application/json

Successful

count
integer(int64)

Number of events found

Ejemplo Respuesta

{
   "count": 0
}

Get a call

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Respuestas
Tipo de contenido
application/json

Successful

array
id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Respuestas
Tipo de contenido
application/json

Successful

array
id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Respuestas
Tipo de contenido
application/json

Successful

id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Respuestas
Tipo de contenido
application/json

Successful

id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Respuestas
Tipo de contenido
application/json

Successful

id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Respuestas
Tipo de contenido
application/json

Successful

id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the call

Cuerpo de la solicitud
Tipo de contenido
application/json

phoneNumber
string
Requerido

Phone number to transfer to

Ejemplo Solicitar

{
   "phoneNumber": "string"
}

Respuestas
Tipo de contenido
application/json

Successful

id
integer(int64)
Requerido

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the call

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)
Requerido

Duration of the call in milliseconds

state
string
Requerido

Status of the call

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Ejemplo Respuesta

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

Operaciones disponibles

List events

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

Consulta Parámetros

types
string
ejemploCALL

Record type

Debe ser uno de: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
ejemploINBOUND,OUTBOUND

Filter by event direction

Debe ser uno de:INBOUNDOUTBOUND
states
string
ejemploACTIVE,RINGING

Filter events by state

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
offset
integer(int64)

Page number of events to return

size
integer
Por defecto20

Return this amount of events in the response

order
string
Por defectoASC

Sort in either ascending or descending order'

Debe ser uno de:DESCASC
sort
string

Sort events by property

Respuestas
Tipo de contenido
application/json

Successful

array
id
integer(int64)
Requerido

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the event

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Requerido

Status of the event

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Ejemplo Respuesta

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

Consulta Parámetros

fromDate
integer

Return events that occurred after this point in time

toDate
integer

Return events that occurred before this point in time

direction
string
ejemploINBOUND,OUTBOUND

Filter by event direction

Debe ser uno de:INBOUNDOUTBOUND
states
string
ejemploACTIVE,RINGING

Filter events by state

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Respuestas
Tipo de contenido
application/json

Successful

count
integer(int64)

Number of events found

Ejemplo Respuesta

{
   "count": 0
}

Get event

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the event

Respuestas
Tipo de contenido
application/json

Successful

array
id
integer(int64)
Requerido

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Requerido

Record type

Debe ser uno de:CALL
accountId
integer(int64)
Requerido

Unique identifier of the account

userId
integer(int64)
Requerido

Unique identifier of the user

uciId
integer(int64)
Requerido

Unique identifier of communications provider

direction
string
Requerido

Direction of the event

Debe ser uno de:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Requerido

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Requerido

Status of the event

Debe ser uno de:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Requerido

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Ejemplo Respuesta

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

Operaciones disponibles

Create a new webhook subscription

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

Cuerpo de la solicitud
Tipo de contenido
application/json

url
string
ejemplohttps://www.example.com

Destination URL for events

events
array

Events to subscribe to the webhook

Valores disponibles:
CALL
signingAlgo
string
ejemploHMAC_SHA256

Signing algorithm for the webhook

Debe ser uno de:HMAC_SHA256
signingKey
string

Signing key for the webhook

metadataPolicy
string
ejemploNONE

Metadata policy for the webhook

Debe ser uno de:NONEHEADERBODY

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

Successful

id
string
ejemplo184094

Unique identifier for the webhook

userId
string
ejemplo522078

Unique identifier of the user

accountId
string
ejemplo257073

Unique identifier of the account

url
string
ejemplohttps://www.example.com

Destination URL for events

status
string
ejemploACTIVE

Status for the webhook

Debe ser uno de:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponibles:
CALL
signingAlgo
string
ejemploHMAC_SHA256

Signing algorithm for the webhook

Debe ser uno de:HMAC_SHA256NONE
metadataPolicy
string
ejemploNONE

Metadata policy for the webhook

Debe ser uno de:NONEHEADERBODY
expireAt
string
ejemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
ejemplo10

Total delivery attempts

totalSuccesses
integer
ejemplo10

Total successful deliveries

totalFailures
integer
ejemplo10

Total failed deliveries

failed
boolean

Current delivery status

Ejemplo Respuesta

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

Respuestas
Tipo de contenido
application/json

Successful

array
id
string
ejemplo184094

Unique identifier for the webhook

userId
string
ejemplo522078

Unique identifier of the user

accountId
string
ejemplo257073

Unique identifier of the account

url
string
ejemplohttps://www.example.com

Destination URL for events

status
string
ejemploACTIVE

Status for the webhook

Debe ser uno de:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponibles:
CALL
signingAlgo
string
ejemploHMAC_SHA256

Signing algorithm for the webhook

Debe ser uno de:HMAC_SHA256NONE
metadataPolicy
string
ejemploNONE

Metadata policy for the webhook

Debe ser uno de:NONEHEADERBODY
expireAt
string
ejemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
ejemplo10

Total delivery attempts

totalSuccesses
integer
ejemplo10

Total successful deliveries

totalFailures
integer
ejemplo10

Total failed deliveries

failed
boolean

Current delivery status

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the webhook

Respuestas
Tipo de contenido
application/json

Successful

id
string
ejemplo184094

Unique identifier for the webhook

userId
string
ejemplo522078

Unique identifier of the user

accountId
string
ejemplo257073

Unique identifier of the account

url
string
ejemplohttps://www.example.com

Destination URL for events

status
string
ejemploACTIVE

Status for the webhook

Debe ser uno de:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponibles:
CALL
signingAlgo
string
ejemploHMAC_SHA256

Signing algorithm for the webhook

Debe ser uno de:HMAC_SHA256NONE
metadataPolicy
string
ejemploNONE

Metadata policy for the webhook

Debe ser uno de:NONEHEADERBODY
expireAt
string
ejemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
ejemplo10

Total delivery attempts

totalSuccesses
integer
ejemplo10

Total successful deliveries

totalFailures
integer
ejemplo10

Total failed deliveries

failed
boolean

Current delivery status

Ejemplo Respuesta

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

Ruta Parámetros

id
string
Requerido

Unique identifier of the webhook

Respuestas

Successful

Renews a web hook

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

Ruta Parámetros

id
string
Requerido

Webhook ID

Respuestas
Tipo de contenido
application/json

Successful

id
string
ejemplo184094

Unique identifier for the webhook

userId
string
ejemplo522078

Unique identifier of the user

accountId
string
ejemplo257073

Unique identifier of the account

url
string
ejemplohttps://www.example.com

Destination URL for events

status
string
ejemploACTIVE

Status for the webhook

Debe ser uno de:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponibles:
CALL
signingAlgo
string
ejemploHMAC_SHA256

Signing algorithm for the webhook

Debe ser uno de:HMAC_SHA256NONE
metadataPolicy
string
ejemploNONE

Metadata policy for the webhook

Debe ser uno de:NONEHEADERBODY
expireAt
string
ejemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
ejemplo10

Total delivery attempts

totalSuccesses
integer
ejemplo10

Total successful deliveries

totalFailures
integer
ejemplo10

Total failed deliveries

failed
boolean

Current delivery status

Ejemplo Respuesta

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