Links

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

{
"data" : [
{
"message_type" : "RESERVATION_UPDATE",
"customer_id" : 6364,
"messages" : [
{
"buttons_type" : null,
"id" : 33732,
"buttons" : {
"payload" : null
},
"language" : "pt_BR",
"last_modified" : "2020-06-04T14:52:39.674403",
"placeholders" : ["data"],
"header" : "",
"text" : "Olá, você tem um agendamento conosco para *{{1}}*.\nResponda *SIM* para confirmar ou *NÃO* para cancelar.",
"header_type" : "none",
"status" : "approved",
"footer" : ""
}
],
"sub_account_id" : 11486,
"last_modified" : "2020-06-04T14:52:39.665449",
"id" : 22045,
"element_name" : "lembrete_agendamento_datahora",
"namespace" : "whatsapp:hsm:ecommerce:movile",
"template_type" : "header_footer",
"languages" : ["pt_BR"]
},
{
"messages" : [
{
"status" : "approved",
"footer" : "",
"text" : "Você tem um agendamento conosco!",
"header_type" : "none",
"header" : "",
"language" : "pt_BR",
"placeholders" : [],
"last_modified" : "2020-06-02T18:46:01.386517",
"buttons" : {
"payload" : null
},
"id" : 33649,
"buttons_type" : null
}
],
"sub_account_id" : 11486,
"customer_id" : 6364,
"message_type" : "RESERVATION_UPDATE",
"template_type" : "header_footer",
"languages" : ["pt_BR"],
"namespace" : "whatsapp:hsm:ecommerce:movile",
"id" : 21964,
"element_name" : "lembrete_agendamento",
"last_modified" : "2020-06-02T18:46:01.384862"
}
]
}
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.
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:
Template com header de imagem, body e sem footer:
Template com 2 parâmetros: