API envío de Templates (Notificaciones) desde Sellia
Te presentamos nuestra API de integración con la cual podrás enviar notificaciones vía WhatsApp a tus clientes y/o prospectos directamente desde tus sistemas e inclusive de forma programada si así lo deseas.
¿Qué necesitas para poder acceder a nuestra API?
- Estar dado de alta como cliente en Sellia (Enterprise o Franchises).
- Tener el número de WhatsApp for Business API que diste de alta en Sellia activo y funcionando.
- Tener tu cuenta de Super Admin de Sellia activa.
Antes de iniciar, te compartimos nuestra colección exportada desde Postman para que la importes en tu manejador de API Rest y comiences a probarla. Descárgala desde aquí.
El request que realiza el envío de Templates es Templates/Send Template Params, podrás importarlo de nuestra colección y aquí te compartimos la autenticación, tabla de campos y códigos de respuesta asociados:
Auth
La autenticación para este servicio se genera con el request User/Login, necesitas añadir en los campos correspondientes tu usuario Super Admin y contraseña, envias la petición y recibirás como respuesta un Token, este Token puedes configurarlo como variable en tu manejador de peticiones API o también copiarlo y pegarlo en el apartado de Auth->Token, en cada request que enviarás en adelante.
Campos:
| Field | Type/values | Description |
| template | string | Es el id del template que deseas enviar y que obtienes en el request List Templates. |
| channel | string | Es el id del canal desde donde se enviarán los templates deseas y que obtienes en el request list campaigns, en el objeto channel. |
| clients | array-objects | Son los clientes que recibirán los templates los cuales, cada cliente debe contener los campos que se describen en los siguientes campos de esta tabla |
| clients.username | string | Es el número del cliente que recibirá el Template, se debe añadir en el formato +cod_pais_num_10_digitos, ejemplo: +523310850668 |
| clients.params | array-strings | Es el dato que va en cada variable del Template, si tu template contiene 3 parámetros, deberás llenar 3 espacios de este arreglo. |
| clients.params.file | string-url | Si el Template a enviar es de tipo imágen, debes incluir este objeto dentro de Params indicando la URL donde se encuentra tu imagen, solo se admiten URLs que culminen en tu imagen a compartir, ejemplo: url/imagen.png |
Si se trata de Templates con botones, la información que se muestra en cada botón no es modificable y se encuentra alojada en nuestras bases de datos desde el momento el cual se han aprobado tus Templates.
Códigos y mensajes de respuesta:
| Message | Description |
| Unprocessable Entity | "\"field\" is required", se recibe cuando un campo requerido no se agrega. Todos los campos son requeridos. |
| Unprocessable Entity | Cast to ObjectId failed for value \"set_template_id_here\" at path \"_id\" for model \"TemplateMessage\. Se recibe cuando el id del Template es incorrecto en su estructura o no existe en nuestra base de datos. También cuando el Id del template no está relacionado con el canal desde donde se enviará. |
| True | "Sending templates". Este mensaje se recibe cuando el envío ha salido de nuestros servidores sin problemas, en ese caso la entrega del mensaje ahora depende de WhatsApp, recomendamos como última validación comprobar que el Template se reciba correctamente en su telf de pruebas debido a que por pocos momentos, WhatsApp puede fallar en el envío. |
El resto de los request que importarás en nuestra colección te ayudará a completar los datos necesarios para el envío, recuerda siempre utilizar tu token.
Extras
También puedes guardar información en Sellia de los contactos a los cuales estás enviando notificaciones, esta información te será útil para cuando los usuarios respondan, saber quien es o alguna clasificación de cliente en especial. Tan solo incluye un arreglo adicional en el envío, de la siguiente manera:
Especificación de los campos de este array:
| key | value |
| Tipo: String. Este campo debe coincidir con el nombre de etiqueta que tengas dado de alta en la campaña donde registrarás los envíos, de lo contrario no podrás visualizar el dato en los reportes. | Tipo: String. Valor de la etiqueta que registrarás, por ejemplo: key: id - value: SNA001 |
Direccionar registro de template a una campaña específica:
Si deseas separar las métricas de un envío de templates en especifico, por campaña, puedes solicitar el ID de la campaña donde deseas registrar los envíos, al equipo de soporte de Sellia. Este ID deberás añadirlo con el campo campaign en el objeto más externo, de la siguiente forma:
¡Cualquier duda adicional no dudes en contactarnos a través de nuestros canales de atención!