Saltar a: navegación, buscar

API de cola de envíos de fax


Descripción API de cola de envíos de fax

Con la API de cola de envíos de Fax, usted puede acceder a un listado de sus envíos actuales de fax vía HTTP sin necesidad de entrar en su cuenta. Esta herramienta es útil para integrar la cola de envíos de Telefácil con su base de datos, CRM, web, etc.


Activación API de cola de envíos de fax

La API de cola de envíos de fax debe ser activada explícitamente en la web. El permiso es el mismo que tiene la API de buzones: en la pestaña de "Buzón" de cualquiera de los números de fax, sección "Opciones Avanzadas" (o 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).


URL API de cola de envíos de fax

La API de cola de envíos de fax se ofrece como un servicio web, accesible mediante la URL:

 https://scgi.duocom.es/cgi-bin/telefacil2/api_faxes_cola?principal=xxxxxxxxx&pass=xxxxxxxx&fax=902009956

Para los clientes de Canarias, la URL es:

 https://cgi.duocom.es/cgi-bin/telefacil2/api_faxes_cola?principal=xxxxxxxxx&pass=xxxxxxxx&fax=902009956


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.
  • 'fax' es el número de fax que ha realizado los envíos (su fax contratado con Telefácil).


Parámetros opcionales

  • 'diferidos=1' para que también se listen los envíos de fax programados.


Resultado API de cola de envíos de fax

La URL api_faxes_cola devuelve una respuesta text/xml con un conjunto de faxes en cola, con un elemento 'fax' por cada fax pendiente de envío (o enviándose):

<?xml version="1.0" encoding="UTF-8" ?>

<faxes_cola>
  <error>0</error>
  <fax>
    <plataforma>56</plataforma>
    <remitente>902009956</remitente>
    <destinatario>912345678</destinatario>
    <intentos_restantes>3</intentos_restantes>
    <comunicandos_restantes>3</comunicandos_restantes>
    <estado>Enviando</estado>
    <id>15</id>
  </fax>
  <numero_faxes>1</numero_faxes>
</faxes_cola>

Los campos 'plataforma' e 'id' identifican numéricamente al fax dentro de la cola de envíos. 'estado' puede ser 'Enviando' o 'Pendiente'. Los 'intentos_restantes' especifican el número de intentos que quedan frente a posibles errores (no hay fax al otro lado, hay un fallo en la comunicación del fax, etc.), mientras que 'comunicandos_restantes' indica el número de intentos que quedan frente a errores por "fax destinatario comunicando".


Eliminar un envío pendiente

Para eliminar un fax de la cola de envíos, a los parámetros obligatorios deberá añadirle la id y la plataforma del fax en cuestión. Por ejemplo, para el ejemplo anterior, deberíamos hacer la siguiente llamada:

https://scgi.duocom.es/cgi-bin/telefacil2/api_faxes_cola?principal=xxxxxxxxx&pass=xxxxxxxx&fax=902009956&id=15&plataforma=56


Notas API de cola de envíos de fax

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.





Indice

Página principal >> Desarrolladores >> API de cola de envíos de fax.