Webhooks

Retorna um webhook

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

get

/pbx/webhook

HTTPcURLJavaScriptPython

GET /pbx/webhook?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "url": "https://server1.com.br/route",
  "token": "mySecretToken",
  "events": [
    "AgentConnect",
    "AgentComplete",
    "QueueSummary"
  ],
  "verify_ssl": "true"
}

Cadastro de webhook

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

urlstringObrigatório

URL que vai ser acionada neste webhook

Example: https://server1.com.br/route

tokenstringObrigatório

Token que será enviado no cabeçalho X-Voice-token caso o cliente queira autenticar as requisições

Example: mySecretToken

eventsstring[]Obrigatório

Lista de eventos que serão enviados

Example: ["AgentConnect", "AgentComplete", "QueueSummary"]

verify_sslbooleanObrigatório

Realiza (true) ou não (false) a verificação SSL

Example: true

Respostas

default

application/json

post

/pbx/webhook

HTTPcURLJavaScriptPython

POST /pbx/webhook HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "url": "https://server1.com.br/route",
  "token": "mySecretToken",
  "events": "[\"AgentConnect\", \"AgentComplete\", \"QueueSummary\"]",
  "verify_ssl": true
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "url": "https://server1.com.br/route",
  "token": "mySecretToken",
  "events": [
    "AgentConnect",
    "AgentComplete",
    "QueueSummary"
  ],
  "verify_ssl": "true"
}

Atualiza um webhook

put

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Corpo

application/json

urlstringObrigatório

URL que vai ser acionada neste webhook

Example: https://server1.com.br/route

tokenstringObrigatório

Token que será enviado no cabeçalho X-Voice-token caso o cliente queira autenticar as requisições

Example: mySecretToken

eventsstring[]Obrigatório

Lista de eventos que serão enviados

Example: ["AgentConnect", "AgentComplete", "QueueSummary"]

verify_sslbooleanObrigatório

Realiza (true) ou não (false) a verificação SSL

Example: true

Respostas

default

application/json

put

/pbx/webhook

HTTPcURLJavaScriptPython

PUT /pbx/webhook?id=text HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "url": "https://server1.com.br/route",
  "token": "mySecretToken",
  "events": "[\"AgentConnect\", \"AgentComplete\", \"QueueSummary\"]",
  "verify_ssl": true
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "url": "https://server1.com.br/route",
  "token": "mySecretToken",
  "events": [
    "AgentConnect",
    "AgentComplete",
    "QueueSummary"
  ],
  "verify_ssl": "true"
}

Deleta um webhook

delete

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

delete

/pbx/webhook

HTTPcURLJavaScriptPython

DELETE /pbx/webhook?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "count": 1
}

Retorna lista de webhooks paginada

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

limitstringOpcional

pagestringOpcional

Respostas

default

application/json

get

/pbx/webhook/paginated

HTTPcURLJavaScriptPython

GET /pbx/webhook/paginated HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "items": [
    {
      "_id": "63724b92c0ef93903y24dc45",
      "url": "https://server1.com.br/route",
      "token": "mySecretToken",
      "events": [
        "AgentConnect",
        "AgentComplete",
        "QueueSummary"
      ],
      "verify_ssl": "true"
    }
  ],
  "meta": {
    "totalItems": 1,
    "itemCount": 1,
    "itemsPerPage": 10,
    "totalPages": 1,
    "currentPage": 1
  }
}