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.

Baixar a especificação OpenAPI

Users

Operações disponíveis

User info

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

Respostas
Tipo de conteúdo
application/json

Success

id
integer
exemplo522078

Unique identifier of the user

accountId
integer
exemplo257073

Unique identifier of the user's account

acountLabel
string
exemploVonage

The name of the user's account

firstName
string
exemploRobert

First name of the user

lastName
string
exemploSmith

Last name of the user

emailAddress
string
exemplojohn.smith@example.com

Email address of the user

contactNumber
string
exemplo14155550100

Contact number of the user

status
string
exemploACTIVE

Status of the user

Deve ser uma das seguintes opções:PENDINGACTIVEDELETEDARCHIVED
ucis
array
id
integer(int64)
ucpLabel
string
health
object
status
string
message
string
type
string
PadrãoUSER_UCI
roles
array
code
string
exemploAU

Code for the role

name
string
exemploAccount User

Name for the role

Exemplo Resposta

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

Operações disponíveis

Account info

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

Respostas
Tipo de conteúdo
application/json

Successful

id
integer
exemplo257073

Unique identifier of the account

name
string
exemploVonage

Name of the account

org
string
exemploVonage

Organization of the account

ucis
array
id
integer(int64)
ucpLabel
string
ucpAccountId
string
health
object
status
string
message
string
type
string
PadrãoACCOUNT_UCI
status
string
exemploACTIVE

Status of the account

Deve ser uma das seguintes opções:PENDINGACTIVEDELETEDARCHIVED

Exemplo Resposta

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

Calls

Operações disponíveis

Place a call

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

Corpo da solicitação
Tipo de conteúdo
application/json

phoneNumber
string
Obrigatório

Phone number to call

Exemplo Solicitação

{
   "phoneNumber": "string"
}
{
   "phoneNumber": "string"
}

Respostas
Tipo de conteúdo
application/json

Successful

array
id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

[
   {
      "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
exemploINBOUND,OUTBOUND

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

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
offset
integer(int64)

Page number of calls to return

size
integer
Padrão20

Return this amount of calls in the response

order
string
PadrãoDESC

Sort in either ascending or descending order

Deve ser uma das seguintes opções:DESCASC

Respostas
Tipo de conteúdo
application/json

Successful

array
id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

[
   {
      "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
exemploINBOUND,OUTBOUND

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

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
states
string
PadrãoACTIVE
exemploACTIVE,RINGING

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

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Respostas
Tipo de conteúdo
application/json

Successful

count
integer(int64)

Number of events found

Exemplo Resposta

{
   "count": 0
}

Get a call

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Respostas
Tipo de conteúdo
application/json

Successful

array
id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Respostas
Tipo de conteúdo
application/json

Successful

array
id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Respostas
Tipo de conteúdo
application/json

Successful

id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Respostas
Tipo de conteúdo
application/json

Successful

id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Respostas
Tipo de conteúdo
application/json

Successful

id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Respostas
Tipo de conteúdo
application/json

Successful

id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the call

Corpo da solicitação
Tipo de conteúdo
application/json

phoneNumber
string
Obrigatório

Phone number to transfer to

Exemplo Solicitação

{
   "phoneNumber": "string"
}
{
   "phoneNumber": "string"
}

Respostas
Tipo de conteúdo
application/json

Successful

id
integer(int64)
Obrigatório

Unique identifier of the call

externalId
string

External identifier of the call

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the call

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)
Obrigatório

Duration of the call in milliseconds

state
string
Obrigatório

Status of the call

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the call

answerTime
string(date)

Time to answer the call

endTime
string(date)

End time of the call

Exemplo Resposta

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

Operações disponíveis

List events

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

Consulta Parâmetros

types
string
exemploCALL

Record type

Deve ser uma das seguintes opções: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
exemploINBOUND,OUTBOUND

Filter by event direction

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
states
string
exemploACTIVE,RINGING

Filter events by state

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
offset
integer(int64)

Page number of events to return

size
integer
Padrão20

Return this amount of events in the response

order
string
PadrãoASC

Sort in either ascending or descending order'

Deve ser uma das seguintes opções:DESCASC
sort
string

Sort events by property

Respostas
Tipo de conteúdo
application/json

Successful

array
id
integer(int64)
Obrigatório

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the event

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Obrigatório

Status of the event

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Exemplo Resposta

[
   {
      "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
exemploINBOUND,OUTBOUND

Filter by event direction

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
states
string
exemploACTIVE,RINGING

Filter events by state

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELD

Respostas
Tipo de conteúdo
application/json

Successful

count
integer(int64)

Number of events found

Exemplo Resposta

{
   "count": 0
}

Get event

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the event

Respostas
Tipo de conteúdo
application/json

Successful

array
id
integer(int64)
Obrigatório

Unique identifier of the event

externalId
string

External identifier of the event

type
string
Obrigatório

Record type

Deve ser uma das seguintes opções:CALL
accountId
integer(int64)
Obrigatório

Unique identifier of the account

userId
integer(int64)
Obrigatório

Unique identifier of the user

uciId
integer(int64)
Obrigatório

Unique identifier of communications provider

direction
string
Obrigatório

Direction of the event

Deve ser uma das seguintes opções:INBOUNDOUTBOUND
callerId
string

Remote caller ID

phoneNumber
string
Obrigatório

Unique identifier of the account

duration
integer(int64)

Duration of the call in milliseconds

smsData
string
state
string
Obrigatório

Status of the event

Deve ser uma das seguintes opções:INITIALIZINGRINGINGACTIVEHELDREMOTE_HELDDETACHEDREJECTEDCANCELLEDANSWEREDMISSED
startTime
string(date)
Obrigatório

Start time of the event

answerTime
string(date)

Time to answer the event

endTime
string(date)

End time of the event

Exemplo Resposta

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

Operações disponíveis

Create a new webhook subscription

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

Corpo da solicitação
Tipo de conteúdo
application/json

url
string
exemplohttps://www.example.com

Destination URL for events

events
array

Events to subscribe to the webhook

Valores disponíveis:
CALL
signingAlgo
string
exemploHMAC_SHA256

Signing algorithm for the webhook

Deve ser uma das seguintes opções:HMAC_SHA256
signingKey
string

Signing key for the webhook

metadataPolicy
string
exemploNONE

Metadata policy for the webhook

Deve ser uma das seguintes opções:NONEHEADERBODY

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

Successful

id
string
exemplo184094

Unique identifier for the webhook

userId
string
exemplo522078

Unique identifier of the user

accountId
string
exemplo257073

Unique identifier of the account

url
string
exemplohttps://www.example.com

Destination URL for events

status
string
exemploACTIVE

Status for the webhook

Deve ser uma das seguintes opções:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponíveis:
CALL
signingAlgo
string
exemploHMAC_SHA256

Signing algorithm for the webhook

Deve ser uma das seguintes opções:HMAC_SHA256NONE
metadataPolicy
string
exemploNONE

Metadata policy for the webhook

Deve ser uma das seguintes opções:NONEHEADERBODY
expireAt
string
exemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
exemplo10

Total delivery attempts

totalSuccesses
integer
exemplo10

Total successful deliveries

totalFailures
integer
exemplo10

Total failed deliveries

failed
boolean

Current delivery status

Exemplo Resposta

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

Respostas
Tipo de conteúdo
application/json

Successful

array
id
string
exemplo184094

Unique identifier for the webhook

userId
string
exemplo522078

Unique identifier of the user

accountId
string
exemplo257073

Unique identifier of the account

url
string
exemplohttps://www.example.com

Destination URL for events

status
string
exemploACTIVE

Status for the webhook

Deve ser uma das seguintes opções:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponíveis:
CALL
signingAlgo
string
exemploHMAC_SHA256

Signing algorithm for the webhook

Deve ser uma das seguintes opções:HMAC_SHA256NONE
metadataPolicy
string
exemploNONE

Metadata policy for the webhook

Deve ser uma das seguintes opções:NONEHEADERBODY
expireAt
string
exemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
exemplo10

Total delivery attempts

totalSuccesses
integer
exemplo10

Total successful deliveries

totalFailures
integer
exemplo10

Total failed deliveries

failed
boolean

Current delivery status

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the webhook

Respostas
Tipo de conteúdo
application/json

Successful

id
string
exemplo184094

Unique identifier for the webhook

userId
string
exemplo522078

Unique identifier of the user

accountId
string
exemplo257073

Unique identifier of the account

url
string
exemplohttps://www.example.com

Destination URL for events

status
string
exemploACTIVE

Status for the webhook

Deve ser uma das seguintes opções:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponíveis:
CALL
signingAlgo
string
exemploHMAC_SHA256

Signing algorithm for the webhook

Deve ser uma das seguintes opções:HMAC_SHA256NONE
metadataPolicy
string
exemploNONE

Metadata policy for the webhook

Deve ser uma das seguintes opções:NONEHEADERBODY
expireAt
string
exemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
exemplo10

Total delivery attempts

totalSuccesses
integer
exemplo10

Total successful deliveries

totalFailures
integer
exemplo10

Total failed deliveries

failed
boolean

Current delivery status

Exemplo Resposta

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

Caminho Parâmetros

id
string
Obrigatório

Unique identifier of the webhook

Respostas

Successful

Renews a web hook

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

Caminho Parâmetros

id
string
Obrigatório

Webhook ID

Respostas
Tipo de conteúdo
application/json

Successful

id
string
exemplo184094

Unique identifier for the webhook

userId
string
exemplo522078

Unique identifier of the user

accountId
string
exemplo257073

Unique identifier of the account

url
string
exemplohttps://www.example.com

Destination URL for events

status
string
exemploACTIVE

Status for the webhook

Deve ser uma das seguintes opções:ACTIVEPAUSED
events
array

Subscribed events for the webhook

Valores disponíveis:
CALL
signingAlgo
string
exemploHMAC_SHA256

Signing algorithm for the webhook

Deve ser uma das seguintes opções:HMAC_SHA256NONE
metadataPolicy
string
exemploNONE

Metadata policy for the webhook

Deve ser uma das seguintes opções:NONEHEADERBODY
expireAt
string
exemplo2019-01-01T00:00:00.000Z

Expiration time for the webhook

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

Created time for the webhook

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

Last renewed time for the webhook

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

Scheduled purge time for the webhook

signingKey
string

Signing key for the webhook

statistics
object
totalAttempts
integer
exemplo10

Total delivery attempts

totalSuccesses
integer
exemplo10

Total successful deliveries

totalFailures
integer
exemplo10

Total failed deliveries

failed
boolean

Current delivery status

Exemplo Resposta

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