Função: Retorna dados e status de todos os ramais/trunks SIP
Campo | Tipo | Notas | Definição |
holdstatus | Boolean | Opcional | Verifica se o SIP Peer esta em MusicOnHold |
Status de retorno
Código | Descrição |
0 | OK |
1 | Erro de aplicação no ezWSI |
2 | Sem dados |
Objeto de retorno
Tipo: Objeto, com índices únicos (UniqueID) das ligações correntes como chaves e objetos com padrão descrito abaixo:
Exemplo:
{"5803": { "AutoForcerport": false, "ObjectName": “5803“, "Channeltype": “SIP", "IPport": “5060", "ChanObjectType": “peer", "Forcerport": false, "TextSupport": false, "ACL": true, "Dynamic": true, "RealtimeDevice": true, "IPaddress": “192.168.1.229", "AutoComedia": false, "Description": “", "VideoSupport": false, “Comedia": false, "Status": "OK (34 ms)"} }
Campo | Tipo | Definição |
AutoForcerport | boolean | Configura rpot (abaixo) automaticamente se for detectado NAT |
ObjectName | integer | Número do ramal ou nome do trunk |
Channeltype | varchar | SIP |
IPport | varchar | Porta SIP do dispositivo de origem (cliente) |
ChanObjectType | varchar | Tipo do canal: peer, user ou friend |
Forcerport | boolean | RFC-3581 O cliente SIP requisita que o ezIBPX retorne as mensagens SIP (SDP) para ele através do IP e Porta de conexão; Utilizado para NAT |
TextSupport | boolean | Suporte a texto em tempo real ITU-T T.140 |
ACL | boolean | Configuração de ACL (restrição de IP de conexão) |
Dynamic | boolean | IP de origem dinamico |
RealtimeDevice | boolean | Registro SIP configurado utilizando Banco de Dados da aplicação |
IPaddress | varchar | Endereço IP do dispositivo de origem (cliente) |
AutoComedia | boolean | Configura comedia (abaixo) automaticamente se for detectado NAT |
Description | varchar | Descrição cadastrada para o objeto SIP |
VideoSupport | boolean | Suporte a video |
Comedia | boolean | O ezIPBX deve retornar o fluxo de áudio/media (RTP) para o dispositivo através da porta de origem da conexão ou porta informada na mensagem SIP (SDP) |
Status | varchar | Status do telefone, em caso de OK retorna o tempo de resposta do dispositivo autenticado; Status disponíveis: OK, UNKNOWN, LAGGED e UNREACHABLE |
Hold | boolean | Retorna se o dispositivo esta em música de espera |
Este método é limitado e os dados ficam em cache (30 segundos), aceitando no máximo 4 requisições por segundo.
É necessário que haja um controle de cache na aplicação externa destes dados caso seja necessário um volume maior de requisições.