Enviar Template Meta

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Campo vars

O campo vars é um objeto com as variáveis dinâmicas utilizadas pelo template informado.

Regras gerais

  • As chaves dentro de vars podem variar de acordo com o template cadastrado.
  • Em templates sem variáveis dinâmicas, o campo vars pode ser omitido.
  • Em templates com variáveis de substituição, o envio é recomendado conforme a configuração do template.
  • Em templates com mídia no cabeçalho, alguns campos especiais passam a ser obrigatórios.

Campos obrigatórios para templates com mídia no cabeçalho

Quando o template possuir cabeçalho com mídia, devem ser enviados os seguintes campos em vars:

  • __header_media_mode
  • __header_format
  • __header_media_url ou __header_media_base64
  • __header_document_name → obrigatório quando o formato da mídia for documento

Regras dos campos de mídia

  • __header_media_mode
    Define o modo de envio da mídia no cabeçalho.

  • __header_format
    Define o tipo da mídia do cabeçalho. Exemplos: image, video, document.

  • __header_media_url
    URL pública do arquivo de mídia.

  • __header_media_base64
    Conteúdo da mídia em Base64.

  • __header_document_name
    Nome do arquivo do documento. Obrigatório quando __header_format for document.

Observações importantes

  • Envie apenas um entre __header_media_url e __header_media_base64.
  • Para templates sem mídia no cabeçalho, esses campos especiais não precisam ser enviados.
  • Os demais campos de vars dependem das variáveis configuradas no template.
//Exemplo para template sem mídia

{
  "template_id": 434,
  "session": "NomeDaSession",
  "number": "556996107000",
  "vars": {
    "protocolo": "AT-123456",
    "mensagem": "atendimento disponível"
  }
}

//Exemplo para template com documento no cabeçalho
{
  "template_id": 436,
  "session": "NomeDaSession",
  "number": "556996107000",
  "vars": {
    "cliente": "Maria",
    "__header_media_mode": "keep",
    "__header_format": "DOCUMENT",
    "__header_media_url": "https://seudominio.com/arquivo.pdf",
    "__header_document_name": "contrato.pdf"
  }
}


Body Params
string
required
string
required
string
required

ID do Template previamente cadastrado

boolean
required
Defaults to false
vars
object

Variáveis dinâmicas do template

Headers
string
required
Response
200

OK

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!