このトピックでは、WhatsAppメッセージテンプレートのペイロードパラメータの使用方法について説明します。
ペイロードパラメータの説明
ペイロードは、WhatsAppメッセージテンプレートでボタンを使用してメッセージをトリガーすることに関連しています。
メッセージテンプレートに 2 つのquick_replyボタンが含まれていて、メッセージの送信時にペイロードに[payload1,payload2]が渡されるとします。ユーザーがボタン 1 をクリックすると、チャットアプリはpayload1を返します。返されたパラメータ値は、ユーザーがクリックしたボタンを示します。
説明
要素 | タイプ | 必須 | 説明 | 例 |
ペイロード | 配列 | いいえ | ボタンのペイロード。 | [payloadtext1,payloadtext2,payloadtext3] |
ペイロード | 文字列 | いいえ | メッセージテンプレートのボタンのペイロード。 | payloadtext1,payloadtext2,payloadtext3 |
サンプルコード
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();サンプルレスポンス
{
"Context":{"from":"****","id":"****"},
"Type":"REPLY",
"Message":"{\"payload\":\"payload1\",\"text\":\"****\"}",
"CustSpaceId":"***",
"From":"***",
"To":"***",
"Timestamp":****,
"WabaId":"***",
"MessageId":"****",
"Name":"***"
}参照
SendChatappMassMessage - チャットアプリメッセージの一括送信