WhatsApp Templates API

Listar Message Templates
Requisição
https://apigw.wavy.global/api/v1/whatsapp_message_templates?page=1&page_size=999
A requisição pode conter os seguintes parâmetros na query string

Campo
Obrigatório
Descrição
page
não
Índice da página iniciando em 1
page_size
não
Resultados da página. 10 por padrão
element_name
não
Busca por template que contenhamelement_namecomo parte do nome
Exemplo de resposta
1
        {
2
  "data" : [
3
    {
4
      "message_type" : "RESERVATION_UPDATE",
5
      "customer_id" : 6364,
6
      "messages" : [
7
        {
8
          "buttons_type" : null,
9
          "id" : 33732,
10
          "buttons" : {
11
            "payload" : null
12
          },
13
          "language" : "pt_BR",
14
          "last_modified" : "2020-06-04T14:52:39.674403",
15
          "placeholders" : ["data"],
16
          "header" : "",
17
          "text" : "Olá, você tem um agendamento conosco para *{{1}}*.\nResponda *SIM* para confirmar ou *NÃO* para cancelar.",
18
          "header_type" : "none",
19
          "status" : "approved",
20
          "footer" : ""
21
        }
22
      ],
23
      "sub_account_id" : 11486,
24
      "last_modified" : "2020-06-04T14:52:39.665449",
25
      "id" : 22045,
26
      "element_name" : "lembrete_agendamento_datahora",
27
      "namespace" : "whatsapp:hsm:ecommerce:movile",
28
      "template_type" : "header_footer",
29
      "languages" : ["pt_BR"]
30
    },
31
    {
32
      "messages" : [
33
        {
34
          "status" : "approved",
35
          "footer" : "",
36
          "text" : "Você tem um agendamento conosco!",
37
          "header_type" : "none",
38
          "header" : "",
39
          "language" : "pt_BR",
40
          "placeholders" : [],
41
          "last_modified" : "2020-06-02T18:46:01.386517",
42
          "buttons" : {
43
            "payload" : null
44
          },
45
          "id" : 33649,
46
          "buttons_type" : null
47
        }
48
      ],
49
      "sub_account_id" : 11486,
50
      "customer_id" : 6364,
51
      "message_type" : "RESERVATION_UPDATE",
52
      "template_type" : "header_footer",
53
      "languages" : ["pt_BR"],
54
      "namespace" : "whatsapp:hsm:ecommerce:movile",
55
      "id" : 21964,
56
      "element_name" : "lembrete_agendamento",
57
      "last_modified" : "2020-06-02T18:46:01.384862"
58
    }
59
  ]
60
}
61
​
Copied!
A reposta retorna uma lista de message templates com os seguintes campos
Campo
Detalhes
Tipo
languages
Linguagens em que esse template está disponível
[String]
namespace
Namespace do template. Deve ser utilizado na API de envios
String
element_name
Nome do template. Deve ser utilizado na API de envios
String
message_type
Tipo de categoria do template. Valores possíveis são
ACCOUNT_UPDATE, PAYMENT_UPDATE, PERSONAL_FINANCE_UPDATE, SHIPPING_UPDATE, RESERVATION_UPDATE, ISSUE_RESOLUTION, APPOINTMENT_UPDATE, TRANSPORTATION_UPDATE, TICKET_UPDATE, ALERT_UPDATE, AUTO_REPLY

String
template_type
Tipo de template. Valores possíveis são
header_footer ou body_only
String
messages[]
Lista contendo um informações sobre cada tradução do template. O tamanho dessa lista é equivalente ao número de idiomas suportados em languages
[Object]
messages[].status
Status do template. Valores possíveis são:
in_analysis, approved, disapproved, error
Para que um template seja aprovado o conteúdo deve seguir as guidelines do Facebook. 
​https://developers.facebook.com/docs/whatsapp/message-templates/guidelines​
String
messages[].header_type
Tipo de header. Valores possíveis são
video, location, text, document, image ou none
String
messages[].header
Texto contido no header de text
Usado somente quando header_type = text
String
messages[].text
Texto contido no corpo
String
messages[].footer
Texto contido no footer
String
messages[].buttons_type
Tipos de botões. Valores possíveis são
quick_reply ou call_to_action
String
messages[].placeholders
Descrição dos placeholders presentes no texto do corpo, representados como {{1}}, {{2}}, etc. no campo text
[String]
messages[].buttons.payload
Conteúdo dos botões em formato JSON serializado como string.

Botões de quick reply estarão no formato 
{"payload": [{"text": "button text"}]}

Botões de call-to-action estarão no formato
{"payload": [{"url": "https:wavy.global/en", "text": "Acesso nosso site", "type": "url"}, {"text": "Ligue já", "type": "phone_number", "country_code": "55", "phone_number": "11900000000"}]}

String
Exemplos de Message Template
Template com header textual, body e footer:
Could not load image
Template com header de imagem, body e sem footer:
Could not load image
Template com 2 parâmetros:
Could not load image

WhatsApp API

WhatsApp Interactive API

Last modified 1yr ago

Copy link

Contents

Listar Message Templates

Exemplo de resposta

Exemplos de Message Template