Esta web utiliza 'cookies' propias y de terceros para ofrecerte una mejor experiencia y servicio

Ok Leer más

Documentación

POST /api/sms/

Inserta el envío de un sms a uno o varios teléfonos dados, para la fecha y hora dada

Cabeceras

El sistema espera las siguientes cabeceras:

Nombre
Descripción
Firma
(Obligatorio)
Esta cabecera se usa para autentificar al usuario. Su valor está formado por el id de cliente API, dos puntos y la firma que identifica la petición.
Esta firma es el hash sha1, usando el método HMAC, de los parámetros que identifican la petición, usando la clave secreta de usuario.
Los parámetros que identifican la peticion son:
VERBO+ruta sin host+Fecha ISO 8601+POST si procede.
Ej:
Petición: POST/api/sms/2013-10-10T19:19:21+02:00{“texto”:”Esto es una prueba de la api”,”telefonos”:[“67812736812″,”61253213″],”fecha”:”NOW”}
Cabecera: Firma: 923jrdslf923sdlkfjlijweo39284327: 3d7af8726a31fb73de269cc08352b323a73880d8
Sms-Date
(Obligatorio)
Su valor es la fecha que se uso para generar la firma en la cabecera Firma. Es la fecha y hora en el momento de hacer la petición, en formato ISO 8601. Se admite un desface de +/-10 minutos con el servidor. Si la fecha no es correcta la petición da error.
Ej: 2013-10-10T19:19:21+02:00

Parametros

Se espera en formato json un array con los siguientes parámetros

Nombre
Descripción
texto
(Obligatorio)
Texto del sms
fecha
(Obligatorio)
Fecha y hora del envío en formato ISO 8601.
Indique NOW para su envío directo.
Ej: 2004-02-12T15:19:21+00:00
telefonos
(Obligatorio)
Array con los números de teléfono a los que se enviara el sms.
Para envíos fuera de España debe indicar el teléfono con el formato: +prefijo numero
Ej: +44 0000000000
referencia
(Opcional)
Valor alfanumérico que identifica a la petición, máximo 30 caracteres. Tiene que ser único para cada petición, si se envía uno repetido no se inserta el envio
remitente
(Opcional)
Este sera el remitente del envío, puede ser hasta 11 números o 11 caracteres alfanuméricos (solo letras, números, guion, guion bajo, espacio y punto, sin ñ ni acentos). Si no se indica se usara el configurado como “por defecto” desde la aplicación.
codificacion
(Opcional)
Codificación a usar en el mensaje, posibles valores “gsm”, “uni”, “aut”. Por defecto “gsm”, que es la codificación normal de los mensajes y admite hasta 160 caracteres, aunque no admite acentos y otros caracteres especiales. Indicar “uni” para codificación unicode, máximo 70 caracteres por mensaje pero admite todos los caracteres. Indicar “aut” para que el sistema elija de forma automática la codificación según los caracteres del mismo.

Respuesta

Se devuelve, en formato json, un array que contiene una entrada por cada envío que se ha anotado. Es decir, una entrada por cada teléfono al que se enviara el texto. Si un teléfono enviado no se devuelve es que no se considero valido y no se enviara el sms. Cada entrada del array es un array con los siguientes parámetros

Nombre
Descripción
telefono
Teléfono al que se enviara el sms, tal y como se indico en la petición
id
Id otorgado al sms. Este id es el que se utiliza para conocer el estado del envío

Ejemplo

Peticion:

POST http://www.smsup.es/api/sms/ HTTP/1.1
Host: www.smsup.es
Firma: 923jrdslf923sdlkfjlijweo39284327:3d7af8726a31fb73de269cc08352b323a73880d8
SMS-DATE: 2013-10-10T19:19:21+02:00
Content-Length: 93

{"texto":"Esto es una prueba de la api","telefonos":["67812736812","61253213"],"fecha":"NOW"}

Respuesta:

[{"telefono":"67812736812","id":"160"},{"telefono":"61253213","id":"161"}]