WhatsApp メディアメッセージテンプレートを送信
このコードスニペットでは、Messages API を使って WhatsApp メディアメッセージテンプレートを送信する方法を説明します。
メディアメッセージテンプレートを送信するには、メッセージカスタムオブジェクトを使用する必要があります。カスタムオブジェクトはWhatsApp APIリクエストの一部分を取得し、直接WhatsAppに送信します。
重要： 顧客からメッセージが届いた場合、24時間以内にフリーフォームのメッセージで返信することができます。この期間を過ぎると、テンプレートメッセージ(MTM)を使用する必要があります。顧客からメッセージが届いていない場合、WhatsAppが初めてメッセージを送信する際、テンプレートが必要となります。詳しくは WhatsAppトピックの理解.
メッセージの形式と長さの制限
WhatsAppメディアメッセージテンプレートはヘッダー、本文、フッターで構成されています。ヘッダーには、テキスト、位置情報、ビデオ、画像、ファイルなどのメディアが含まれます。本文にはテキストメッセージが含まれます。 スクロールの必要性を避けるため、現在エンドユーザーに表示される文字数は1024文字に制限されている。 フッターはオプションで、静的なテキストのみが含まれます。
注： 現在、ヘッダーとフッターの長さはそれぞれ60文字、メッセージ本文の長さは1024文字に制限されています。
例
各コード・スニペットで使用されているすべての変数の説明を以下に示します：
| キー | 説明 |
|---|---|
VONAGE_APPLICATION_ID | The Vonage Application ID. |
VONAGE_APPLICATION_PRIVATE_KEY_PATH | Private key path. |
BASE_URL | For production use the base URL is |
MESSAGES_API_URL | There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was |
WHATSAPP_NUMBER | The WhatsApp number that has been allocated to you by Vonage. For sandbox testing the number is 14157386102. |
VONAGE_WHATSAPP_NUMBER | Refer to |
VONAGE_NUMBER | Refer to |
TO_NUMBER | Replace with the number you are sending to. E.g. |
WHATSAPP_TEMPLATE_NAME | The name of the template created in your WhatsApp Business Account. |
IMAGE_URL | The link to the image file to send. |
WHATSAPP_TEMPLATE_REPLACEMENT_TEXT | Text to populate place-holders in a WhatsApp template message. |
注： 先頭の + または 00 電話番号を入力する場合は、447700900000のように国番号から入力してください。
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Run your code
Save this file to your machine and run it:
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Create a file named send-media-mtm.js and add the following code:
const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');
/**
* It is best to send messages using JWT instead of basic auth. If you leave out
* apiKey and apiSecret, the messages SDK will send requests using JWT tokens
*
* @link https://developer.vonage.com/en/messages/technical-details#authentication
*/
const vonage = new Vonage(
{
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_PRIVATE_KEY,
},
{
...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
},
);Write the code
Add the following to send-media-mtm.js:
vonage.messages.send({
to: MESSAGES_TO_NUMBER,
from: WHATSAPP_SENDER_ID,
channel: Channels.WHATSAPP,
messageType: 'custom',
custom: {
type: 'template',
template: {
name: WHATSAPP_TEMPLATE_NAME,
language: {
policy: 'deterministic',
code: 'en',
},
components: [
{
type: 'header',
parameters: [
{
type: 'image',
image: {
link: MESSAGES_IMAGE_URL,
},
},
],
},
{
type: 'body',
parameters: [
{
type: 'text',
text: 'Joe Bloggs',
},
{
type: 'text',
text: 'AB123456',
},
],
},
],
},
},
})
.then(({ messageUUID }) => console.log(messageUUID))
.catch((error) => console.error(error));Run your code
Save this file to your machine and run it:
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Add the following to build.gradle:
implementation 'com.vonage:server-sdk-kotlin:2.1.1'Create a class named SendWhatsappMediaTemplate and add the following code to the main method:
Write the code
Add the following to the main method of the SendWhatsappMediaTemplate class:
Run your code
We can use the アプリケーション plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.messages.whatsapp with the package containing SendWhatsappMediaTemplate:
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Add the following to build.gradle:
implementation 'com.vonage:server-sdk:9.3.1'Create a class named SendWhatsappMediaTemplate and add the following code to the main method:
Write the code
Add the following to the main method of the SendWhatsappMediaTemplate class:
Run your code
We can use the アプリケーション plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Run the following gradle command to execute your application, replacing com.vonage.quickstart.messages.whatsapp with the package containing SendWhatsappMediaTemplate:
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Create a file named send-media-mtm.php and add the following code:
Run your code
Save this file to your machine and run it:
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Write the code
Add the following to send-media-template.py:
from vonage import Auth, Vonage
from vonage_messages import WhatsappCustom
client = Vonage(
Auth(
application_id=VONAGE_APPLICATION_ID,
private_key=VONAGE_PRIVATE_KEY,
)
)
message = WhatsappCustom(
to=MESSAGES_TO_NUMBER,
from_=WHATSAPP_SENDER_ID,
custom={
"type": "template",
"template": {
"name": WHATSAPP_TEMPLATE_NAME,
"language": {"policy": "deterministic", "code": "en"},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"link": MESSAGES_IMAGE_URL,
},
},
],
},
{
"type": "body",
"parameters": [
{"type": "text", "text": "Joe Bloggs"},
{"type": "text", "text": "AB123456"},
],
},
],
},
},
)
response = client.messages.send(message)
print(response)Run your code
Save this file to your machine and run it:
Prerequisites
If you do not have an application you can create one. Make sure you also configure your webhooks.
Create a file named send-media-mtm.rb and add the following code:
Run your code
Save this file to your machine and run it:
試してみる
コードを実行すると、WhatsApp メディアメッセージテンプレートが送信先番号に送信されます。