Diferencia entre revisiones de «API de filtros»
(Página creada con «{{#seo: |title= API {{PROD_TILDE}}. |titlemode=append |keywords=etiqueta numero virtual, Api, aplicaciones y desarrollo, herramientas web, desarrollo herramientas, API tele...») |
|||
| Línea 33: | Línea 33: | ||
===Leer los filtros actuales=== | ===Leer los filtros actuales=== | ||
| − | + | Para leer los filtros que actualmente están espeficicados, hay que llamar a la URL de la API sin ninguna acción. Por ejemplo, para un número virtual: | |
| + | |||
| + | https://scgi.duocom.es/cgi-bin/telefacil2/api_filtros?principal=999888777&pass=1111&nv=902009955 | ||
| + | |||
| + | Para una extensión: | ||
| + | |||
| + | https://scgi.duocom.es/cgi-bin/telefacil2/api_filtros?principal=999888777&pass=1111&ext=1234 | ||
| + | |||
| + | La API devolverá un XML de este tipo: | ||
| + | |||
| + | <filtros> | ||
| + | <res>1</res> | ||
| + | <max_filtros>250</max_filtros> | ||
| + | <num_filtros>2</num_filtros> | ||
| + | <filtro> | ||
| + | <id>1</id> | ||
| + | <telefono>912345678</telefono> | ||
| + | <comentario/> | ||
| + | <accion>no filtrar</accion> | ||
| + | </filtro> | ||
| + | <filtro> | ||
| + | <id>2</id> | ||
| + | <telefono>987654321</telefono> | ||
| + | <comentario>TEST</comentario> | ||
| + | <accion>buzon</accion> | ||
| + | </filtro> | ||
| + | </filtros> | ||
---- | ---- | ||
Revisión del 12:11 23 may 2016
URL de API de filtros
La API de filtros se ofrece como un servicio web, accesible mediante la URL:
https://scgi.duocom.es/cgi-bin/telefacil2/api_filtros?principal=xxxxxxxxx&pass=xxxxxxxx&nv=xxxxxxxxx
Para los clientes de Canarias, la URL es:
https://cgi.duocom.es/cgi-bin/telefacil2/api_filtros?principal=xxxxxxxxx&pass=xxxxxxxx&nv=xxxxxxxxx
Para acceder a esta API hay que tener dado de alta un número virtual, un número de centralita virtual o un número de fax. En Desarrolladores > Permisos de las APIs 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".
- 'pass' es la contraseña de la cuenta Telefácil.
- Además, hace falta especificar:
- o bien 'nv' como el número virtual al que se quieren consultar o modificar los filtros.
- o bien 'ext' como la extensión a la que se quieren consultar o modificar los filtros.
- o bien 'fax' como el número de fax al que se quieren consultar o modificar los filtros.
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.
Leer los filtros actuales
Para leer los filtros que actualmente están espeficicados, hay que llamar a la URL de la API sin ninguna acción. Por ejemplo, para un número virtual:
https://scgi.duocom.es/cgi-bin/telefacil2/api_filtros?principal=999888777&pass=1111&nv=902009955
Para una extensión:
https://scgi.duocom.es/cgi-bin/telefacil2/api_filtros?principal=999888777&pass=1111&ext=1234
La API devolverá un XML de este tipo:
<filtros>
<res>1</res>
<max_filtros>250</max_filtros>
<num_filtros>2</num_filtros>
<filtro>
<id>1</id>
<telefono>912345678</telefono>
<comentario/>
<accion>no filtrar</accion>
</filtro>
<filtro>
<id>2</id>
<telefono>987654321</telefono>
<comentario>TEST</comentario>
<accion>buzon</accion>
</filtro>
</filtros>
Indice
Página principal >> Desarrolladores >> API de filtros.
