Utilize nossa API de Templates na Atom
Esta API (sigla em inglês deApplication Programming Interface) permite a integração entre suas aplicações e o serviço de envio de Templates da Atom. Esta API permite:
Enviar um template.
Obter uma lista de templates.
Visualizar os detalhes de um template por meio do seu ID.
Endpoint: Templates – Envio de Template
Este serviço permite o envio deTemplate Messagesutilizando o número de WhatsApp Oficial e otemplateId.
Quando o número enviado já estiver vinculado a uma conversa, a mensagem será enviada na mesma e a confirmação de envio será imediata. Caso contrário, será aguardada a confirmação por meio do provedor de WhatsApp Oficial, portanto não será fornecida uma confirmação de envio imediata.
Parâmetros
A seguir explicamos os parâmetros que devem ser incluídos obrigatoriamente na requisição, e outros que podem ser adicionados opcionalmente:
| Nome do Parâmetro |
| Descrição |
| Tipo de Dado |
| Obrigatório |
| templateId |
| Identificador (ID) do Template Message da AtomChat |
| string |
| Sim |
| phoneNumber |
| Número de telefone para o qual o Template Message será enviado. Deve ser informado com o código do país, sem utilizar o sinal + |
| Correto: 50755667788 ✅ |
| Incorreto: +50555667788 ❌ |
| Incorreto: 55667788 ❌ |
| string |
| Sim |
| firstName |
| Nome do cliente |
| string |
| Sim |
| lastName |
| Sobrenome do cliente |
| string |
| Sim |
| assign |
| Indica se a conversa deve ser atribuída a um Agente (com valortrue). Caso contrário, será atribuída ao Bot |
| boolean |
| Não. O valor padrão éfalse |
| params |
| Coleção de parâmetros com seus respectivos valores necessários para o uso do Template Message |
| {key: value}object |
| Não |
A requisição para realizar o envio de Template Messages utilizando a API da AtomChat é realizada da seguinte forma:
Tipo de Conexão
Acesso público pela Internet
Endpoint
Método
POST
Cabeçalhos
Corpo
Respostas
Template enviado
Código:200
Template pendente de envio
Código:202
Parâmetros incorretos
Código:400
Faltam parâmetros obrigatórios do template
Código:400
Template sem ID ou sem mensagem definida
Código:400
Canal não conectado
Código:401
Token incorreto
Código:401
Limite de conversas do plano atingido
Código:401
Erro interno
Código:500
Endpoint: Get Template by ID – Ver detalhes de um template
Este serviço permite obter os detalhes de um template específico.
Endpoint
Método:GET
Respostas
Template recuperado
Código:200
Template inexistente
Código:404
Token incorreto
Código:400