単品商品のメッセージを送る
このコードスニペットでは、Messages API を使って商品アイテムを含む商品メッセージをWhatsApp チャットに送信する方法を説明します。詳しくは 製品メッセージ このコード・スニペットを使用する際の詳細については、こちらをご覧ください。
このメッセージタイプはVonageの カスタムオブジェクト 機能をご利用ください。具体的なメッセージフォーマットについてはWhatsApp開発者向けページをご覧下さい。 製品メッセージ ドキュメンテーション
例
各コード・スニペットで使用されているすべての変数の説明を以下に示します：
| キー | 説明 |
|---|---|
VONAGE_APPLICATION_ID | The Vonage Application ID. |
VONAGE_APPLICATION_PRIVATE_KEY_PATH | Private key path. |
VONAGE_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. |
注： 先頭の + または 00 電話番号を入力する場合は、447700900000のように国番号から入力してください。
コードを書く
send-single-product.sh に以下を追加する：
curl -X POST "${MESSAGES_API_URL}" \
-H "Authorization: Bearer "$JWT\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d $'{
"to": "'${MESSAGES_TO_NUMBER}'",
"from": "'${WHATSAPP_SENDER_ID}'",
"channel": "whatsapp",
"message_type": "custom",
"custom": {
"type": "interactive",
"interactive": {
"type": "product",
"body": {
"text": "Check out this cool product"
},
"footer": {
"text": "Sale now on!"
},
"action": {
"catalog_id": "'${WHATSAPP_CATALOG_ID}'",
"product_retailer_id": "'${WHATSAPP_PRODUCT_ID_1}'"
}
}
}コードを実行する
このファイルをあなたのマシンに保存し、実行する：
前提条件
コードを書く
SendWhatsappSingleProduct ファイルのmain メソッドに以下を追加する：
val messageId = client.messages.send(
whatsappSingleProduct {
to(MESSAGES_TO_NUMBER)
from(WHATSAPP_SENDER_ID)
catalogId(WHATSAPP_CATALOG_ID)
productRetailerId(WHATSAPP_PRODUCT_ID)
bodyText("Check out this cool product")
footerText("Sale now on!")
}
)コードを実行する
Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する：
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''以下のgradle コマンドを実行し、com.vonage.quickstart.kt.messages.whatsapp をSendWhatsappSingleProduct を含むパッケージに置き換えてアプリケーションを実行する：
前提条件
build.gradle に以下を追加する：
implementation 'com.vonage:server-sdk:9.3.1'SendWhatsappSingleProduct という名前のファイルを作成し、main メソッドに以下のコードを追加する：
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();コードを書く
SendWhatsappSingleProduct ファイルのmain メソッドに以下を追加する：
var response = client.getMessagesClient().sendMessage(
WhatsappSingleProductRequest.builder()
.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
.catalogId(WHATSAPP_CATALOG_ID)
.productRetailerId(WHATSAPP_PRODUCT_ID)
.bodyText("Check out this cool product")
.footerText("Sale now on!")
.build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());コードを実行する
Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する：
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''以下のgradle コマンドを実行し、com.vonage.quickstart.messages.whatsapp をSendWhatsappSingleProduct を含むパッケージに置き換えてアプリケーションを実行する：
コードを書く
SendWhatsAppSingleProduct.cs に以下を追加する：
var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new WhatsAppCustomRequest
{
To = MESSAGES_TO_NUMBER,
From = WHATSAPP_SENDER_ID,
Custom = new
{
type = "interactive",
interactive = new
{
type = "product",
body = new
{
text = "Check out this cool product"
},
footer = new
{
text = "Sale now on!"
},
action = new
{
catalog_id = WHATSAPP_CATALOG_ID,
product_retailer_id = WHATSAPP_PRODUCT_ID
}
}
}
};
var response = await vonageClient.MessagesClient.SendAsync(request);前提条件
composer require vonage/clientsend-single-product.php という名前のファイルを作成し、以下のコードを追加する：
$keypair = new \Vonage\Client\Credentials\Keypair(
file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
VONAGE_APPLICATION_ID
);
$client = new \Vonage\Client($keypair);コードを書く
send-single-product.php に以下を追加する：
$custom = [
"to" => TO_NUMBER,
"from" => WHATSAPP_NUMBER,
"channel" => "whatsapp",
"message_type" => "custom",
"custom" => [
"type" => "interactive",
"interactive" => [
"type" => "product",
"body" => [
"text" => "Check out this cool product"
],
"footer" => [
"text" => "Sale now on!"
],
"action" => [
"catalog_id" => CATALOG_ID,
"product_retailer_id" => PRODUCT_ID
]
]
]
];
$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppCustom(
TO_NUMBER,
FROM_NUMBER,
$custom
);
$client->messages()->send($whatsApp);コードを実行する
このファイルをあなたのマシンに保存し、実行する：
コードを書く
send-product-message-single-item.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': 'interactive',
'interactive': {
'type': 'product',
'body': {'text' 'Check out this cool product'},
'footer': {'text': 'Sale now on!'},
'action': {
'catalog_id': WHATSAPP_CATALOG_ID,
'product_retailer_id': WHATSAPP_PRODUCT_ID_1,
},
},
},
)
response = client.messages.send(message)
print(response)コードを実行する
このファイルをあなたのマシンに保存し、実行する：
前提条件
コードを書く
send-single-product.rb に以下を追加する：
message = client.messaging.whatsapp(
type: 'custom',
message: {
type: "interactive",
interactive: {
type: "product",
body: {
text: "Check out this cool product"
},
footer: {
text: "Sale now on!"
},
action: {
catalog_id: WHATSAPP_CATALOG_ID,
product_retailer_id: WHATSAPP_PRODUCT_ID_1
}
}
}
)
client.messaging.send(
from: WHATSAPP_SENDER_ID,
to: MESSAGES_TO_NUMBER,
**message
)コードを実行する
このファイルをあなたのマシンに保存し、実行する：
試してみる
コードを実行すると、WhatsAppの単一製品メッセージが宛先番号に送信されます。