¿Cómo Enviar Templates Messages Utilizando la API de Atom?
Desde Atom, habilitamos nuestro Endpoint dentro de Cloud Functions para permitir el envío de Templates Messages utilizando sunúmero de WhatsApp Oficialy eltemplateId.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 |
templateId
| Identificador (Id) del Template Message de AtomChat. |
Identificador (Id) del Template Message de AtomChat.
| string |
string
| Sí |
Sí
| phoneNumber |
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 ❌ |
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 |
string
| Sí |
Sí
| clientName |
clientName
| Nombre del cliente al que se le enviará el Template Message. |
Nombre del cliente al que se le enviará el Template Message.
| string |
string
| No. El valor por defecto será el número de teléfono. |
No. El valor por defecto será el número de teléfono.
| groupName |
groupName
| Nombre del grupo a asignar. |
Nombre del grupo a asignar.
| string |
string
| No. El valor por defecto se obtiene del primer grupo asociado a la integración. |
No. El valor por defecto se obtiene del primer grupo asociado a la integración.
| assign |
assign
| Indica si la conversación se debe asignar a un Agente (con el valortrue). En caso contrario, es asignada a Bot. |
Indica si la conversación se debe asignar a un Agente (con el valortrue). En caso contrario, es asignada a Bot.
| boolean |
boolean
| No. El valor por defecto esfalse. |
No. El valor por defecto esfalse.
| params |
params
| Colección de parámetros con sus valores requeridos para el uso del Template Message. |
Colección de parámetros con sus valores requeridos para el uso del Template Message.
| object |
object
| No |
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 |
Tipo de Conexión
| Acceso público por Internet |
Acceso público por Internet
| Endpoint |
Endpoint
| Método |
Método
| POST |
POST
| Encabezados |
Encabezados
| Content-type: application/jsonCharset: utf-8Authorization: Bearer (token público) |
Content-type: application/json
Charset: utf-8
Authorization: Bearer (token público)
| Cuerpo |
Cuerpo
| {“templateId”: “iddeltemplate”,“phoneNumber”: “numerodetelefono”,“clientName”: “nombredelcliente”,“groupName”: “nombredelgrupo”,“assign”:true/false,“params”: {“param1”: “valor”,“param2”: “valor”,…},} |
{
“templateId”: “iddeltemplate”,
“phoneNumber”: “numerodetelefono”,
“clientName”: “nombredelcliente”,
“groupName”: “nombredelgrupo”,
“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 |
Número nuevo
| 200 |
200
| {success: true,message: "Pending"} |
{
success: true,
message: "Pending"
}
| Número existente |
Número existente
| 200 |
200
| {success: true,message: "Sent",data: {conversation_id : conversation.id }} |
{
success: true,
message: "Sent",
data: {conversation_id : conversation.id }
}
| Parámetros incorrectos |
Parámetros incorrectos
| 400 |
400
| {success: false,message: "No hay datos para enviar"} |
{
success: false,
message: "No hay datos para enviar"
}