Saltar a: navegación, buscar

API de registro de faxes enviados

Descripción API de registro de faxes enviados

Con la API de registro de faxes enviados, usted puede acceder a un listado de sus envíos de fax vía HTTP sin necesidad de entrar en su cuenta. Esta herramienta es útil para integrar el reporte de envíos de Mi Oficina Web con su base de datos, CRM, web, etc.

Si no sabe lo que es una API lea ¿Qué son las APIs de Mi Oficina Web?

Activación API de registro de faxes enviados

La API de registro de faxes enviados 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

La API de registro de faxes enviados se ofrece como un servicio web, accesible mediante la URL: 

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

Para los clientes de Canarias, la URL es: 

https://cgi.duocom.es/cgi-bin/oficinaweb/api_faxes_enviados?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 Mi Oficina Web".
  • 'pass' es la contraseña de la cuenta Mi Oficina Web.
  • 'fax' es el número de fax que ha realizado los envíos (su fax contratado con Mi Oficina Web).


Parámetros opcionales

  • 'finicio' indica la fecha de inicio desde la que se quieren consultar los consumos. Debe estar en formato DD-MM-YYYY.
  • 'ffinal' indica la fecha final hasta la que se quieren consultar los consumos. Debe estar en formato DD-MM-YYYY.
  • 'tipo_salida': puede ser 'text' (por defecto; para salida tipo texto plano), 'html' (para salida tipo tabla de HTML) o 'xml' (para salida tipo XML).
  • 'mas_recientes_primero=1': para que los envíos aparezcan ordenados por el más reciente primero (por defecto, aparecen primero los envíos más antiguos).
  • 'limite': indica cuántos faxes se quiere sacar; por defecto, limite=0 (sacar todos los envíos).
  • 'referencia': si quiere filtrar por referencia (un parámetro opcional de las APIs).


Resultado API de registro de faxes enviados

La URL api_faxes_enviados devuelve una respuesta text/plain (o text/xml o text/html si se especifica con el parámetro 'tipo_salida'), con una serie de líneas de texto con los siguientes campos:

  • fecha: fecha del envío (DD/MM/YYYY).
  • hora: hora en que empezó el envío (HH:MM:SS).
  • destinatario: el número al que se envió el fax.
  • resultado: OK si el envío fue correcto, o un mensaje de error.
  • referencia: (opcional) si el envío lo hizo vía servicio web o por email y estableció una referencia a seguir.
  • ref_id: este campo aparecerá a partir del 4 de febrero de 2014. Es una referencia interna de la llamada, que podrá encontrar también en la API de consumos. De esta manera, podrá saber también cuánto costó y qué duración tuvo el envío del fax. 'ref_id' es una referencia única del envío (dentro del día).

Si la respuesta se pide en XML, se devolverá un conjunto de faxes enviados, con un elemento 'envio' por cada envío realizado: 

 <?xml version="1.0" encoding="UTF-8" ?>
 
 <faxes_enviados>
   <error>0</error>
   <envio>
     <fecha>11/04/2012</fecha>
     <hora>05:50:47</hora>
     <destinatario>902009956</destinatario>
     <resultado>OK</resultado>
   </envio>
 </faxes_enviados>

Si la respuesta se pide en HTML, se devolverá una tabla con id y class "tabla_faxes_enviados". Posteriormente, le puede aplicar el estilo CSS que desee.


Notas

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 registro de faxes enviados.

Obtenido de «https://www.mioficinaweb.es/wiki/index.php?title=API_de_registro_de_faxes_enviados&oldid=18690»