Todos os produtos
Search
Central de documentação

Chat App Message Service:Parâmetro Payload para modelos de mensagem do WhatsApp

Última atualização: Sep 21, 2026

Este tópico descreve como usar o parâmetro Payload de um modelo de mensagem do WhatsApp.

Como o Payload funciona

O parâmetro Payload aciona uma mensagem por meio de um botão em um modelo de mensagem do WhatsApp.

Por exemplo, se um modelo tiver dois botões quick_reply e você passar [payload1,payload2], o Chat App retornará payload1 quando o usuário clicar no botão 1. Isso permite identificar qual botão o usuário selecionou.

Parâmetros

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Payload

array

Não

O Payload do botão.

[payloadtext1,payloadtext2,payloadtext3]

Payload

string

Não

O Payload do botão no modelo de mensagem.

payloadtext1,payloadtext2,payloadtext3

Código de exemplo

SendChatappMessageRequest sendChatappMessageRequest = new SendChatappMessageRequest();
	sendChatappMessageRequest.setChannelType("whatsapp");
	sendChatappMessageRequest.setFrom("****");
	sendChatappMessageRequest.setTo("****");
	sendChatappMessageRequest.setCustSpaceId("******");
	sendChatappMessageRequest.setType(SendType.TEMPLATE.getName());
	sendChatappMessageRequest.setLanguage("**");
	sendChatappMessageRequest.setTemplateCode("*****");
Map<String, String> templateParams = new HashMap<>();
	templateParams.put("variable1", "pre_auto1");
	templateParams.put("variable2", "pre_auto2");
	sendChatappMessageRequest.setTemplateParams(templateParams);
List<String> payload = new ArrayList<>();
	payload.add("payload1");
	payload.add("payload2");
	sendChatappMessageRequest.setPayload(payload);

SendChatappMessageResponse sendChatappMessageResponse = ChatAppClient.instance().sendChatappMessage(sendChatappMessageRequest);
SendChatappMessageResponseBody body = sendChatappMessageResponse.getBody();

Resposta de exemplo

{
	"Context":{"from":"****","id":"****"},
	"Type":"REPLY",
	"Message":"{\"payload\":\"payload1\",\"text\":\"****\"}",
	"CustSpaceId":"***",
	"From":"***",
	"To":"***",
	"Timestamp":****,
	"WabaId":"***",
	"MessageId":"****",
	"Name":"***"
}

Referências

SendChatappMassMessage -Batch Send Chat App Messages

SendChatappMessage -Send Chat App Messages

Message receipts and configuration