Mensagens

/v1/messages

Use o nó messages para enviar aos clientes mensagens de texto e de mídia, mensagens interativas, contatos, localizações, bem como modelos de mensagens.

Confira os guias a seguir para obter informações sobre os tipos específicos de mensagens que você pode enviar: mensagens de texto, mensagens de mídia, mensagens com contatos e localização, mensagens interativas, modelos de mensagem, modelos de mensagem de mídia e modelos de mensagem interativa.

Antes de começar

Você precisará fazer o seguinte:

• Autenticar-se e obter um token de autenticação que permita o acesso ao serviço. Consulte a documentação sobre login e autenticação para ver mais informações sobre como fazer isso.
• Verificar a conta do WhatsApp para a qual você quer enviar mensagens e obter o número de identificação do usuário do WhatsApp correspondente. A documentação Contatos explica como fazer isso.
• Atender aos requisitos de serviço de controle de limite para mensagens.

Limitações

• Os seguintes tipos de mensagem são compatíveis: mensagens de texto, modelos de mensagem, imagens, documentos e áudio.
• Uma mensagem de texto pode ter no máximo 4.096 caracteres.

Criação

Para enviar mensagens, faça uma chamada POST ao nó /messages, independentemente do tipo de mensagem. O conteúdo do corpo da mensagem JSON é diferente para cada tipo de mensagem (teto, imagem etc.).

Parâmetros

Estes são os principais parâmetros usados em solicitações POST de /messages:

Objeto text

Objeto media

Para a API Local, o ID do objeto é retornado quando a mídia é carregada com sucesso no cliente local/de referência da WhatsApp Business API por meio do ponto de extremidade media.

Objeto contacts

Em contacts, é possível aninhar estes objetos: addresses, emails, name, org, phone e urls. Os objetos pluralizados devem ser agrupados em uma matriz, conforme mostrado no exemplo abaixo.

Veja o exemplo de um objeto contacts com objetos pluralizados aninhados:

"contacts": [
    {
        "addresses": [
            {
                "city": "city name",
                "country": "country name",
                "country_code": "code",
                "state": "Contact's State",
                "street": "Contact's Street",
                "type": "Contact's Address Type",
                "zip": "Contact's Zip Code"
            }
        ],
        "birthday": "birthday",
        "emails": [
            {
                "email": "email",
                "type": "HOME"
            },
            {
                "email": "email",
                "type": "WORK"
            }
        ],
        "name": {
            "first_name": "first name value",
            "formatted_name": "formatted name value",
            "last_name": "last name value",
            "suffix": "suffix value"
        },
        "org": {
            "company": "company name",
            "department": "dep name",
            "title": "title"
        },
        "phones": [
            {
                "phone": "Phone number",
                "wa-id": "WA-ID value",
                "type": "MAIN"
            },
            {
                "phone": "Phone number",
                "type": "HOME"
            },
            {
                "phone": "Phone number",
                "type": "WORK"
            }
        ],
        "urls": [{
            "url": "some url",
            "type": "WORK"
        }]
    }
]

Objeto location

Objeto template

Em template, é possível aninhar os objetos components e language.

Objeto components

Em components, é possível aninhar o objeto parameters. Além disso, é possível definir type como button.

Objeto do parâmetro

Tipo de botão

No objeto components, é possível definir type como button. Estes são os parâmetros de botão:

Veja o exemplo do tipo button com sub_type quick_reply:

 {
    "type": "button",
    "sub_type": "quick_reply",
    "index": 0,
    "parameters": 
     [{
    	"type": "payload",
    	"payload": "Yes-Button-Payload"
     }]
 } 

Veja o exemplo do tipo button com sub_type copy_code:

    
 { 
    "type": "button", 
    "sub_type": "copy_code", 
    "index": 0, 
    "parameters": 
    [{ 
     "type": "coupon_code", 
     "coupon_code": "DISCOUNT20" 
    }] 
 }

Objeto hsm

Objeto interactive

Objeto action

Exemplos

Mensagens de áudio:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio",
  "audio": {
      "id": "your-media-id",
  }
}

Mensagens de documento com filename:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "id": "your-media-id",
      "filename": "your-document-filename"
  }
}

Mensagens de documento com link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }     
    }
}

Mensagens de vídeo com link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "video",  
  "video": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }
    }
  }
}

Mensagem de texto:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "text",
  "text": {
      "body": "your-message-content"
  }
}

Mensagens interativas (listas):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive":{
    "type": "list",
    "header": {
      "type": "text",
      "text": "your-header-content-here"
    },
    "body": {
      "text": "your-text-message-content-here"
    },
    "footer": {
      "text": "your-footer-content-here"
    },
    "action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }
  }

}

Mensagens interativas (botões de resposta):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": { # optional
      "type": "text" | "image" | "video" | "document",
      "text": "your text"
      # OR
      "document": {
        "id": "your-media-id",
        "filename": "some-file-name"
      }
      # OR
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name",
        },
        "filename": "some-file-name"
      },
      # OR
      "video": {
        "id": "your-media-id"
      }
      # OR
      "video": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
      # OR
      "image": {
        "id": "your-media-id"
      }
      # OR
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    }, # end header
    "body": {
      "text": "your-text-body-content"
    },
    "footer": { # optional
      "text": "your-text-footer-content"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    } # end action   
  } # end interactive

}

Mensagens interativas (de produto único e de vários produtos):

{ 
  "recipient_type": "individual",
  "to" : "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "body text"
    },
    "footer": {
      "text": "footer text"
    },
    "action": {
      "
      
      _id": "catalog-ID",
      "product_retailer_id": "product-ID"
    }
  }
}

Mensagens interativas (multiproduto):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "product_list",
    "Header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }
}

Mensagens interativas (catálogo):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "catalog_message",
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "name": "catalog_message",
      	"parameters":{ 
      	  "thumbnail_product_retailer_id": "product-SKU-in-catalog"
      	}
     },  
    }
}

Mensagens interativas (Flows):

{
  "recipient_type": "individual",
  "to": "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "flow",
    "header": {
      "type": "text",
      "text": "Flow message header"
    },
    "body": {
      "text": "Flow message body"
    },
    "footer": {
      "text": "Flow message footer"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
        "flow_id": "<FLOW_ID>",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_ID>",
          "data": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }
  }
}

Veja a seguir um exemplo de payload em uma resposta. Os objetos "error" e "meta" foram omitidos por questões de concisão.

{
  "messages": [{ 
    "id": "message-id" 
  }]    
}

Se a solicitação for bem-sucedida, você receberá uma resposta com uma identificação de mensagem. Se a solicitação retornar uma seção errors, verifique a mensagem original e corrija os erros antes de reenviar a solicitação. Para saber mais sobre erros, consulte Códigos de erro do cliente da WhatsApp Business API e Códigos de status HTTP.

Se a solicitação for retida para avaliação, a resposta conterá uma propriedade message_status com uma notificação indicando que a mensagem não foi enviada imediatamente e será encaminhada ou descartada após a validação da qualidade. Essa propriedade só existirá se a mensagem for retida.

    {
      "messages": [{ 
        "id": "message-id",
        "message_status": "Message has been held because quality assessment is pending",
      }]    
    }
    

Como formatar mensagens de texto

O WhatsApp permite algumas formatações nas mensagens. Para formatar toda ou parte de uma mensagem, use estes símbolos de formatação:

Desempenho

Nesse contexto, desempenho representa o número de mensagens que podem ser enviadas em um segundo usando o cliente local/de referência do WhatsApp Business. O desempenho máximo que pode ser alcançado depende de uma série de fatores, sendo o mais importante a escolha da configuração do cliente e se uma mensagem está sendo enviada para um novo usuário ou usuário existente — a configuração das sessões de criptografia leva um pouco mais de tempo ao enviar mensagens para um novo usuário.

Perguntas frequentes

Saiba mais

• Documentação sobre login e autenticação
• Documentação sobre contatos
• Mensagens de erro e status: Códigos de erro do cliente da WhatsApp Business API
• HTTP Status Codes