API de envío de SMS
Con la API de envío de SMS (web service) podrá integrar en programas CRM, bases de datos, etc., un sistema de envío de mensajes SMS con cargo a su cuenta Mi Oficina Web.
Si no sabe lo que es una API lea ¿Qué son las APIs de Mi Oficina Web?
Sumario
Forma de uso de la API de envío de SMS
La URL debe ser:
https://scgi.duocom.es/cgi-bin/oficinaweb/apisms?principal=xxxxxxxxx&pass=xxxxxxxx&accion=enviar&mascara=xxxxxxxxx&mensaje=abcdefghijk&movil1=xxxxxxxxx
donde:
- 'principal' es su número de usuario de Mi Oficina Web.
- 'pass' es la contraseña de la cuenta.
- 'accion' debe tener el valor 'enviar'.
- 'mascara' (opcional): este será el remitente que le aparecerá al receptor del SMS. Si tiene algún número de Oficina Virtual, puede ponerlo aquí. Si ha contratado el servicio de envíos masivos, puede poner cualquiera de las 3 etiquetas elegidas en el momento del alta. Si no se especifica máscara, al receptor del SMS le llegará como remitente "SMS".
- 'mensaje' debe contener el texto (máx. 160 caracteres) que desea enviar.
- 'movil1' es el número de móvil del destinatario del SMS. Puede enviar a 5 números diferentes (movil1, movil2, movil3, movil4, movil5).
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.
Envíos masivos
Si tiene contratado el servicio de envíos masivos, puede enviar en una llamada al web service hasta a 1000 números de móvil. Para ello, en vez de especificar los números de móvil destinatarios con los argumentos 'movil1'..'movil5', tendrá que hacer uso del argumento 'móviles', pasándole una lista de hasta 100 números de móvil separados por un caracter no numérico. Por ejemplo:
moviles=612345678_698765432_612345679_0012127773456_666555444_677111222
Obtener máscaras
Para obtener las máscaras que puede utilizar para el envío de SMS puede utilizar esta URL:
https://scgi.duocom.es/cgi-bin/oficinaweb/apisms?principal=XXXXXXXXX&pin=XXXXXXXX&accion=mascaras
Envíos programados
Si quiere que el SMS se envíe a una hora (y/o fecha) específica en vez de inmediatamente, tendrá que añadir los siguientes parámetros:
- 'diferir=1'
- 'dif_anyo', 'dif_mes' y 'dif_dia': fecha en la que quiere enviar el SMS. El año debe tener 4 dígitos. El mes debe ser un valor entre 1 (enero) y 12 (diciembre). El día tendrá un valor entre 1 y 31. Deben especificarse todos aunque la fecha coincida con la fecha actual.
- 'dif_hora' y 'dif_minuto': hora y minutos del envío. La hora debe especificarse como un valor entre 0 y 23. Los minutos solo pueden tener los valores: 0, 15, 30 y 45.
Por ejemplo, si queremos enviar un SMS el 23 de abril de 2017 a las 08:00 con el texto "Hola" al móvil 612345678, haríamos:
https://scgi.duocom.es/cgi-bin/oficinaweb/apisms?principal=xxxxxxxxx&pass=xxxxxxxx&accion=enviar&mascara=xxxxxxxxx&mensaje=Hola&movil1=612345678&diferir=1&dif_anyo=2017&dif_mes=4&dif_dia=23&dif_hora=8&dif_minuto=0
Cobro del SMS
Cada envío SMS se cobrará al precio que indique la página web de Mi Oficina Web (consulte la sección de SMS, pestaña Tarifas).
Confirmación vía URL
Si desea que el receptor reciba una URL donde confirmar la recepción del SMS, ponga accion=confirming (en vez de accion=enviar). Si además desea llevarlo a una URL suya, añada el parámetro opcionalurl_redir=http://www.suweb.com.
Ejemplo de la API de envío de SMS
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.
He aquí un ejemplo en PHP usando cURL, cortesía de tuayudainformatica.com:
<?php
$usuario = '666111666';
$pass = 'MiClaveSecreta';
$movil1 = '655444333';
$mensaje = 'Hola';
$mascara = '902009955';
$curl = curl_init("https://scgi.duocom.es/cgi-bin/{{DIR_CGI}}/apisms?accion=enviar&
principal=${usuario}&pass=${pass}&movil1=${movil1}&mensaje=${mensaje}&mascara=${mascara}"); // LLAMADA DE LA URL
curl_setopt($curl, CURLOPT_HEADER, false); // PARA EVITAR DEVOLUCION DE CABEZERAS HTTP
curl_setopt($curl, CURLOPT_TIMEOUT, 5); // TIEMPO DE ESPERA
$output = curl_exec($curl); // EJECUTAMOS LA LLAMADA
curl_close($curl);
$output = substr($output, 0, 1); // SI OBTENEMOS 0 = ERROR / 1 = COMUNICACION OK
?>
Caracteres soportados
Se usa el alfabeto definido en el estándar GSM 3.38 de 7 bits. Este básicamente incluye las letras (a-z, A-Z), los números (0-9), los signos de puntuación (punto, coma, punto y coma, dos puntos), guiones, comillas simples y dobles, signos aritméticos (+, -, *, /, %, =, <, >, &), paréntesis y unos pocos más. Del resto del español sólo se soportan É, Ñ, ñ, Ú, ü, ¿ y ¡.
Aquí puede ver el alfabeto GSM 3.38 con más detalle:
Indice
Página principal >> Desarrolladores >> API de envío de SMS.