Diferencia entre revisiones de «API de buzones»
(Página nueva: '''Atención: trabajo en desarrollo.''' ===URL=== La API de desvíos se ofrece como un servicio web, accesible mediante la URL: https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_buz...) |
|||
| Línea 28: | Línea 28: | ||
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. | 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. | ||
| + | |||
| + | ===Listar los mensajes de un buzón=== | ||
| + | |||
| + | Para listar los mensajes de un buzón, hemos de pasar los parámetros obligatorios (ver capítulo anterior) y el parámetro accion=listar. Por ejemplo, para listar los mensajes del número virtual 902009955: | ||
| + | |||
| + | https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_buzon?principal=xxxxxxxxx&pin=1234&origen=902009955&accion=listar | ||
| + | |||
| + | O para listar los mensajes de la extensión 34: | ||
| + | |||
| + | https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_buzon?principal=xxxxxxxxx&pin=1234&origen=34&accion=listar | ||
| + | |||
| + | Si queremos, por otro lado, los faxes recibidos en el número 902009956: | ||
| + | |||
| + | https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_buzon?principal=xxxxxxxxx&pin=1234&origen=902009956&accion=listar | ||
| + | |||
| + | O, por ejemplo, las grabaciones de la cuenta: | ||
| + | |||
| + | https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/api_buzon?principal=xxxxxxxxx&pin=1234&origen=grabaciones&accion=listar | ||
| + | |||
| + | La respuesta a esta petición se suministra en XML: | ||
| + | |||
| + | <?xml version="1.0" encoding="UTF-8" ?> | ||
| + | |||
| + | <buzon> | ||
| + | <error>0</error> | ||
| + | <entrada> | ||
| + | <fecha>09/04/2012</fecha> | ||
| + | <hora>15:52:58</hora> | ||
| + | <bytes>2463</bytes> | ||
| + | <estado>no leido</estado> | ||
| + | <llamante>912345678</llamante> | ||
| + | <llamado>902009956</llamado> | ||
| + | <origen>902009956</origen> | ||
| + | <nombre_llamante>Juan Ruiz</nombre_llamante> | ||
| + | <fichero>2012-04-09_15-52-58_Lunes_912345678_902009956.pdf</fichero> | ||
| + | </entrada> | ||
| + | <entrada> | ||
| + | <fecha>09/04/2012</fecha> | ||
| + | <hora>15:45:04</hora> | ||
| + | <bytes>2458</bytes> | ||
| + | <estado>no leido</estado> | ||
| + | <llamante>987654321</llamante> | ||
| + | <llamado>902009956</llamado> | ||
| + | <origen>902009956</origen> | ||
| + | <nombre_llamante>Pepe Laso</nombre_llamante> | ||
| + | <fichero>2012-04-09_15-45-04_Lunes_987654321_822200956.pdf</fichero> | ||
| + | </entrada> | ||
| + | ... | ||
| + | </buzon> | ||
Revisión del 12:31 12 abr 2012
Atención: trabajo en desarrollo.
URL
La API de desvíos se ofrece como un servicio web, accesible mediante la URL:
https://scgi.duocom.es/cgi-bin/telefacil2/api_buzon?principal=xxxxxxxxx&pin=1234&origen=xxxxxxxxx
Para los clientes de Canarias, la URL es:
https://cgi.duocom.es/cgi-bin/telefacil2/api_buzon?principal=xxxxxxxxx&pin=1234&origen=xxxxxxxxx
Para acceder a esta API hay que tener dado de alta un número de Oficina Virtual (número virtual, centralita, fax, botón web). Temporal: En la pestaña de "Desvíos", sección "Opciones Avanzadas", se puede activar esta API (por defecto se encuentra desactivada) y restringir su uso según la IP de acceso a la misma (esto es aconsejable para aumentar la seguridad si se tiene una dirección IP fija).
Parámetros obligatorios
- 'principal' es el número de teléfono del cliente (con el que se dio de alta), también llamado "usuario de la cuenta Telefácil".
- 'pin' es el PIN de la cuenta Telefácil.
- 'origen':
- Si quiere consultar el buzón de voz de un número virtual, 'origen' es el número virtual.
- Si quiere consultar el buzón de voz de una extensión de centralita, 'origen' es la extensión.
- Si quiere consultar el buzón de faxes de un fax, 'origen' es el número de fax.
- Si quiere consultar el buzón de voz de un botón web, 'origen' es el botón web.
- Si quiere consultar el buzón de grabaciones, 'origen' debe tener el valor 'grabaciones' (origen=grabaciones).
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 pin 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.
Listar los mensajes de un buzón
Para listar los mensajes de un buzón, hemos de pasar los parámetros obligatorios (ver capítulo anterior) y el parámetro accion=listar. Por ejemplo, para listar los mensajes del número virtual 902009955:
https://scgi.duocom.es/cgi-bin/telefacil2/api_buzon?principal=xxxxxxxxx&pin=1234&origen=902009955&accion=listar
O para listar los mensajes de la extensión 34:
https://scgi.duocom.es/cgi-bin/telefacil2/api_buzon?principal=xxxxxxxxx&pin=1234&origen=34&accion=listar
Si queremos, por otro lado, los faxes recibidos en el número 902009956:
https://scgi.duocom.es/cgi-bin/telefacil2/api_buzon?principal=xxxxxxxxx&pin=1234&origen=902009956&accion=listar
O, por ejemplo, las grabaciones de la cuenta:
https://scgi.duocom.es/cgi-bin/telefacil2/api_buzon?principal=xxxxxxxxx&pin=1234&origen=grabaciones&accion=listar
La respuesta a esta petición se suministra en XML:
<?xml version="1.0" encoding="UTF-8" ?>
<buzon>
<error>0</error>
<entrada>
<fecha>09/04/2012</fecha>
<hora>15:52:58</hora>
<bytes>2463</bytes>
<estado>no leido</estado>
<llamante>912345678</llamante>
<llamado>902009956</llamado>
<origen>902009956</origen>
<nombre_llamante>Juan Ruiz</nombre_llamante>
<fichero>2012-04-09_15-52-58_Lunes_912345678_902009956.pdf</fichero>
</entrada>
<entrada>
<fecha>09/04/2012</fecha>
<hora>15:45:04</hora>
<bytes>2458</bytes>
<estado>no leido</estado>
<llamante>987654321</llamante>
<llamado>902009956</llamado>
<origen>902009956</origen>
<nombre_llamante>Pepe Laso</nombre_llamante>
<fichero>2012-04-09_15-45-04_Lunes_987654321_822200956.pdf</fichero>
</entrada>
...
</buzon>
Indice
Portada >> Desarrolladores >> API de buzones.
