Consultar dados de localização do ramal

POST

/requests/{channelID}/consulta-localizacao-ramal

Operações de controle dos Ramais monitorados

Esta função retorna dados da localização do ramal.

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.

Exemplo

{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/requests//consulta-localizacao-ramal' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567"
}'

Respostas

🟢200OK

application/json

Comando recebido com sucesso.

Body

COD_CIDADE_LOC

string

opcional

Código de cidade configurado na localização do ramal, segue o padrão de códigos do arquivo "/home2/httpd/arquivos_pabx/anatel_local.txt"

ROTA_LOC

string

opcional

Rota configurada na localização do ramal.

DESCRICAO_LOC

string

opcional

Descrição configurada na localização do ramal.

DDD_LOC

string

opcional

DDD configurado na localização do ramal.

CONFIGURADO_LOC

string

opcional

Indica se o ramal tem localização configurada.

Exemplo

{
    "COD_CIDADE_LOC": "11000",
    "ROTA_LOC": "124",
    "DESCRICAO_LOC": "FilialSP",
    "DDD_LOC": "11",
    "CONFIGURADO_LOC": "1"
}

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🔴500Erro do servidor

Página anterior

Consultar estado de subida do sistema

Próxima página

Consultar limite de participantes em sala de conferência