Passar para o conteúdo principal

Como Enviar Mensagens de Template Utilizando a API do Atom?

Conecte seu sistema e envie Mensagens de Template do WhatsApp por API. Conheça os parâmetros, endpoints e respostas para automatizar suas notificações oficiais. 🚀

🛠️ Envio de Template Messages por API
Desde Atom, habilitamos nosso Endpoint dentro de Cloud Functions para permitir o envio automatizado de plantillas utilizando seu número oficial de WhatsApp e o identificador de sua plantilla (templateId).
Como funciona a confirmação de envio?
​

  • Contatos existentes: Se o número já está vinculado a uma conversa em Atom, a mensagem será enviada sobre a mesma e a confirmação será imediata.

  • Contatos novos: Se o número não tem histórico, será aguardada a confirmação do provedor oficial de WhatsApp, portanto o estado inicial será reportado como pendente.

📝 Parâmetros da Petição
A continuação, detalhamos os parâmetros que deve incluir em seu código para estruturar o envio:
​

Parâmetro

Descrição

Tipo de Dado

Requerido

templateId

Identificador (Id) do Template Message de AtomChat.

string

Sim

phoneNumber

Número de telefone destino. Deve incluir o código de país sem usar o sinal +.
✅ Correto: 50755667788
❌ Incorretos: +50555667788, 55667788

string

Sim

clientName

Nome do cliente ao qual será enviada a mensagem.

string

Não (Por padrão: número de telefone)

groupName

Nome do grupo ao qual será atribuído o chat.

string

Não (Por padrão: primeiro grupo da integração)

assign

Indica se é atribuído diretamente a um Agente (true).

boolean

Não (Por padrão: false, é atribuído ao Bot)

params

Coleção de variáveis e valores requeridos pela plantilla.

object

Não

🌐 Estrutura do Request (Petição)


Para realizar o envio através de nossa API, utilize a seguinte estrutura técnica:
​

Encabezados (Headers):

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

Corpo da petição (JSON Body):

{
  "templateId": "id_do_template",
  "phoneNumber": "50755667788",
  "clientName": "Nome do cliente",
  "groupName": "Nome do grupo",
  "assign": true,
  "params": {
    "param1": "valor_1",
    "param2": "valor_2"
  }
}

📨 Respostas Esperadas (Responses)


Ao executar a petição de forma exitosa (Código HTTP 200), o sistema retornará um dos seguintes JSON, dependendo do estado do contato:


​Cenário 1: Número novo (Aguardando confirmação do provedor)

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

Cenário 2: Número existente (Confirmação de envio imediata)

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

Automatize sua comunicação em grande escala! 🚀

Ao integrar o envio de plantillas através da API de Atom, você garante que suas notificações e alertas cheguem de forma segura aos seus clientes. Utilize esta estrutura para conectar seu CRM ou sistema interno e otimize seus fluxos de contato. ✅
​
​

Artigos relacionados
Respondeu à sua pergunta?