Telephony

The Vonage Business Telephony API enables you to manage calls and retrieve device registration information.

Baixar a especificação OpenAPI
Operações disponíveis

Get list of active calls for a given account (paginated). Please use Reports API to get list of completed calls.

gethttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Consulta Parâmetros

extension
string
exemplo1234
page_size
string
Padrão100
exemplo100

Return max this amount of calls in the response.

order
string
exemploasc

Either ascending or descending order.
Must be one of asc or desc.

start_time
string
exemplo1595955770

Return the calls that occurred after this point in time.
Should be of type epoch with seconds precision.

end_time
integer
exemplo1595955770

Return the calls that occurred before this point in time.
Should be of type epoch with seconds precision.

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234

Respostas
Tipo de conteúdo

200 response

calls
array
account_id
string
exemplo1234
call_id
string
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
direction
string
exemploinbound
Deve ser uma das seguintes opções:inboundoutbound
end_time
string(date-time)
exemplo1595959736
from
string
exemplo1235551111
legs
array
account_id
string
exemplo1234

Account that this call leg belongs to

call_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Call Id this call belongs to

direction
string
exemploinbound

Leg direction - either "inbound" or "outbound"

Deve ser uma das seguintes opções:inboundoutbound
end_time
string(date-time)
exemplo1595959736

Call end time (if applicable)

from
string
exemplo1231112222

The "from" DID or extension

leg_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Globally unique leg Id

start_time
string(date-time)
exemplo1595959736

Call start time

status
string
exemplobusy

current leg status

Deve ser uma das seguintes opções:busyfailedunansweredringingon-call
to
string
exemplo1234567890

The "to" DID or extension

start_time
string(date-time)
exemplo1595959736
status
string
exemplobusy
Deve ser uma das seguintes opções:busyfailedunansweredringingon-call
to
string
exemplo1234567890
current_page
string
first_page_uri
string
exemplo/cc/accounts/1234/calls?page_size=0&order=desc
next_page
string
exemplo1
next_page_uri
string
exemplo/cc/accounts/1234/calls?page_size=0&order=desc
order
string
exemplodesc
page_size
string
exemplo1
pages
string
exemplo1
previous_page_uri
string
exemplo/cc/accounts/1234/calls?page_size=0&order=desc

Exemplo Resposta

{
   "calls": [
      {
         "account_id": 1234,
         "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         "direction": "inbound",
         "end_time": 1595959736,
         "from": 1235551111,
         "legs": [
            {
               "account_id": 1234,
               "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
               "direction": "inbound",
               "end_time": 1595959736,
               "from": 1231112222,
               "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
               "start_time": 1595959736,
               "status": "busy",
               "to": 1234567890
            }
         ],
         "start_time": 1595959736,
         "status": "busy",
         "to": 1234567890
      }
   ],
   "current_page": 0,
   "first_page_uri": "/cc/accounts/1234/calls?page_size=0&order=desc",
   "next_page": 1,
   "next_page_uri": "/cc/accounts/1234/calls?page_size=0&order=desc",
   "order": "desc",
   "page_size": 1,
   "pages": 1,
   "previous_page_uri": "/cc/accounts/1234/calls?page_size=0&order=desc"
}

Create a new call

posthttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234

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

from
object
destination
string
exemplo1234
type
string
exemploextension
Deve ser uma das seguintes opções:deviceextensionfeature_code
to
object
destination
string
exemplo1234567890
type
string
exemplopstn
Deve ser uma das seguintes opções:deviceextensionpstnfeature_code
type
string
exemploclick2dial
Deve ser uma das seguintes opções:click2dialclick2dialmeodrdefault

Exemplo Solicitação

{
   "from": {
      "destination": 1234,
      "type": "extension"
   },
   "to": {
      "destination": 1234567890,
      "type": "pstn"
   },
   "type": "click2dial"
}
{}

Respostas
Tipo de conteúdo

200 response

Exemplo Resposta

A visualização de exemplo não é suportada no momento para o tipo de conteúdo: text/plain

Get details for a specific active call.

gethttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234
call_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Respostas
Tipo de conteúdo

200 response

account_id
string
exemplo1234
call_id
string
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
direction
string
exemploinbound
Deve ser uma das seguintes opções:inboundoutbound
end_time
string(date-time)
exemplo1595959736
from
string
exemplo1235551111
legs
array
account_id
string
exemplo1234

Account that this call leg belongs to

call_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Call Id this call belongs to

direction
string
exemploinbound

Leg direction - either "inbound" or "outbound"

Deve ser uma das seguintes opções:inboundoutbound
end_time
string(date-time)
exemplo1595959736

Call end time (if applicable)

from
string
exemplo1231112222

The "from" DID or extension

leg_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Globally unique leg Id

start_time
string(date-time)
exemplo1595959736

Call start time

status
string
exemplobusy

current leg status

Deve ser uma das seguintes opções:busyfailedunansweredringingon-call
to
string
exemplo1234567890

The "to" DID or extension

start_time
string(date-time)
exemplo1595959736
status
string
exemplobusy
Deve ser uma das seguintes opções:busyfailedunansweredringingon-call
to
string
exemplo1234567890

Exemplo Resposta

{
   "account_id": 1234,
   "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "direction": "inbound",
   "end_time": 1595959736,
   "from": 1235551111,
   "legs": [
      {
         "account_id": 1234,
         "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         "direction": "inbound",
         "end_time": 1595959736,
         "from": 1231112222,
         "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         "start_time": 1595959736,
         "status": "busy",
         "to": 1234567890
      }
   ],
   "start_time": 1595959736,
   "status": "busy",
   "to": 1234567890
}

Update an existing call

puthttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo12345
call_id
string
Obrigatório
exemploc91150a6-8cc4-4e73-9fef-17fd925c6448

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

from
object
destination
string
exemplo1234567890
type
string
exemplopstn
Deve ser uma das seguintes opções:deviceextensionpstn
state
string
Deve ser uma das seguintes opções:activeparked
to
object
destination
string
exemplo1234567890
type
string
exemplopstn
Deve ser uma das seguintes opções:deviceextensionpstn

Exemplo Solicitação

{
   "from": {
      "destination": 1234567890,
      "type": "pstn"
   },
   "state": "active",
   "to": {
      "destination": 1234567890,
      "type": "pstn"
   }
}
{}

Respostas
Tipo de conteúdo
application/json

200 response

account_id
string(integer)
exemplo1234
call_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
call_state
string
destination
string

Exemplo Resposta

{
   "account_id": 1234,
   "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "call_state": "string",
   "destination": "string"
}

Delete a call resource

deletehttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234
call_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Respostas
Tipo de conteúdo

200 response

account_id
string(integer)
exemplo1234
call_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
call_state
string
destination
string

Exemplo Resposta

{
   "account_id": 1234,
   "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "call_state": "string",
   "destination": "string"
}

Get list of legs for a given active call

gethttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id/legs

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234
call_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Respostas
Tipo de conteúdo

200 response

array
account_id
string
exemplo1234

Account that this call leg belongs to

call_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Call Id this call belongs to

direction
string
exemploinbound

Leg direction - either "inbound" or "outbound"

Deve ser uma das seguintes opções:inboundoutbound
end_time
string(date-time)
exemplo1595959736

Call end time (if applicable)

from
string
exemplo1231112222

The "from" DID or extension

leg_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Globally unique leg Id

start_time
string(date-time)
exemplo1595959736

Call start time

status
string
exemplobusy

current leg status

Deve ser uma das seguintes opções:busyfailedunansweredringingon-call
to
string
exemplo1234567890

The "to" DID or extension

Exemplo Resposta

[
   {
      "account_id": 1234,
      "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "direction": "inbound",
      "end_time": 1595959736,
      "from": 1231112222,
      "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "start_time": 1595959736,
      "status": "busy",
      "to": 1234567890
   }
]

Get details for a specific active call leg

gethttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id/legs/:leg_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

leg_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
account_id
string
Obrigatório
exemplo1234
call_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Respostas
Tipo de conteúdo

200 response

account_id
string
exemplo1234

Account that this call leg belongs to

call_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Call Id this call belongs to

direction
string
exemploinbound

Leg direction - either "inbound" or "outbound"

Deve ser uma das seguintes opções:inboundoutbound
end_time
string(date-time)
exemplo1595959736

Call end time (if applicable)

from
string
exemplo1231112222

The "from" DID or extension

leg_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Globally unique leg Id

start_time
string(date-time)
exemplo1595959736

Call start time

status
string
exemplobusy

current leg status

Deve ser uma das seguintes opções:busyfailedunansweredringingon-call
to
string
exemplo1234567890

The "to" DID or extension

Exemplo Resposta

{
   "account_id": 1234,
   "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "direction": "inbound",
   "end_time": 1595959736,
   "from": 1231112222,
   "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "start_time": 1595959736,
   "status": "busy",
   "to": 1234567890
}

Modify a call leg.

puthttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id/legs/:leg_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234
call_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
leg_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

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

Um dos
Um dos
state
string
exemploheld

Exemplo Solicitação

{
   "state": "held"
}
{}

Respostas
Tipo de conteúdo
application/json

200 response

account_id
string(integer)
exemplo1234
call_id
string(uuid)
call_state
string
destination
string
leg_id
string(uuid)
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Exemplo Resposta

{
   "account_id": 1234,
   "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
   "call_state": "string",
   "destination": "string",
   "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Delete a call leg.

deletehttps://api.vonage.com/t/vbc.prod/telephony/v3/cc/accounts/:account_id/calls/:call_id/legs/:leg_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234
call_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6
leg_id
string
Obrigatório
exemplo3fa85f64-5717-4562-b3fc-2c963f66afa6

Respostas
Tipo de conteúdo

204 response

Get account device's registration info

gethttps://api.vonage.com/t/vbc.prod/telephony/v3/registration/accounts/:account_id/devices

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Consulta Parâmetros

page_size
string
Padrão100
exemplo10

Return max this number of devices in the response.

order
string
exemploasc

Either ascending or descending order.
Must be one of asc or desc.

start_time
string
exemplo1595955770

Return the devices that were registered after this point in time.
Should be of type epoch with seconds precision.

end_time
integer
exemplo1595955770

Return the devices that were registered before this point in time.
Should be of type epoch with seconds precision.

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234

Respostas
Tipo de conteúdo

200 response

current_page
string
exemplo1
devices
array
account_id
string
exemplo1234
device_ip
string
exemplo150.24.83.17
last_request
string
exemplo1595937421
last_success
string
exemplo1595937421
mac_address
string
exemplo79-5C-7D-28-1B-B3
registration
object
last_success
string
exemplo1595937421
provisioned
object
last_success
string
exemplo1595937421
last_request
string
exemplo1595937421
first_page_uri
string
exemplo/registration/accounts/1234/devices?page_size=100&order=desc
next_page
string
next_page_uri
string
exemplo/registration/accounts/1234/devices?page_size=100&order=desc
order
string
exemplodesc
page_size
string
exemplo10
pages
string
exemplo2
previous_page_uri
string
exemplo/registration/accounts/1234/devices?page_size=100&order=desc

Exemplo Resposta

{
   "current_page": 1,
   "devices": [
      {
         "account_id": 1234,
         "device_ip": "150.24.83.17",
         "last_request": 1595937421,
         "last_success": 1595937421,
         "mac_address": "79-5C-7D-28-1B-B3",
         "registration": {
            "last_success": 1595937421
         },
         "provisioned": {
            "last_success": 1595937421,
            "last_request": 1595937421
         }
      }
   ],
   "first_page_uri": "/registration/accounts/1234/devices?page_size=100&order=desc",
   "next_page": "string",
   "next_page_uri": "/registration/accounts/1234/devices?page_size=100&order=desc",
   "order": "desc",
   "page_size": 10,
   "pages": 2,
   "previous_page_uri": "/registration/accounts/1234/devices?page_size=100&order=desc"
}

Get device registration info

gethttps://api.vonage.com/t/vbc.prod/telephony/v3/registration/accounts/:account_id/devices/:device_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token OAuth.
Saiba mais sobre tokens OAuth

Headers

Bearer <access_token>

Caminho Parâmetros

account_id
string
Obrigatório
exemplo1234
device_id
string
Obrigatório
exemplo38-99-62-93-E2-A9

Mac address of device

Respostas
Tipo de conteúdo

200 response

account_id
string
exemplo1234
device_ip
string
exemplo150.24.83.17
last_request
string
exemplo1595937421
last_success
string
exemplo1595937421
mac_address
string
exemplo79-5C-7D-28-1B-B3
registration
object
last_success
string
exemplo1595937421
provisioned
object
last_success
string
exemplo1595937421
last_request
string
exemplo1595937421

Exemplo Resposta

{
   "account_id": 1234,
   "device_ip": "150.24.83.17",
   "last_request": 1595937421,
   "last_success": 1595937421,
   "mac_address": "79-5C-7D-28-1B-B3",
   "registration": {
      "last_success": 1595937421
   },
   "provisioned": {
      "last_success": 1595937421,
      "last_request": 1595937421
   }
}