単品商品のメッセージを送る

このコードスニペットでは、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 `https://api.nexmo.com/`. For sandbox testing the base URL is `https://messages-sandbox.nexmo.com/`.
`MESSAGES_API_URL`	There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was `https://api.nexmo.com/v0.1/messages`, the new one is `https://api.nexmo.com/v1/messages`. For sandbox testing the Messages API endpoint is `https://messages-sandbox.nexmo.com/v0.1/messages` or `https://messages-sandbox.nexmo.com/v1/messages`, depending on which version you have set in the sandbox dashboard.
`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 `WHATSAPP_NUMBER` above.
`VONAGE_NUMBER`	Refer to `WHATSAPP_NUMBER` above.
`TO_NUMBER`	Replace with the number you are sending to. E.g. `447700900001`

注：先頭の + または 00 電話番号を入力する場合は、447700900000のように国番号から入力してください。

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-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}'"
        }
      }
    }

View full source

Run your code

Save this file to your machine and run it:

bash send-single-product.sh

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 SendWhatsappSingleProduct and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the SendWhatsappSingleProduct class:

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!")
    }
)

View full source

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 SendWhatsappSingleProduct:

gradle run -Pmain=com.vonage.quickstart.kt.messages.whatsapp.SendWhatsappSingleProduct

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 SendWhatsappSingleProduct and add the following code to the main method:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

View full source

Write the code

Add the following to the main method of the SendWhatsappSingleProduct class:

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());

View full source

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 SendWhatsappSingleProduct:

gradle run -Pmain=com.vonage.quickstart.messages.whatsapp.SendWhatsappSingleProduct

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Install-Package Vonage

Write the code

Add the following to 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);

View full source

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

composer require vonage/client

Create a file named send-single-product.php and add the following code:

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

View full source

Write the code

Add the following to 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);

View full source

Run your code

Save this file to your machine and run it:

php send-single-product.php

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

pip install vonage python-dotenv

Write the code

Add the following to 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)

View full source

Run your code

Save this file to your machine and run it:

python messages/whatsapp/send-product-message-single-item.py

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

gem install vonage

Create a file named send-single-product.rb and add the following code:

View full source

Write the code

Add the following to send-single-product.rb:

View full source

Run your code

Save this file to your machine and run it:

ruby send-single-product.rb

試してみる

コードを実行すると、WhatsAppの単一製品メッセージが宛先番号に送信されます。

単品商品のメッセージを送る

例

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

試してみる

詳細情報