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

Ok Leer más

Documentación

POST /api/contacto/

Inserta o reemplaza contactos en la agenda. No se admiten mas de 1000 contactos por peticion.

Cabeceras

El sistema espera las siguientes cabeceras:

Nombre
Descripción
Firma
(Obligatorio)
Esta cabecera se usa para autentificar al usuario. Su valor esta 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 dos entradas, contactos y grupos. La entrada contactos es un array de objetos, que cada uno puede contener los siguientes parametros:

Nombre
Descripción
nombre
(Opcional)
Nombre del contacto, si no se indica o es null se guarda en blanco si el contacto no existe, o se deja el valor existente si el contacto existe.
apellidos
(Opcional)
Apellidos del contacto, si no se indica se guarda en blanco si el contacto no existe, o se deja el valor existente si el contacto existe.
telefono
(Obligatorio)
Numero de teléfono del contacto.
Para envíos fuera de España debe indicar el teléfono con el formato: +prefijo numero
Ej: +44 0000000000
comentario
(Opcional)
Comentario a añadir al contacto, si no se indica se guarda en blanco si el contacto no existe, o se deja el valor existente si el contacto existe.

La entrada grupos, es opcional, y es un array formado por un los siguientes parametros:

Nombre
Descripción
mantenergrupos
(Opcional)
Valor booleano. Si es true se añaden los nuevos grupos sin borrar los anteriores, si es false se borran los grupos anteriores antes de añadir los nuevos. Si no se indica se toma el valor true.
grupos
(Opcional)
Array con los nombres de los grupos a añadir a los contactos. Si un nombre de grupo no existe se ignora.

Respuesta

Se devuelve, en formato json, un array que contiene una entrada por cada contacto enviado. Cada entrada es un array con los siguientes parámetros

Nombre
Descripción
telefono
Teléfono del contacto indicado en la petición
ok
Valor booleano que indica si se guardadon correctamente los datos
error
Texto aclaratorio del error ocurrido por el que no se pudo guardar el contacto. Solo tiene valor cuando el campo ok es false.

Ejemplo

Peticion:

POST http://www.smsup.es/api/contacto/ HTTP/1.1
Host: www.smsup.es
Firma: 1a332a5be0a9c575118af3199b1f6c18:6651390f628dc21b10145f3e4ca073d6d2b4b617
SMS-DATE: 2017-05-31T17:20:20+02:00
Content-Length: 128

{"contactos":[{"telefono":"600000000"},{"nombre":"nombre1","telefono":"+351 600000000"}], "grupos":{"grupos":["vip", "otros"]}}

Respuesta:

[{"telefono":"600000000","ok":true,"error":""},{"telefono":"+351 600000000","ok":true,"error":""}]