Atualizada: 08/08/2024

[POST] /waTemplates


[POST] /waTemplates


Mirar:

Use este serviço para criar um novo modelo de WhatsApp

Exemplo de CURL:

curl --location --request POST 'go.botmaker.com/api/v1.0/waTemplates/' \

--header 'Tipo de conteúdo: aplicativo/json' \

--header 'Aceitar: aplicação/json' \

--header 'token de acesso: TOKEN DE ACESSO' \

--data-raw '{

           "botões": [],

           "optInImage": "https://storage.googleapis.com/m-infra.appspot.com/public/res/SoporteBotmaker/20210818-hnFCAbAtiaVneNafwub7cBZaFPS2-UUHZ3-.png",

           "localidade": "es_AR",

           "content": "Olá, obrigado por tudo",

           "mediaHeaderText": "",

           "mediaFooterText": "",

           "nome": "test_create_temp_API",

           "mediaHeaderType": "imagem",

           "category": "Atualização da conta"

       }

'

Campos importantes:

  • botões
  • local
  • categoria
  • optinImage
  • contente

Tipos de botão:

Primeiro tipo:RESPOSTA RÁPIDA Esses botões são usados ​​para executar uma intenção dentro do bot, ou enviar um texto se for um cliente API. Você pode criar até3.

Se você é um cliente API, você deverá preencher os seguintes campos:

  • “texto”: Texto que o botão terá
  • “type”: Deve ter o tipo QUICK_REPLY
  • “responseId”: A mensagem que o bot responde quando o botão é pressionado.

E não você é um cliente API:

  • “texto”: Texto que o botão terá
  • “type”: Deve ter o tipo QUICK_REPLY
  • “intenção”: O id da intenção de execução.

Considerações se você for um cliente API:

Você pode utilizar os botões para enviar o responseID definido no seu webhook configurado no Botmaker quando houver cliques do usuário. Desta forma, você poderá analisar quando os usuários clicam nas opções e programar respostas/envios automáticos em seu sistema dependendo do responseID recebido.

Usar: O campo responseID não aceita variáveis, deve ser utilizado apenas com mensagens de texto

Exemplo sem API:

"botões": [

               {

                   "texto": "sentado",

                   "tipo": "QUICK_REPLY",

                   "intenção": "BotmakerTesting-327f05674554c@bm.com-1611242990470",

                   "respostaId": ""

               },

           ],

Exemplo de API:

"botões": [

               {

                   "texto": "sentado",

                   "tipo": "QUICK_REPLY",

                   "intenção": "",

                   "responseId": "olá"

               },

           ],

Segundo tipo, CHAMADA À AÇÃO: Esses botões oferecem a possibilidade de adicionar botões que permitem ligar para um número de telefone ou levá-lo a um URL. Esses dois tipos de botões não podem ser misturados com um do tipo QUICK_REPLY. Neste caso você não pode ter mais do que 2 botões.

Os campos são, no caso de um botão chamado, os seguintes:

  • “phone_number”: Número de telefone para ligar
  • “texto”: texto do botão
  • “type”: Tipo do botão, neste caso “PHONE_NUMBER”

No caso de ser um dos URL:

  • “url”: URL da página para a qual o usuário será direcionado
  • “texto”: texto do botão
  • “type”: Tipo de botão, neste caso “URL”

Por exemplo:

"botões": [

              {

                   "número_telefone": "+5491155640000",

                   "text": "Ligar para o suporte",

                   "tipo": "PHONE_NUMBER"

               },

               {

                   "texto": "Eu sou um Google",

                   "tipo": "URL",

                   "url": "www.google.com"

               }

           ],

Exemplo de erro. Neste caso você não pode misturar tipos de botões:

"botões": [

               {

                   "texto": "Saudações",

                   "tipo": "QUICK_REPLY",

                   "intenção": "BotmakerTesting-327f0567455b4c@bm.com-1611242990470",

                   "respostaId": ""

               },

               {

                   "texto": "Eu sou um Google",

                   "tipo": "URL",

                   "url": "www.google.com"

               }

           ],

Validações locais:

A localidade refere-se ao idioma do modelo e é validada na listagem a seguir:

Idiomas permitidos:

       de,

       quadrado,

       Com,

       o,

       bilhões,

       obrigado,

       que,

       zh_CN,

       zh_HK,

       zh_TW,

       hora,

       cs,

       e,

       em,

       pt_GB,

       em nós,

       E,

       ser,

       franco,

       de,

       ele,

       para,

       ele,

       oi,

       ei,

       eu ia,

       em,

       para,

       isto,

       e,

       sabe,

       kkkkk,

       é,

       isto,

       eu,

       isso,

       mk,

       EM,

       senhor,

       não,

       mas,

       por favor,

       pt_BR,

       pt_PT,

       então,

       ro,

       ru,

       é,

       pt_AR,

       es_MX,

       pt_ES

   }

Categoria:

Categoria de modelo, pode ser uma das seguintes:

       CONTA_UPDATE,

       PAYMENT_UPDATE,

       PERSONAL_FINANCE_UPDATE,

       SHIPPING_UPDATE,

       RESERVATION_UPDATE,

       RESOLUÇÃO DE PROBLEMAS,

       APPOINTMENT_UPDATE,

       TRANSPORTATION_UPDATE,

       TICKET_UPDATE,

       ALERT_UPDATE,

       RESPOSTA AUTOMATICA

optinImagem:

Muito importante, passe o link de uma imagem para o campo optinImage que contém o optIn.

O que é optIn?

É uma imagem, com algum modelo de formulário, que mostra que em alguma página ou aplicativo está sendo solicitado aos clientes o consentimento para receber mensagens proativamente via WhatsApp.

Contente:

Lembrar: você tem um limite de 1.024 caracteres ou 160 caracteres se tiver um cabeçalho ou rodapé. E não pode incluir novas linhas, tabulações ou mais de quatro espaços consecutivos.

O texto pode estar em:Negrito- Para deixar sua mensagem em negrito, coloque um asterisco em cada lado do texto.

Itálico- Para deixar sua mensagem em itálico, coloque um sublinhado em cada lado do texto.

Tachado: para riscar sua mensagem, coloque uma marca de seleção em cada lado do texto

Monoespaçado: para deixar um texto monoespaçado, coloque três frases de cada lado do texto.

Emojis

Variáveis- Devem começar com $ e conter o nome da variável entre chaves, como no exemplo abaixo. Exemplo: ${nome}

Status do modelo:

Depois que o modelo é criado, ele passa por diversos estados até ser finalmente aprovado.

Estados:

botmakerPending: O modelo está pendente de envio para o Facebook.accountPending: O modelo contém algum erro e precisa ser modificado pela empresa. Nestes casos, o erro será encontrado no notas do modelo. O modelo deve ser corrigido e regenerado usando este serviço.facebookPending: O template foi enviado ao Facebook e aguarda validação.Approved: O modelo foi aprovado e está pronto para ser enviado.Rejected: O modelo foi rejeitado e não pode ser usado.