API de registro de SMS enviados

Descripción API de registro de SMS enviados

Con la API de registro de SMS enviados, usted puede acceder a un listado de sus envíos de SMS 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?

URL

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

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

Para los clientes de Canarias, la URL es:

https://cgi.duocom.es/cgi-bin/oficinaweb/api_sms_enviados?principal=xxxxxxxxx&pass=xxxxxxxx

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.

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).

Resultado APIde registro de SMS enviados

La URL api_sms_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).
• texto: texto del SMS.
• remitente: si lo ha contratado, el remitente que se usó para el envío del SMS (puede no aparecer).
• destinatario: el número al que se envió el SMS.
• nombre: nombre del destinatario (si se conoce).
• pais: país del destinatario.
• recibido: fecha y hora de la recepción del SMS en el terminal del destinatario (vacío si no se ha recibido).
• confirmado: fecha y hora de la confirmación vía URL del SMS por parte del destinatario (vacío si no se ha confirmado).

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

 <?xml version="1.0" encoding="UTF-8" ?>
 
 <sms_enviados>
   <error>0</error>
   <envio>
     <fecha>11/04/2012</fecha>
     <hora>10:50:47</hora>
     <destinatario>612345678</destinatario>
     <nombre>RITA </nombre>
     <pais><![CDATA[Spain - Mobile]]></pais>
     <texto><![CDATA[Estoy probando el servicio de sms desde mi identificador de llamadas]]></texto>
     <recibido>11/04/2012 10:51:11</recibido>
     <confirmado></confirmado>
   </envio>
 </sms_enviados>

Si la respuesta se pide en HTML, se devolverá una tabla con id y class "tabla_sms_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 SMS enviados.