1. Inicio
  2. Documentos
  3. Protegido: Integração RedBox – ezVoice Telecom
  4. ezWSI 2.0
  5. Método: sipPeers

Método: sipPeers

Função: Retorna dados e status de todos os ramais/trunks SIP

CampoTipoNotasDefinição
holdstatusBooleanOpcionalVerifica se o SIP Peer esta em MusicOnHold

Status de retorno

CódigoDescrição
0OK
1Erro de aplicação no ezWSI
2Sem 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)"}
	}
CampoTipoDefinição
AutoForcerportbooleanConfigura rpot (abaixo) automaticamente se for detectado NAT
ObjectNameintegerNúmero do ramal ou nome do trunk
ChanneltypevarcharSIP
IPportvarcharPorta SIP do dispositivo de origem (cliente)
ChanObjectTypevarcharTipo do canal: peer, user ou friend
ForcerportbooleanRFC-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
TextSupportbooleanSuporte a texto em tempo real ITU-T T.140
ACLbooleanConfiguração de ACL (restrição de IP de conexão)
DynamicbooleanIP de origem dinamico
RealtimeDevicebooleanRegistro SIP configurado utilizando Banco de Dados da aplicação
IPaddressvarcharEndereço IP do dispositivo de origem (cliente)
AutoComediabooleanConfigura comedia (abaixo) automaticamente se for detectado NAT
DescriptionvarcharDescrição cadastrada para o objeto SIP
VideoSupportbooleanSuporte a video
ComediabooleanO 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)
StatusvarcharStatus do telefone, em caso de OK retorna o tempo de resposta do dispositivo autenticado;
Status disponíveis: OK, UNKNOWN, LAGGED e UNREACHABLE
HoldbooleanRetorna 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.

Este artigo foi útil para você? Sim Não

Como podemos ajudar?