VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: campanhas

Templates da Meta

Lê os modelos de mensagem aprovados na Meta e os modelos recomendados pela plataforma.

Um template é um modelo de mensagem que a Meta precisa aprovar antes do uso. Ele é a única forma de falar com um cliente fora da janela de 24 horas, e a base de toda campanha. Tem categoria (UTILITY para avisos transacionais, MARKETING para promoções, AUTHENTICATION para códigos) e variáveis numeradas ({{1}}, {{2}}). Estas rotas leem; para criar e gerenciar, veja Templates gerenciados.

Listar templates da Meta

Consulta a Meta ao vivo e devolve até 100 templates da conta, com status e componentes.

GET/api/v1/admin/whatsapp/templatesAdmin

Lista os templates da conta WhatsApp Business da loja

Exemplo de requisição (Listar templates da Meta)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/templates" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Listar templates da Meta)

200Templates
json
{
  "templates": [
    {
      "name": "order_confirmation",
      "language": "pt_BR",
      "status": "APPROVED",
      "category": "UTILITY",
      "components": [
        {
          "type": "BODY",
          "text": "Seu pedido {{1}} foi recebido. Total: {{2}}."
        }
      ]
    }
  ],
  "total": 1
}

Campos da resposta

templatesarray

Templates da conta.

namestring
Nome do template (minúsculas e sublinhado).
languagestring
Idioma, por exemplo pt_BR.
statusstring
Situação na Meta: APPROVED, PENDING ou REJECTED (a Meta pode devolver outros valores, como PAUSED).
categorystring
UTILITY, MARKETING ou AUTHENTICATION.
componentsarray
Estrutura: cabeçalho, corpo (BODY), rodapé e botões, no formato da Meta.
totalinteger
Quantidade devolvida.

Erros (Listar templates da Meta)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
502A Meta falhou ou recusou a consulta. O corpo traz code (whatsapp.templates.meta_unavailable ou whatsapp.templates.unknown), error, detail e graph_code.{"code":"whatsapp.templates.unknown","error":"Could not load templates from Meta.","detail":"...","http_status":400,"graph_code":100}
503A loja ainda não configurou a API (whatsapp.templates.not_configured) ou o token é inválido (whatsapp.templates.token_invalid).{"code":"whatsapp.templates.not_configured","error":"..."}
Só os 100 primeiros

A plataforma pede à Meta no máximo 100 templates e não pagina. Contas com mais que isso não veem o excedente aqui.

Modelos recomendados

Devolve um catálogo estático de modelos que a plataforma recomenda cadastrar (boas-vindas com link da loja, carrinho abandonado e outros), com o texto de exemplo e o botão sugerido, mais o catálogo de variáveis. Não consulta a Meta.

GET/api/v1/admin/whatsapp/templates/modelsAdmin

Lista modelos prontos de template e as variáveis disponíveis

Exemplo de requisição (Modelos recomendados)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/templates/models" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Modelos recomendados)

200Modelos
json
{
  "models": [
    {
      "slug": "welcome_store_link",
      "suggested_name": "venddor_welcome_loja",
      "language": "pt_BR",
      "category": "UTILITY",
      "use_case_pt": "Boas-vindas com link da loja (mini-shop)",
      "use_case_en": "Welcome with personalized store link",
      "body_example": "Olá{{1}}! Bem-vindo(a) à *{{2}}*.",
      "body_param_hints": [
        "{{customer_name}}",
        "{{vendor_name}}"
      ],
      "has_url_button": true,
      "url_button_base": "/wa/{{1}}",
      "url_button_label": "Ver loja",
      "cta_purpose": "store"
    }
  ],
  "var_catalog": [
    {
      "key": "store_link",
      "label_pt": "Link da loja (mini-shop)",
      "label_en": "Store mini-shop link",
      "example": "https://loja.../wa/{token}"
    }
  ],
  "meta_url": "https://business.facebook.com/wa/manage/message-templates/"
}

Campos da resposta

modelsarray

Modelos recomendados.

slugstring
Identificador estável do modelo.
suggested_namestring
Nome sugerido para cadastrar na Meta.
languagestring
Idioma.
categorystring
Categoria sugerida.
use_case_ptstring
Para que serve, em português.
use_case_enstring
Para que serve, em inglês.
body_examplestring
Texto de exemplo com as variáveis.
body_param_hintsarray
Que variável da plataforma preencher em cada {{n}}.
has_url_buttonboolean
O modelo espera um botão de link dinâmico.
url_button_basestring
Padrão do link do botão (sem o domínio).
url_button_labelstring
Texto do botão.
cta_purposestring
Para onde o botão leva: store, cart ou checkout.
notes_ptstring
Orientação em português.
notes_enstring
Orientação em inglês.
var_catalogarray
Variáveis disponíveis (key, label_pt, label_en, example).
meta_urlstring
Endereço do gerenciador de templates da Meta.

Erros (Modelos recomendados)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}

Veja também

  • Templates gerenciados
  • Criar campanha
Anterior
Gerenciar campanhas
Próxima
Templates gerenciados
Nesta página
  • Listar templates da Meta
  • Exemplo de requisição (Listar templates da Meta)
  • Resposta (Listar templates da Meta)
  • Erros (Listar templates da Meta)
  • Modelos recomendados
  • Exemplo de requisição (Modelos recomendados)
  • Resposta (Modelos recomendados)
  • Erros (Modelos recomendados)
  • Veja também