複数商品のメッセージを送信する

このコードスニペットでは、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のように国番号から入力してください。

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

コードを書く

send-multi-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_list",
        "header":{
          "type": "text",
          "text": "Our top products"
        },
        "body": {
          "text": "Check out these great products"
        },
        "footer": {
          "text": "Sale now on!"
        },
        "action":{
          "catalog_id": "'${WHATSAPP_CATALOG_ID}'",
          "sections": [
            {
              "title": "Cool products",
              "product_items": [
                { 
                  "product_retailer_id": "'${WHATSAPP_PRODUCT_ID_1}'"
                },
                { 
                  "product_retailer_id": "'${WHATSAPP_PRODUCT_ID_2}'"
                }
              ]
            },
            {
              "title": "Awesome products",
              "product_items": [
                { 
                  "product_retailer_id": "'${WHATSAPP_PRODUCT_ID_1}'"

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

bash send-multi-product.sh

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

build.gradle に以下を追加する：

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

SendWhatsappMultiProduct という名前のファイルを作成し、main メソッドに以下のコードを追加する：

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

全文を見る

コードを書く

SendWhatsappMultiProduct ファイルのmain メソッドに以下を追加する：

val messageId = client.messages.send(
    whatsappMultiProduct {
        to(MESSAGES_TO_NUMBER)
        from(WHATSAPP_SENDER_ID)
        headerText("Our top products")
        bodyText("Check out these great products")
        footerText("Sale now on!")
        catalogId(WHATSAPP_CATALOG_ID)
        addProductsSection("Cool products", WHATSAPP_PRODUCT_ID, WHATSAPP_PRODUCT_ID)
        addProductsSection("Awesome products", WHATSAPP_PRODUCT_ID)
    }
)

全文を見る

コードを実行する

Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する：

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

以下のgradle コマンドを実行し、com.vonage.quickstart.kt.messages.whatsapp をSendWhatsappMultiProduct を含むパッケージに置き換えてアプリケーションを実行する：

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

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

build.gradle に以下を追加する：

implementation 'com.vonage:server-sdk:9.3.1'

SendWhatsappMultiProduct という名前のファイルを作成し、main メソッドに以下のコードを追加する：

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

全文を見る

コードを書く

SendWhatsappMultiProduct ファイルのmain メソッドに以下を追加する：

var response = client.getMessagesClient().sendMessage(
		WhatsappMultiProductRequest.builder()
			.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.catalogId("1166260820787549")
			.headerText("Our top products")
			.bodyText("Check out these great products")
			.addProductsSection("Cool products", Arrays.asList("ch76nhzdeq", "r07qei73l7"))
			.addProductsSection("Awesome product", "unepvzvsfp")
			.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 をSendWhatsappMultiProduct を含むパッケージに置き換えてアプリケーションを実行する：

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

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

Install-Package Vonage

コードを書く

SendWhatsAppMultiProduct.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_list",
            header = new
            {
                type = "text",
                text = "Our top products"
            },
            body = new
            {
                text = "Check out these great products"
            }
        },
        footer = new
        {
            text = "Sale now on!"
        },
        action = new
        {
            catalog_id = WHATSAPP_CATALOG_ID,
            sections = new[]
            {
                new
                {
                    title = "Cool products",
                    product_items = new[]
                    {
                        new { product_retailer_id = WHATSAPP_PRODUCT_ID },
                        new { product_retailer_id = WHATSAPP_PRODUCT_ID }
                    }
                },
                new
                {
                    title = "Awesome products",
                    product_items = new[]
                    {
                        new { product_retailer_id = WHATSAPP_PRODUCT_ID }
                    }
                }
            }
        }
    }
};
var response = await vonageClient.MessagesClient.SendAsync(request);

全文を見る

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

composer require vonage/client

send-multi-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-multi-product.php に以下を追加する：

$custom = [
    "type" => "interactive",
    "interactive" => [
        "type" => "product_list",
        "header" => [
            "type" => "text",
            "text" => "Our top products"
        ],
        "body" => [
            "text" => "Check out these great products"
        ],
        "footer" => [
            "text" => "Sale now on!"
        ],
        "action" => [
            "catalog_id" => CATALOG_ID,
            "sections" => [
                [
                    "title" => "Cool products",
                    "product_items" => [
                        ["product_retailer_id" => PRODUCT_ID],
                        ["product_retailer_id" => PRODUCT_ID]
                    ]
                ],
                [
                    "title" => "Awesome products",
                    "product_items" => [
                        ["product_retailer_id" => PRODUCT_ID]
                    ]
                ]
            ]
        ]
    ]
];

$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppCustom(
    TO_NUMBER,
    FROM_NUMBER,
    $custom
);

$client->messages()->send($whatsApp);

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

php send-multi-product.php

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

pip install vonage python-dotenv

コードを書く

send-product-message-multiple-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_list',
            'header': {'type': 'text', 'text': 'Our top products'},
            'body': {'text': 'Check out these great products'},
            'footer': {'text': 'Sale now on!'},
            'action': {
                'catalog_id': WHATSAPP_CATALOG_ID,
                'sections': [
                    {
                        'title': 'Cool products',
                        'product_items': [
                            {'WHATSAPP_PRODUCT_ID_1': WHATSAPP_PRODUCT_ID_1},
                            {'WHATSAPP_PRODUCT_ID_2': WHATSAPP_PRODUCT_ID_2},
                        ],
                    },
                    {
                        'title': 'Awesome products',
                        'product_items': [
                            {'WHATSAPP_PRODUCT_ID_1': WHATSAPP_PRODUCT_ID_1}
                        ],
                    },
                ],
            },
        },
    },
)

response = client.messages.send(message)
print(response)

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

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

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

gem install vonage

send-multi-product.rb という名前のファイルを作成し、以下のコードを追加する：

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

全文を見る

コードを書く

send-multi-product.rb に以下を追加する：

message = client.messaging.whatsapp(
  type: 'custom',
  message: {
    type: "interactive",
    interactive: {
      type: "product_list",
      header: {
        type: "text",
        text: "Our top products"
      },
      body: {
        text: "Check out these great products"
      },
      footer: {
        text: "Sale now on!"
      },
      action: {
        catalog_id: WHATSAPP_CATALOG_ID,
        sections: [
          {
            title: "Cool products",
            product_items: [
              {
                product_retailer_id: WHATSAPP_PRODUCT_ID_1
              },
              {
                product_retailer_id: WHATSAPP_PRODUCT_ID_2
              }
            ]
          },
          {
            title: "Awesome products",
            product_items: [
              {
                product_retailer_id: WHATSAPP_PRODUCT_ID_1
              }
            ]
          }
        ]
      }
    }
  }
)

client.messaging.send(
  from: WHATSAPP_SENDER_ID,
  to: MESSAGES_TO_NUMBER,
  **message
)

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

ruby send-multi-product.rb

試してみる

コードを実行すると、WhatsAppマルチプロダクトメッセージが送信先番号に送信されます。

詳細情報