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-create-calendar-event.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": "Product Launch: Save the date!",
    "suggestions": [
      {
        "type": "create_calendar_event",
        "text": "Save to calendar",
        "postback_data": "postback_data_1234",
        "start_time": "2024-06-28T19:00:00Z",
        "end_time": "2024-06-28T20:00:00Z",
        "title": "Vonage API Product Launch",
        "description": "Event to demo new and exciting Vonage API product",
        "fallback_url": "https://www.google.com/calendar"
      }
    ]
  }'

全文を見る

コードを実行する

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

bash send-suggested-action-create-calendar-event.sh

前提条件

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

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

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

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      text: 'Product Launch: Save the date!',
      suggestions: [
        {
          action: {
            text: 'Save to calendar',
            postbackData: 'postback_data_1234',
            fallbackUrl: 'https://www.google.com/calendar',
            createCalendarEventAction: {
              startTime: '2024-06-28T19:00:00Z',
              endTime: '2024-06-28T20:00:00Z',
              title: 'Vonage API Product Launch',
              description: 'Event to demo Vonage\'s new and exciting API product',
            },
          },
        },
      ],
    },
  },
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

全文を見る

コードを実行する

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

node send-suggested-action-create-calendar-event.js

前提条件

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

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

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

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

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

全文を見る

コードを書く

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

val messageId = client.messages.send(
    rcsCustom {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "text" to "Product Launch: Save the date!",
                "suggestions" to listOf(
                    mapOf(
                        "action" to mapOf(
                            "text" to "Save to calendar",
                            "postbackData" to "postback_data_1234",
                            "fallbackUrl" to "https://www.google.com/calendar",
                            "createCalendarEventAction" to mapOf(
                                "startTime" to "2024-06-28T19:00:00Z",
                                "endTime" to "2024-06-28T20:00:00Z",
                                "title" to "Vonage API Product Launch",
                                "description" to "Event to demo Vonage's new and exciting API product"
                            )
                        )
                    )
                )
            )
        ))
    }
)

全文を見る

コードを実行する

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

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

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

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

前提条件

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

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

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

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

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

全文を見る

コードを書く

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

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"text", "Product Launch: Save the date!",
				"suggestions", List.of(
					Map.of(
						"action", Map.of(
							"text", "Save to calendar",
							"postbackData", "postback_data_1234",
							"fallbackUrl", "https://www.google.com/calendar",
							"createCalendarEventAction", Map.of(
								"startTime", Instant.ofEpochSecond(1719604800),
								"endTime", Instant.ofEpochSecond(1719601200),
								"title", "Vonage API Product Launch",
								"description", "Event to demo Vonage's new and exciting API product"
							)
						)
					)
				)
			))
		).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 をSendRcsSuggestedCalendarEvent を含むパッケージに置き換えてアプリケーションを実行する：

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

前提条件

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

Install-Package Vonage

コードを書く

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

var request = new RcsTextRequest()
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "Product Launch: Save the date!",
    Suggestions =
    [
        new CreateCalendarEventSuggestion(
            "Save to calendar",
                "postback_data_1234",
                DateTime.Parse("2024-06-28T19:00:00Z"),
                DateTime.Parse("2024-06-28T20:00:00Z"),
                "Vonage API Product Launch",
                "Event to demo a new and exciting Vonage API product")
            .WithFallbackUrl(new Uri("https://www.google.com/calendar")),
    ]
};
var response = await vonageClient.MessagesClient.SendAsync(request);

全文を見る

前提条件

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

composer require vonage/client

send-suggested-action-create-calendar-event.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-create-calendar-event.php に以下を追加する：

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "text" => "Product Launch: Save the date!",
            "suggestions" => [
                [
                    "action" => [
                        "text" => "Save to calendar",
                        "postbackData" => "postback_data_1234",
                        "fallbackUrl" => "https://www.google.com/calendar",
                        "createCalendarEventAction" => [
                            "startTime" => "2024-06-28T19:00:00Z",
                            "endTime" => "2024-06-28T20:00:00Z",
                            "title" => "Vonage API Product Launch",
                            "description" =>
                                "Event to demo Vonage\'s new and exciting API product",
                        ],
                    ],
                ],
            ],
        ],
    ]
);

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

全文を見る

コードを実行する

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

php send-suggested-action-create-calendar-event.php

前提条件

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

pip install vonage python-dotenv

コードを書く

send-suggested-action-create-calendar-event.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": "Product Launch: Save the date!",
        "suggestions": [
            {
                "action": {
                    "text": "Save to calendar",
                    "postbackData": "postback_data_1234",
                    "fallbackUrl": "https://www.google.com/calendar",
                    "createCalendarEventAction": {
                        "startTime": "2024-06-28T19:00:00Z",
                        "endTime": "2024-06-28T20:00:00Z",
                        "title": "Vonage API Product Launch",
                        "description": "Event to demo Vonage\'s new and exciting API product",
                    },
                }
            }
        ],
    }
}
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-create-calendar-event.py

前提条件

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

gem install vonage

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

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

全文を見る

コードを書く

send-suggested-action-create-calendar-event.rb に以下を追加する：

message = client.messaging.rcs(
  type: 'text',
  message: "Product Launch: Save the date!",
  opts: {
    suggestions: [
      {
        type: "create_calendar_event",
        text: "Save to calendar",
        postback_data: "postback_data_1234",
        start_time: "2024-08-24T20:00:00Z",
        end_time: "2024-08-24T22:00:00Z",
        title: "Vonage API Product Launch",
        description: "Event to demo a new and exciting Vonage API product",
        fallback_url: "https://www.google.com/calendar"
      }
    ]
  }
)

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

全文を見る

コードを実行する

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

ruby send-suggested-action-create-calendar-event.rb

試してみる

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