Passar para o conteúdo principal

🧩 Como usar a API de Modelos no Atom?

Integre seus apps com a API de Modelos do Atom. Aprenda a enviar mensagens de WhatsApp, listar modelos e consultar detalhes por ID de forma automatizada e segura. 🚀

🌐 API de Modelos de Atom (Template Messages)


A API de Modelos permite conectar suas aplicações internas com Atom para automatizar o envio de mensagens pré-aprovadas pelo WhatsApp.
Ambientes disponíveis:

  • Produção: Para clientes finais e operações reais.
    https://us-central1-atomchat-io.cloudfunctions.net/templates

  • IA: Ambiente alternativo para integrações específicas.
    https://us-central1-atom-ai.cloudfunctions.net/templates


1️⃣ Enviar um Modelo (Template Message)


Este serviço envia uma mensagem usando seu número oficial e o ID do modelo. Se o cliente já possui um chat ativo, o envio é confirmado instantaneamente; se for um contato novo, a mensagem fica "pendente" até que a Meta a confirme.

  • Método: POST

  • Cabeçalhos (Headers):
    Content-type: application/json
    Charset: utf-8
    Authorization: Bearer (seu_token_público)

Parâmetros do Body (JSON):

Parâmetro

Descrição

Tipo

Obrigatório

templateId

ID do Template Message do AtomChat.

string

Sim

phoneNumber

Telefone de destino com código de país, sem o sinal + nem espaços (Ex: 50755667788).

string

Sim

clientName

Nome do cliente (por padrão utiliza o telefone).

string

Opcional

groupName

Grupo ao qual o chat será atribuído.

string

Opcional

assign

true para atribuir a um agente, false para o bot.

boolean

Opcional

params

Objeto com as variáveis do modelo (Ex: {"param1": "valor"}).

object

Opcional


Respostas comuns (Códigos HTTP):

  • 200: Enviado com sucesso.

  • 202: Pendente de envio (contato novo).

  • 400: Faltam parâmetros ou dados incorretos na requisição.

  • 401: Canal não conectado, token inválido ou limite de conversas atingido.

  • 500: Erro interno do servidor.


2️⃣ Listar Modelos


Permite recuperar uma lista de todos os modelos ativos disponíveis no canal associado ao seu token.

  • Método: GET

  • Endpoint (Exemplo Produção): https://us-central1-atomchat-io.cloudfunctions.net/templates?page=1&size=1000&sort=asc

  • Parâmetros de URL (Opcionais): page (página atual), size (quantidade de resultados) e sort (ordem asc ou desc).

  • Cabeçalhos: Mesmos do método POST.


3️⃣ Obter Modelo por ID


Recupera os detalhes completos de um modelo específico.

  • Método: GET

  • Endpoint (Exemplo Produção): https://us-central1-atomchat-io.cloudfunctions.net/templates/{templateId} (Substitua {templateId} pelo ID real).

  • Cabeçalhos: Mesmos do método POST.


⚠️ Considerações Finais

  • Valide o ambiente: Certifique-se de estar usando o endpoint correto (Produção vs. IA) conforme o estágio do seu desenvolvimento.

  • Formato do telefone: O erro mais comum ocorre ao enviar o phoneNumber. Lembre-se: sem o sinal + e sem espaços.

  • Leitura de erros: Se receber um erro 400 ou 401, verifique o corpo da resposta, pois o sistema indicará exatamente qual parâmetro falta ou se há problemas com seu token de autorização.


Leve sua comunicação para o próximo nível! 🚀

Ao utilizar a API de Modelos, você pode integrar Atom diretamente com seu CRM, ERP ou sistema interno para disparar alertas, confirmações e lembretes em massa sem intervenção manual. Certifique-se de estruturar bem seus JSONs e sempre valide seus tokens de conexão. ✅

Respondeu à sua pergunta?