場所を送信する
このコードでは、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-location.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": "location",
"location": {
"longitude": -122.425332,
"latitude": 37.758056,
"name": "Facebook HQ",
"address": "1 Hacker Way, Menlo Park, CA 94025"
}
}
}'
コードを実行する
このファイルをあなたのマシンに保存し、実行する:
前提条件
npm install @vonage/server-sdk @vonage/messagessend-location.js という名前のファイルを作成し、以下のコードを追加する:
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} : {}),
},
);コードを書く
send-location.js に以下を追加する:
vonage.messages.send({
to: MESSAGES_TO_NUMBER,
from: WHATSAPP_SENDER_ID,
channel: Channels.WHATSAPP,
messageType: 'custom',
custom: {
type: 'location',
location: {
longitude: -122.425332,
latitude: 37.758056,
name: 'Facebook HQ',
address: '1 Hacker Way, Menlo Park, CA 94025',
},
},
})
.then(({ messageUUID }) => console.log(messageUUID))
.catch((error) => console.error(error));コードを実行する
このファイルをあなたのマシンに保存し、実行する:
前提条件
コードを書く
SendWhatsappLocation ファイルのmain メソッドに以下を追加する:
val messageId = client.messages.send(
whatsappLocation {
to(MESSAGES_TO_NUMBER)
from(WHATSAPP_SENDER_ID)
longitude(-122.425332)
latitude(37.758056)
name("Facebook HQ")
address("1 Hacker Way, Menlo Park, CA 94025")
}
)コードを実行する
Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''以下のgradle コマンドを実行し、com.vonage.quickstart.kt.messages.whatsapp をSendWhatsappLocation を含むパッケージに置き換えてアプリケーションを実行する:
前提条件
build.gradle に以下を追加する:
implementation 'com.vonage:server-sdk:9.3.1'SendWhatsappLocation という名前のファイルを作成し、main メソッドに以下のコードを追加する:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();コードを書く
SendWhatsappLocation ファイルのmain メソッドに以下を追加する:
var response = client.getMessagesClient().sendMessage(
WhatsappLocationRequest.builder()
.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
.name("Facebook HQ")
.address("1 Hacker Way, Menlo Park, CA 94025")
.longitude(-122.1503115).latitude(37.4843538)
.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 をSendWhatsappLocation を含むパッケージに置き換えてアプリケーションを実行する:
コードを書く
SendWhatsAppLocation.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 = "location",
location = new
{
longitude = -122.425332,
latitude = 37.758056,
name = "Facebook HQ",
address = "1 Hacker Way, Menlo Park, CA 94025"
}
}
};
var response = await vonageClient.MessagesClient.SendAsync(request);前提条件
コードを書く
send-location.php に以下を追加する:
$custom = [
"type" => "location",
"location" => [
"longitude" => -122.425332,
"latitude" => 37.758056,
"name" => "Facebook HQ",
"address" => "1 Hacker Way, Menlo Park, CA 94025",
],
];
$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppCustom(
TO_NUMBER,
FROM_NUMBER,
$custom
);
$client->messages()->send($whatsApp);コードを実行する
このファイルをあなたのマシンに保存し、実行する:
コードを書く
send-location.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": "location",
"location": {
"longitude": -122.425332,
"latitude": 37.758056,
"name": "Facebook HQ",
"address": "1 Hacker Way, Menlo Park, CA 94025",
},
},
)
response = client.messages.send(message)
print(response)コードを実行する
このファイルをあなたのマシンに保存し、実行する:
前提条件
コードを書く
send-location.rb に以下を追加する:
message = client.messaging.whatsapp(
type: 'custom',
message: {
type: "location",
location: {
longitude: -122.425332,
latitude: 37.758056,
name: "Facebook HQ",
address: "1 Hacker Way, Menlo Park, CA 94025"
}
}
)
client.messaging.send(
from: WHATSAPP_SENDER_ID,
to: MESSAGES_TO_NUMBER,
**message
)コードを実行する
このファイルをあなたのマシンに保存し、実行する:
試してみる
コードを実行すると、WhatsApp位置情報メッセージが相手先電話番号に送信されます。位置情報はWhatsAppメッセージウィンドウ内の地図上にピンとして表示されます。