RCS推奨アクション（場所の共有）メッセージを送信する

このコード・スニペットでは、RCS Suggested Actionメッセージを送信する方法について説明する。 text メッセージAPI RCSチャネルのメッセージタイプです。このメッセージは、受信者のデバイスのデフォルトのマップアプリケーションを介して自分の位置を共有するように促します。

RCSメッセージングの詳細については RCSメッセージングを理解する
提案されたチップの詳細については、以下を参照のこと。 RCS提案チップ

例

各コード・スニペットで使用されているすべての変数の説明を以下に示します：

キー	説明
`VONAGE_APPLICATION_ID`	The Vonage Application ID.
`VONAGE_PRIVATE_KEY_PATH`	Private key path.
`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.
`JWT`	Used to authenticate your request. See Authentication for more information, including how to generate a JWT.
`TO_NUMBER`	The number you are sending the RCS message to in E.164 format. For example `447700900000`.
`RCS_SENDER_ID`	The sender ID for the RCS message.

注：先頭の + または 00 電話番号を入力する場合は、国番号から始めます。 447700900000.

前提条件

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

コードを書く

send-suggested-action-share-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": "'${RCS_SENDER_ID}'",
    "channel": "rcs",
    "message_type": "text",
    "text": "Your driver will come and meet you at your specified location.",
    "suggestions": [
      {
        "type": "share_location",
        "text": "Share a location",
        "postback_data": "postback_data_1234"
      }
    ]
  }'

全文を見る

コードを実行する

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

bash send-suggested-action-share-location.sh

前提条件

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

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

send-suggested-action-share-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-suggested-action-share-location.js に以下を追加する：

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      text: 'Your driver will come and meet you at your specified location.',
      suggestions: [
        {
          action: {
            text: 'Share a location',
            postbackData: 'postback_data_1234',
            shareLocationAction: {},
          },
        },
      ],
    },
  },
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

全文を見る

コードを実行する

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

node send-suggested-action-share-location.js

前提条件

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

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

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

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

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

全文を見る

コードを書く

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

val messageId = client.messages.send(
    rcsCustom {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "text" to "Your driver will come and meet you at your specified location.",
                "suggestions" to listOf(
                    mapOf(
                        "action" to mapOf(
                            "text" to "Share a location",
                            "postbackData" to "postback_data_1234",
                            "shareLocationAction" to emptyMap<String, Any>()
                        )
                    )
                )
            )
        ))
    }
)

全文を見る

コードを実行する

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

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

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

gradle run -Pmain=com.vonage.quickstart.kt.messages.rcs.SendRcsSuggestedShareLocation

前提条件

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

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

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

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

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

全文を見る

コードを書く

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

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"text", "Your driver will come and meet you at your specified location.",
				"suggestions", List.of(
					Map.of(
						"action", Map.of(
							"text", "Share a location",
							"postbackData", "postback_data_1234",
							"shareLocationAction", Map.of()
						)
					)
				)
			))
		).build()
);
System.out.println("Message sent successfully. ID: " + response.getMessageUuid());

全文を見る

コードを実行する

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

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

gradle run -Pmain=com.vonage.quickstart.messages.rcs.SendRcsSuggestedShareLocation

前提条件

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

Install-Package Vonage

コードを書く

SendRcsSuggestedActionShareLocationMessage.cs に以下を追加する：

var request = new RcsTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "Your driver will come and meet you at your specified location.",
    Suggestions =
    [
        new ShareLocationSuggestion("Share a location", "postback_data_1234"),
    ]
};
var response = await vonageClient.MessagesClient.SendAsync(request);

全文を見る

前提条件

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

composer require vonage/client

send-suggested-action-share-location.php という名前のファイルを作成し、以下のコードを追加する：

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

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

全文を見る

コードを書く

send-suggested-action-share-location.php に以下を追加する：

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "text" =>
                "Your driver will come and meet you at your specified location.",
            "suggestions" => [
                [
                    "action" => [
                        "text" => "Share a location",
                        "postbackData" => "postback_data_1234",
                        "shareLocationAction" => [],
                    ],
                ],
            ],
        ],
    ]
);

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

全文を見る

コードを実行する

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

php send-suggested-action-share-location.php

前提条件

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

pip install vonage python-dotenv

コードを書く

send-suggested-action-share-location.py に以下を追加する：

from vonage import Auth, Vonage
from vonage_messages import RcsCustom

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

custom_dict = {
    "contentMessage": {
        "text": "Your driver will come and meet you at your specified location.",
        "suggestions": [
            {
                "action": {
                    "text": "Share a location",
                    "postbackData": "postback_data_1234",
                    "shareLocationAction": {},
                }
            }
        ],
    }
}


message = RcsCustom(
    to=MESSAGES_TO_NUMBER,
    from_=RCS_SENDER_ID,
    custom=custom_dict,
)

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

全文を見る

コードを実行する

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

python messages/rcs/send-suggested-action-share-location.py

前提条件

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

gem install vonage

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

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

全文を見る

コードを書く

send-suggested-action-share-location.rb に以下を追加する：

message = client.messaging.rcs(
  type: 'text',
  message: "Your driver will come and meet you at your specified location.",
  opts: {
    suggestions: [
      {
        type: "share_location",
        text: "Share a location",
        postback_data: "postback_data_1234"
      }
    ]
  }
)

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

全文を見る

コードを実行する

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

ruby send-suggested-action-share-location.rb

試してみる

コードを実行すると、宛先番号にメッセージが送信される。