Skip to main content
Endpoint · GET /templates/{name}/{language}
Endpoint de somente consulta: retorna informação e não modifica nada. Não é enviado dentro do array actions — você o chama diretamente.
Retorna o detalhe de um template aprovado, identificado pela sua chave natural (name, language) — a mesma que a Meta usa e a que você vê no dashboard. Além do status e da categoria, a resposta traz o bloco parameters já calculado: quais variáveis o corpo leva, se o cabeçalho espera um parâmetro e quais botões URL aceitam um valor dinâmico. É esse o valor da consulta: a Meta serializa os marcadores ({{1}}, {{2}}, …) dentro da estrutura components do template, e aqui eles chegam já interpretados. Não é preciso fazer o parse do formato da Meta para saber o que preencher. O fluxo típico é ler primeiro e agir depois: você consulta o que o template espera e então envia a ação com os valores no lugar.
Os templates são criados e aprovados no dashboard, e é lá que aparecem o nome e o idioma de cada um. Esta referência não publica a lista completa de templates do negócio, portanto o nome você tira do dashboard.
Parâmetros Os três vão na rota. Não há parâmetros de query.
  • slug — identificador do negócio na URL (obrigatório). Deve coincidir com o negócio do token.
  • name — nome do template exatamente como aparece no dashboard (obrigatório). Alfanumérico e underscore. Qualquer combinação de maiúsculas e minúsculas é aceita: o servidor normaliza para minúsculas.
  • language — código de idioma da Meta (obrigatório): es, es_MX, en_US, pt_BR. O servidor normaliza para o formato lower_UPPER.

Resposta

  • status — status na Meta. A API pública expõe somente templates APPROVED.
  • category — categoria da Meta: MARKETING, UTILITY ou AUTHENTICATION.
  • body_text — o corpo aprovado, com seus marcadores. Pode ser null.
  • parameters.body_variables — uma entrada por marcador do corpo, com o index (posição a partir de 1) e o example carregado na Meta ao aprovar o template (null se não houver). Array vazio quando o corpo não leva variáveis.
  • parameters.header_parametertype (text, image, video ou document) e example. É null quando o cabeçalho não espera nenhum parâmetro.
  • parameters.button_parameters — somente os botões URL com marcador: o index do botão, o sub_type (url) e o example. Os botões de resposta rápida não aparecem aqui.

Exemplo

Uma leitura única, sem efeitos: o GET não envia nada nem toca a conversa, apenas retorna o que o template espera.
Com essa resposta você já sabe que o corpo leva duas variáveis, então a ação de envio fica assim:

Erros

Os códigos comuns de autenticação, permissões e limite de taxa estão em Erros. Os dados que esta consulta retorna alimentam o campo template das ações de envio: Enviar mensagem e Enviar resposta rápida ou template. O conceito de template e a janela de 24 horas estão em Templates.