API PABX Dígitro
Canal de EventosChamadasDados e ConfiguraçõesConsultas e Informações
Canal de EventosChamadasDados e ConfiguraçõesConsultas e Informações
Estado e Configurações
GravaçãoTons e ReproduçãoOutros
Estado e Configurações
GravaçãoTons e ReproduçãoOutros
  1. Estado e Configurações
  • Consultar estado de subida do sistema
    POST
  • Consultar dados de localização do ramal
    POST
  • Consultar limite de participantes em sala de conferência
    POST
  • Consultar salas de conferência ativas
    POST
  • Consultar estado dos ramais
    POST
  • Consultar configurações do NR
    POST
  • Consultar estado da ausência no grupo
    POST
  • Consultar configurações do LO
    POST
  • Consultar configurações do cadeado
    POST
  • Consultar configurações do não pertube
    POST
  • Consultar configurações do grupo
    POST
  • Consultar número de cifras (PABX)
    POST
  • Consultar estado da gravação
    POST
  • Consultar detalhes de um perfil CPD
    POST
  • Listar perfis CPD configurados
    POST
  • Consultar informações de chamada no dispositivo
    POST
  • Consultar dados associados de chamada em andamento no dispositivo
    POST
  • Consultar agentes logados em dispositivo DAC
    POST
  • Consultar chamadas em andamento do dispositivo
    POST
  • Consultar estado de monitoração de áudio do dispositivo
    POST
  • Consultar estado do voicemail
    POST
  • Consultar estado dos estacionamentos
    POST
  • Consultar estado agente DAC
    POST
  • Consultar estado do siga-me por horários
    POST
  • Consultar estado do siga-me externo
    POST
  • Consultar estado do siga-me interno
    POST
  • Verificar se ramal pode ser gravado durante a chamda atual
    POST
  • Verificar ramais em grupo
    POST
  • Consultar dispositivo em uma rota específica
    POST
  1. Estado e Configurações

Consultar dispositivo em uma rota específica

POST
/requests/{channelID}/consulta

Requisição

Parâmetros Path
channelID
integer 
requerido
ID do Canal recebido no EVENTO_DE_ABERTURA_DE_CANAL
Parâmetros Header
x-api-key
string 
requerido
Chave de acesso para controle via CTI
Parâmetros Bodyapplication/json
DISPOSITIVO
string 
requerido
Indica o dispositivo que está requisitando um serviço.
SENHA_DISPOSITIVO
string 
requerido
Senha do dispositivo.
ROTA
string 
opcional
Indica a rota a ser utilizada.
CONTA
string 
opcional
Indica a conta do usuário.
CARTAO
string 
opcional
Indica o cartão (pré-pago) que deve ser utilizado para gerar chamada.
SENHA
string 
opcional
Indica a senha a ser utilizada para validação da operação requisitada.
IDENTIDADE_DESTINO
string 
requerido
Indica a identidade do destino.
DADOS
string 
requerido
Dados associados à chamada. (Limite de 100 caracteres)
IDENTIDADE_ORIGINADOR
string 
opcional
Indica a identidade a ser usada como originador na geração de chamada.
TEMPO_REATENDIMENTO
string 
opcional
Indica o tempo (em segundos) que a chamada ficará estabelecida com o destino além da liberação (destino coloca no gancho), afim de esperar o reatendimento da mesma. O tempo máximo permitido é de 90 segundos.
ID_CHAMADA
string 
opcional
Este campo é a identificação da chamada em andamento.
Exemplo
{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "ROTA": "0",
    "CONTA": "1114000",
    "CARTAO": "",
    "SENHA": "1234",
    "IDENTIDADE_DESTINO": "04832817000",
    "DADOS": "111222333-44;Fulano",
    "IDENTIDADE_ORIGINADOR": "1112000",
    "TEMPO_REATENDIMENTO": "10",
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00"
}

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 POST '/requests//consulta' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "ROTA": "0",
    "CONTA": "1114000",
    "CARTAO": "",
    "SENHA": "1234",
    "IDENTIDADE_DESTINO": "04832817000",
    "DADOS": "111222333-44;Fulano",
    "IDENTIDADE_ORIGINADOR": "1112000",
    "TEMPO_REATENDIMENTO": "10",
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00"
}'

Respostas

🟢200OK
application/json
Comando recebido com sucesso.
Body
ID_CHAMADA
string 
opcional
Este campo é a identificação da chamada em andamento.
Exemplo
{
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00"
}
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🔴500Erro do servidor
Modificado em 2024-09-23 19:00:39
Página anterior
Verificar ramais em grupo
Built with