API PABX Dígitro
Canal de EventosChamadasDados e ConfiguraçõesConsultas e Informações
Canal de EventosChamadasDados e ConfiguraçõesConsultas e Informações
  1. Canal de Eventos
  • Abrir canal
    GET
  • Assinar inscrição de eventos
    POST
  • Cancela a inscrição de eventos
    POST
  1. Canal de Eventos

Abrir canal

GET
/channel
Operação do canal SSE de eventos

Requisição

Parâmetros Header
x-api-key
string 
requerido
Chave de acesso para controle via CTI

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/channel' \
--header 'x-api-key;'

Respostas

🟢200OK
Exemplo
Server-Sent-Events convertidos para string contendo um event (nome do evento) e um data (json "stringfied"). As opções abaixo mostram o data como um object a fim de demonstrar os campos possíveis.
Assim que o canal é aberto, o Client recebe um EVENTO_DE_ABERTURA_DE_CANAL, informando o ID_CANAL necessário em todos os demais comandos desta API.
A cada 15s, o Server enviará um evento KEEP_ALIVE, sem nenhum dado, apenas para informar o Client que o Canal ainda está aberto para o Server (uma segurança extra para caso o Client não receba o evento onerror de fechamento (gerado automaticamente pelas Libs clients SSE).
Body
object {0}
Exemplo
{}
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🔴500Erro do servidor
Próxima página
Assinar inscrição de eventos
Built with