Ir al contenido principal

¿Cómo Enviar Templates Messages Utilizando la API de Atom?

Conecta tu sistema y envía Template Messages de WhatsApp por API. Conoce los parámetros, endpoints y respuestas para automatizar tus notificaciones oficiales. 🚀

🛠️ Envío de Template Messages por API
Desde Atom, habilitamos nuestro Endpoint dentro de Cloud Functions para permitir el envío automatizado de plantillas utilizando tu número oficial de WhatsApp y el identificador de tu plantilla (templateId).
¿Cómo funciona la confirmación de envío?

  • Contactos existentes: Si el número ya está vinculado a una conversación en Atom, el mensaje se enviará sobre la misma y la confirmación será inmediata.

  • Contactos nuevos: Si el número no tiene historial, se esperará la confirmación del proveedor oficial de WhatsApp, por lo que el estado inicial se reportará como pendiente.

📝 Parámetros de la Petición
A continuación, detallamos los parámetros que debes incluir en tu código para estructurar el envío:

Parámetro

Descripción

Tipo de Dato

Requerido

templateId

Identificador (Id) del Template Message de AtomChat.

string

phoneNumber

Número de teléfono destino. Debe incluir el código de país sin usar el signo +.
✅ Correcto: 50755667788
❌ Incorrectos: +50555667788, 55667788

string

clientName

Nombre del cliente al que se le enviará el mensaje.

string

No (Por defecto: número de teléfono)

groupName

Nombre del grupo al que se asignará el chat.

string

No (Por defecto: primer grupo de la integración)

assign

Indica si se asigna directamente a un Agente (true).

boolean

No (Por defecto: false, se asigna al Bot)

params

Colección de variables y valores requeridos por la plantilla.

object

No



🌐 Estructura del Request (Petición)


Para realizar el envío a través de nuestra API, utiliza la siguiente estructura técnica:

Encabezados (Headers):

Content-type: application/json
Charset: utf-8
Authorization: Bearer (tu_token_público)

Cuerpo de la petición (JSON Body):

{
"templateId": "id_del_template",
"phoneNumber": "50755667788",
"clientName": "Nombre del cliente",
"groupName": "Nombre del grupo",
"assign": true,
"params": {
"param1": "valor_1",
"param2": "valor_2"
}
}

📨 Respuestas Esperadas (Responses)


Al ejecutar la petición de forma exitosa (Código HTTP 200), el sistema te devolverá uno de los siguientes JSON, dependiendo del estado del contacto:


Escenario 1: Número nuevo (Esperando confirmación del proveedor)

{
"success": true,
"message": "Pending"
}

Escenario 2: Número existente (Confirmación de envío inmediata)

{
"success": true,
"message": "Sent",
"data": {
"conversation_id": "conversation.id"
}
}

¡Automatiza tu comunicación a gran escala! 🚀

Al integrar el envío de plantillas a través de la API de Atom, garantizas que tus notificaciones y alertas lleguen de manera segura a tus clientes. Utiliza esta estructura para conectar tu CRM o sistema interno y optimiza tus flujos de contacto. ✅

¿Ha quedado contestada tu pregunta?