画像メッセージを送る

このコードスニペットでは、Messages API を使って WhatsApp 画像メッセージを送信する方法を説明します。WhatsAppの最大送信メディアサイズは64MBです。

重要： メッセージ未送信の場合、WhatsAppは初回メッセージ送信時にテンプレートを要求します。詳しくは 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`
`IMAGE_URL`	The link to the image file to send.
`IMAGE_CAPTION`	The text describing the image being sent.

注：先頭の + または 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-image.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": "image",
    "image": {
      "url": "'${MESSAGES_IMAGE_URL}'"
    }
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-image.sh

Prerequisites

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

npm install @vonage/server-sdk @vonage/messages

Create a file named send-image.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} : {}),
  },
);

View full source

Write the code

Add the following to send-image.js:

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: 'image',
  image: {
    url: MESSAGES_IMAGE_URL,
  },
})
  .then((resp) => console.log(resp.messageUUID))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node send-image.js

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:

Create a class named SendWhatsappImage and add the following code to the main method:

View full source

Write the code

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

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:

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.messages.whatsapp with the package containing SendWhatsappImage:

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

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:

Create a class named SendWhatsappImage 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 SendWhatsappImage class:

var response = client.getMessagesClient().sendMessage(
		WhatsappImageRequest.builder()
			.to(MESSAGES_TO_NUMBER).from(WHATSAPP_SENDER_ID)
			.url(MESSAGES_IMAGE_URL).caption(MESSAGES_CAPTION)
			.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:

Run the following gradle command to execute your application, replacing com.vonage.quickstart.messages.whatsapp with the package containing SendWhatsappImage:

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

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 SendWhatsAppImage.cs:

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-image.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-image.php:

$imageObject = new \Vonage\Messages\MessageObjects\ImageObject(
    'https://example.com/image.jpg',
    'This is a whatsapp image'
);

$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppImage(
    TO_NUMBER,
    FROM_NUMBER,
    $imageObject
);

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

View full source

Run your code

Save this file to your machine and run it:

php send-image.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-image.py:

View full source

Run your code

Save this file to your machine and run it:

python messages/whatsapp/send-image.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-image.rb and add the following code:

View full source

Write the code

Add the following to send-image.rb:

View full source

Run your code

Save this file to your machine and run it:

ruby send-image.rb

試してみる

このコードを実行すると、WhatsApp画像メッセージが送信先の番号に送信されます。