Desde Atom, habilitamos nuestro Endpoint dentro de Cloud Functions para permitir el envío de Templates Messages utilizando su número de WhatsApp Oficial y el templateId.
Cuando el número enviado ya se encuentre vinculado con una conversación, se enviará el mensaje sobre la misma y la confirmación de envío será inmediata. En caso contrario, se esperará confirmación por medio del proveedor de WhatsApp Oficial, por lo cual no se brindará una confirmación de envío inmediata.
A continuación explicamos los parámetros que se deben incluir dentro de la petición de manera obligatoria, y otros que se pueden agregar opcionalmente:
| Nombre del Parámetro | Descripción | Tipo de Dato | Requerido |
|---|---|---|---|
|
templateId |
Identificador (Id) del Template Message de AtomChat. |
string |
Sí |
|
phoneNumber |
Número de teléfono al que se enviará el Template Message. Se debe anteponer el código del país, sin utilizar el signo + Correcto: 50755667788 ✅ Incorrecto: +50555667788 ❌ Incorrecto: 55667788 ❌ |
string |
Sí |
|
clientName |
Nombre del cliente al que se le enviará el Template Message. |
string |
No. El valor por defecto será el número de teléfono. |
|
groupName |
Nombre del grupo a asignar. |
string |
No. El valor por defecto se obtiene del primer grupo asociado a la integración. |
|
assign |
Indica si la conversación se debe asignar a un Agente (con el valor true). En caso contrario, es asignada a Bot. |
boolean |
No. El valor por defecto es false. |
|
params |
Colección de parámetros con sus valores requeridos para el uso del Template Message. |
object |
No |
La petición para realizar el envío de Templates Messages utilizando la API de AtomChat, se realiza de la siguiente manera:
|
Tipo de Conexión |
Acceso público por Internet |
|
Endpoint |
https://us-central1-atomchat-io.cloudfunctions.net/api/Template/SendMessage |
|
Método |
POST |
|
Encabezados |
Content-type: application/json Charset: utf-8 Authorization: Bearer (token público) |
|
Cuerpo |
{ “templateId”: “id_del_template”, “phoneNumber”: “numero_de_telefono”, “clientName”: “nombre_del_cliente”, “groupName”: “nombre_del_grupo”, “assign”: true/false, “params”: { “param1”: “valor”, “param2”: “valor ”, … }, } |
Las respuestas esperadas para la petición realizada, son las siguientes:
| Escenario | Código de Respuesta | Cuerpo de la Respuesta |
|---|---|---|
|
Número nuevo |
200 |
{ success: true, message: "Pending" } |
|
Número existente |
200 |
{ success: true, message: "Sent", data: {conversation_id : conversation.id } } |
|
Parámetros incorrectos |
400 |
{ success: false, message: "No hay datos para enviar" } |