```html
Como Enviar Mensagens de Template Utilizando a API do Atom?
A partir do Atom, habilitamos nosso Endpoint dentro do Cloud Functions para permitir o envio de Mensagens de Template utilizando seu número de WhatsApp Oficial e o templateId. Quando o número enviado já estiver vinculado a uma conversa, a mensagem será enviada sobre a mesma e a confirmação de envio será imediata. Caso contrário, será aguardada a confirmação por meio do provedor de WhatsApp Oficial, pelo qual não será fornecida uma confirmação de envio imediata.
A seguir, explicamos os parâmetros que devem ser incluídos obrigatoriamente dentro da solicitação, e outros que podem ser adicionados opcionalmente:
| Nome do Parâmetro |
| Descrição |
| Tipo de Dado |
| Requerido |
| templateId |
templateId
| Identificador (Id) da Mensagem de Template do AtomChat. |
Identificador (Id) da Mensagem de Template do AtomChat.
| string |
string
| Sim |
Sim
| phoneNumber |
phoneNumber
| Número de telefone para o qual a Mensagem de Template será enviada. O código do país deve ser adicionado, sem usar o sinal +
Correto: 50755667788 ✅
Incorreto: +50555667788❌
Incorreto: 55667788 ❌ |
Número de telefone para o qual a Mensagem de Template será enviada. O código do país deve ser adicionado, sem usar o sinal+
Correto:50755667788 ✅
Incorreto: +50555667788❌
Incorreto:55667788 ❌
| string |
string
| Sim |
Sim
| clientName |
clientName
| Nome do cliente para o qual a Mensagem de Template será enviada. |
Nome do cliente para o qual a Mensagem de Template será enviada.
| string |
string
| Não. O valor padrão será o número de telefone. |
Não. O valor padrão será o número de telefone.
| groupName |
groupName
| Nome do grupo a ser atribuído. |
Nome do grupo a ser atribuído.
| string |
string
| Não. O valor padrão é obtido do primeiro grupo associado à integração. |
Não. O valor padrão é obtido do primeiro grupo associado à integração.
| assign |
assign
| Indica se a conversa deve ser atribuída a um Agente (com o valor true). Caso contrário, é atribuída ao Bot. |
Indica se a conversa deve ser atribuída a um Agente (com o valor true). Caso contrário, é atribuída ao Bot.
| boolean |
boolean
| Não. O valor padrão é false. |
Não. O valor padrão é false.
| params |
params
| Coleção de parâmetros com seus valores necessários para o uso da Mensagem de Template. |
Coleção de parâmetros com seus valores necessários para o uso da Mensagem de Template.
| object |
object
| Não |
Não
A solicitação para enviar Mensagens de Template usando a API do AtomChat é feita da seguinte forma:
| Tipo de Conexão |
Tipo de Conexão
| Acesso público pela Internet |
Acesso público pela Internet
| Endpoint |
Endpoint
| Método |
Método
| POST |
POST
| Cabeçalhos |
Cabeçalhos
| Content-type: application/jsonCharset: utf-8Authorization: Bearer (token público) |
Content-type: application/json
Charset: utf-8
Authorization: Bearer (token público)
| Corpo |
Corpo
| {“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”,
…
},
}
As respostas esperadas para a solicitação feita são as seguintes:
| Cenário |
| Código de Resposta |
| Corpo da Resposta |
| Novo número |
Novo número
| 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 incorretos |
Parâmetros incorretos
| 400 |
400
| {success: false,message: "No hay datos para enviar"} |
{
success: false,
message: "No hay datos para enviar"
}
```