Envio de Template

Caso você ainda não possua um Template criado e aprovado para uso, consulte a documentação sobre Template de WhatsApp para obter mais informações sobre como fazer esse procedimento.

O corpo da requisição deve conter um objeto JSON com os seguintes campos:

Campo	Obrigatório	Detalhes	Tipo
destinations	Sim	Detalhes sobre os identificadores do envio e destino	Destination[]
message	Sim	Detalhes sobre o objeto MESSAGE que será enviado	mensagem
defaultExtraInfo	Não	Dados adicionais que identificam a submissão que será relacionada a todos que receberem a mensagem	String
campaignAlias	Não	Campaign ID, é relacionada a todas as mensagens enviadas	String

Exemplo de requisição com Template

cURL

{
    "destinations": [{
            "correlationId": "MyCorrelationId",
            "destination": "5519900001111"      
  }],
    "message": {
        "template": {
            "namespace" : "aaaaaaaa_bbbb_cccc_dddd_eeeeeeeeeeee",
            "elementName" : "some_approved_image_hsm"
    },
    {  
            "languagePolicy": "DETERMINISTIC",
            "languageCode": "pt_BR"
      }
    }
}

Ruby

Python

PHP

Java

Destinations:

Campo	Obrigatório	Detalhes	Tipo
correlationId	Não	Id definido pelo cliente que será retornado no status da mensagem (callback). Você pode usar esse id para rastrear envios de mensagens de maneira personalizada.	String
destination	Sim	Número de telefone que receberá a mensagem (código do país (55 para Brasil) e DDD são obrigatórios). Exemplos: 5519900001111, [phone], [phone].	String

Message:

Campo	Obrigatório	Detalhes	Type
template	Sim	Detalhes sobre o objeto TEMPLATE que será enviado.	Template

Template:

Campo	Obrigatório	Detalhes	Tipo
elementName	Sim	Nome do modelo cadastrado e aprovado.	String
header	Sim, quando o Template possuir parâmetro no header	Objetos do cabeçalho com seus parâmetros	Header
bodyParameters	Sim (caso o template use variáveis)	A soma de todos os caracteres do corpo, considerando campos fixos e dinâmicos, é limitada a 1024 caracteres se o modelo registrado tiver apenas o corpo. É limitado a 160 caracteres se você tiver um cabeçalho ou rodapé.	Lista de strings
languageCode	Sim, quando houver mais de um idioma cadastrado para o mesmo template.	Codes: pt_BR, en, es, en_US, en_GB, pt_PT, es_AR, es_ES, es_MX, it, fr	String
buttons	Sim (Quando há no template)	A aprovação dos botões no template	Buttons

Exemplo de requisição de Template com Header e Parâmetros

cURL

{
  {
    "destinations": [{
            "correlationId": "MyCorrelationId",
            "destination": "5519900001111"      
  }],
    "message": {
        "template": {
            "namespace" : "aaaaaaaa_bbbb_cccc_dddd_eeeeeeeeeeee",
            "elementName" : "some_approved_image_hsm",
            "header": {
                "parameters": [
                    "header_parameter_1"
                ]
            },
            "bodyParameters": [
                "https://upload.wikimedia.org/wikipedia/commons/c/c3/Arquivo.jpg"
            ],
            "languagePolicy": "DETERMINISTIC",
            "languageCode": "pt_BR"
        }
    }
}

Ruby

Python

PHP

Java

Header

Campo	Obrigatório	Detalhes	Tipo
parameters	Opcional	Lista de parâmetros que serão substituídos no texto do cabeçalho. Nota: Caso esteja presente, o cabeçalho não deve ter título nem nenhum elemento.	String
title	Opcional	O título deve ter até 60 caracteres	String
(element)	Sim	Opções: text (padrão), image, audio, document, video.	Object

Element

Campo	Obrigatório	Detalhes	Tipo
url	Sim	URL da mídia. Use somente com URLs HTTP/HTTPS.	String
type	Sim	Tipo da midia (JPEG, MP3, PDF, etc)	String

Exemplo de requisição de Template com Header e Buttons do tipo Flows

cURL

{
    "destinations": [{
            "correlationId": "MyCorrelationId",
            "destination": "5519900001111"      
      }],
    "message": {
        "template": {
            "namespace" : "aaaaaaaa_bbbb_cccc_dddd_eeeeeeeeeeee",
            "elementName" : "some_approved_flow_template",
            "languageCode": "pt_BR",
            "languagePolicy": "DETERMINISTIC",
            "header": {
                "image": {
                    "type": "JPG",
                    "url": "https://some_image.jpg"
                }
            },
            "buttons": [
                {
                    "type":"FLOW",
                    "flowDetails": {
                        "type": "action",
                        "action": {
                            "flowToken": "some_token",
                            "flowActionData": "some_data"
                        }
                    }
                }
            ]
        }
    }
}

Ruby

Python

PHP

Java

Buttons

Campo	Obrigatório	Detalhes	Tipo
type	Sim	Tipo do botão (URL, QUICK_REPLY, CALL, ORDER_DETAILS, FLOW)	String
flowDetails	Sim se type for FLOW	Estrutura e conteúdo os detalhes do FLOW a ser iniciado.	flowDetails

FlowDetails

Campo	Obrigatório	Detalhes	Tipo
type	Sim	Define o tipo da ação do fluxo. Atualmente, o único valor suportado é action.	String
action	Sim	Objeto que contém os dados e o token do fluxo.	action

Action

Campo	Obrigatório	Detalhes	Tipo
flowToken	Opcional	Um token único para identificar a sessão deste fluxo específico. Se não for fornecido, um valor padrão "unused" será adicionado	String
flowActionData	Opcional	Conteúdo usado para pré-preencher dados nas telas do seu fluxo. É útil para iniciar o fluxo com informações contextuais (ex: nome do produto, detalhes de um pedido). Não necessário caso seu Flow consulte o ponto de extremidade para obter os dados através do INIT.	String