API de registros VoIP
Sumario
¿Qué es la API de registros VoIP?
Descripción de API
Este servicio web nos permite listar los registros VoIP de un número virtual, una extensión de centralita o un siptrunk.
Forma de uso
Lista de registros
Devuelve la lista de registros voip (en XML).
La URL debe ser:
donde:
- 'usuario_voip' es el número de usuario voip (ejemplos: 902009000, 902009009.1234).
- 'password_voip' es la contraseña del usuario voip, establecida en el momento de activarlo.
Respuesta del servicio API
El servicio web retorna todas las respuestas en formato XML. Todas las respuestas están encerradas en la raíz 'registros', y contiene siempre un campo 'error' que será 0 si el comando o petición enviado al servidor se ejecutó con éxito, o 1 si hubo algún error, en cuyo caso habrá también un campo 'msgerr' que explica dicho error.
Por ejemplo, una respuesta afirmativa sería:
HTTP/1.1 200 OK Date: Mon, 20 Feb 2012 11:43:37 GMT Server: Apache Keep-Alive: timeout=15, max=100 Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: text/xml <?xml version="1.0" encoding="UTF-8" ?> <registros> <error>0</error> </registros>
Una respuesta de error sería:
HTTP/1.1 200 OK Date: Mon, 20 Feb 2012 11:43:37 GMT Server: Apache Keep-Alive: timeout=15, max=100 Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: text/xml <?xml version="1.0" encoding="UTF-8" ?> <registros> <error>1</error> <msgerr>Usuario incorrecto.</msgerr> </registros>
Ejemplos de uso API
Ejemplo de llamada al servicio web en PHP + CURL
Tenga presente que, aunque la aplicación web es accesible mediante una URL, no debe poner nunca enlaces a esta aplicación directamente en el código fuente de sus páginas web, ya que sus visitantes podrían descubrir datos sensibles como su número de usuario y su contraseña simplemente mirando el código HTML.
La aplicación web debe ser llamada siempre desde el servidor, usando para ello alguna de las librerías que permite llamadas a servicios HTTPS.
He aquí un ejemplo en PHP usando cURL, cortesía de tuayudainformatica.com:
<?php
$usuario = '911010009';
$pass = 'miClaveSecreta';
$curl = curl_init("https://scgi.duocom.es/cgi-bin/telefacil2/apinumeros?
usuario_voip=${usuario}&password_voip=${pass}"); // LLAMADA DE LA URL
curl_setopt($curl, CURLOPT_HEADER, false); // PARA EVITAR DEVOLUCION DE CABEZERAS HTTP
curl_setopt($curl, CURLOPT_TIMEOUT, 5); // TIEMPO DE ESPERA
$output = curl_exec($curl); // EJECUTAMOS LA LLAMADA
curl_close($curl);
$output = substr($output, 0, 1); // XML
?>
Indice
Página principal >> Desarrolladores >> API de registros VoIP.