RCSリッチカード・カルーセル・メッセージの送信

このコード・スニペットでは、RCSリッチカード・カルーセル・メッセージを送信する方法について説明します。 carousel Messages API 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.

IMAGE_URL

The link to the image file to send.

VIDEO_URL

The link to the video to send. RCS supports .mp4 .m4v .h263 .mpeg .webm file formats.

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-rich-card-carousel.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": "carousel",
    "carousel": {
      "cards": [
        {
          "title": "Option 1: Photo",
          "text": "Do you prefer this photo?",
          "media_url": "'${MESSAGES_IMAGE_URL}'",
          "media_height": "SHORT",
          "media_description": "Picture of a cat",
          "thumbnail_url": "'${MESSAGES_IMAGE_URL}'",
          "media_force_refresh": false,
          "suggestions": [
            {
              "type": "reply",
              "text": "Option 1",
              "postback_data": "card_1"
            }
          ]
        },
        {
          "title": "Option 2: Video",
          "text": "Or this video?",
          "media_url": "'${MESSAGES_VIDEO_URL}'",
          "media_height": "SHORT",
          "media_description": "Video of a cat",
          "thumbnail_url": "'${MESSAGES_IMAGE_URL}'",
          "media_force_refresh": false,
          "suggestions": [
            {
              "type": "reply",
              "text": "Option 2",
              "postback_data": "card_2"
            }
          ]
        }
      ]
    },
    "rcs": {
      "card_width": "SMALL"
    }
  }'

全文を見る

コードを実行する

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

bash send-rich-card-carousel.sh

前提条件

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

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

send-rich-card-carousel.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-rich-card-carousel.js に以下を追加する：

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      richCard: {
        carouselCard: {
          cardWidth: 'MEDIUM',
          cardContents: [
            {
              title: 'Option 1: Photo',
              description: 'Do you prefer this photo?',
              suggestions: [
                {
                  reply: {
                    text: 'Option 1',
                    postbackData: 'card_1',
                  },
                },
              ],
              media: {
                height: 'MEDIUM',
                contentInfo: {
                  fileUrl: MESSAGES_IMAGE_URL,
                  forceRefresh: 'false',
                },
              },
            },
            {
              title: 'Option 2: Video',
              description: 'Or this video?',
              suggestions: [
                {
                  reply: {
                    text: 'Option 2',
                    postbackData: 'card_2',
                  },
                },
              ],
              media: {
                height: 'MEDIUM',
                contentInfo: {
                  fileUrl: MESSAGES_VIDEO_URL,
                  forceRefresh: 'false',
                },
              },
            },
          ],
        },
      },
    },
  },
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

全文を見る

コードを実行する

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

node send-rich-card-carousel.js

前提条件

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

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

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

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

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

全文を見る

コードを書く

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

val messageId = client.messages.send(
    rcsCustom {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "carouselCard" to mapOf(
                    "cardWidth" to "MEDIUM",
                    "cardContents" to listOf(
                        mapOf(
                            "title" to "Option 1: Photo",
                            "description" to "Do you prefer this photo?",
                            "suggestions" to listOf(
                                mapOf(
                                    "reply" to mapOf(
                                        "text" to "Option 1",
                                        "postbackData" to "card_1"
                                    )
                                )
                            ),
                            "media" to mapOf(
                                "height" to "MEDIUM",
                                "contentInfo" to mapOf(
                                    "fileUrl" to MESSAGES_IMAGE_URL,
                                    "forceRefresh" to "false"
                                )
                            )
                        ),
                        mapOf(
                            "title" to "Option 2: Video",
                            "description" to "Or this video?",
                            "suggestions" to listOf(
                                mapOf(
                                    "reply" to mapOf(
                                        "text" to "Option 2",
                                        "postbackData" to "card_2"
                                    )
                                )
                            ),
                            "media" to mapOf(
                                "height" to "MEDIUM",
                                "contentInfo" to mapOf(
                                    "fileUrl" to MESSAGES_VIDEO_URL,
                                    "forceRefresh" to "false"
                                )
                            )
                        )
                    )
                )
            )
        ))
    }
)

全文を見る

コードを実行する

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

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

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

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

前提条件

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

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

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

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

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

全文を見る

コードを書く

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

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"carouselCard", Map.of(
					"cardWidth", "MEDIUM",
					"cardContents", List.of(
						Map.of(
							"title", "Option 1: Photo",
							"description", "Do you prefer this photo?",
							"suggestions", List.of(
								Map.of(
									"reply", Map.of(
										"text", "Option 1",
										"postbackData", "card_1"
									)
								)
							),
							"media", Map.of(
								"height", "MEDIUM",
								"contentInfo", Map.of(
									"fileUrl", MESSAGES_IMAGE_URL,
									"forceRefresh", "false"
								)
							)
						),
						Map.of(
							"title", "Option 2: Video",
							"description", "Or this video?",
							"suggestions", List.of(
								Map.of(
									"reply", Map.of(
										"text", "Option 2",
										"postbackData", "card_2"
									)
								)
							),
							"media", Map.of(
								"height", "MEDIUM",
								"contentInfo", Map.of(
									"fileUrl", MESSAGES_VIDEO_URL,
									"forceRefresh", "false"
								)
							)
						)
					)
				)
			))
		).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.rcs をSendRcsRichCardCarousel を含むパッケージに置き換えてアプリケーションを実行する：

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

前提条件

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

Install-Package Vonage

コードを書く

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

var request = new RcsCarouselRequest()
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Carousel = new CarouselAttachment(
        new CardAttachment("Option 1: Photo", "Do you prefer this photo?", new Uri(MESSAGES_IMAGE_URL))
            .WithMediaDescription("Picture of a cat")
            .WithMediaHeight(CardAttachment.Height.Short)
            .WithThumbnailUrl(new Uri(MESSAGES_IMAGE_URL))
            .AppendSuggestion(new ReplySuggestion("Option 1", "card_1")),
        new CardAttachment("Option 2: Video", "Or this video?", new Uri(MESSAGES_VIDEO_URL))
            .WithMediaDescription("Video of a cat")
            .WithMediaHeight(CardAttachment.Height.Short)
            .WithThumbnailUrl(new Uri(MESSAGES_IMAGE_URL))
            .AppendSuggestion(new ReplySuggestion("Option 2", "card_2"))
        ),
    Rcs = new MessageRcs()
    {
      CardWidth  = RcsCardWidth.Small,
    },
};
var response = await vonageClient.MessagesClient.SendAsync(request);

全文を見る

前提条件

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

composer require vonage/client

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

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

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

全文を見る

コードを書く

send-rich-card-carousel.php に以下を追加する：

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "richCard" => [
                "carouselCard" => [
                    "cardWidth" => "MEDIUM",
                    "cardContents" => [
                        [
                            "title" => "Option 1: Photo",
                            "description" => "Do you prefer this photo?",
                            "suggestions" => [
                                [
                                    "reply" => [
                                        "text" => "Option 1",
                                        "postbackData" => "card_1"
                                    ]
                                ]
                            ],
                            "media" => [
                                "height" => "MEDIUM",
                                "contentInfo" => [
                                    "fileUrl" => "'\$IMAGE_URL'",
                                    "forceRefresh" => "false"
                                ]
                            ]
                        ],
                        [
                            "title" => "Option 2: Video",
                            "description" => "Or this video?",
                            "suggestions" => [
                                [
                                    "reply" => [
                                        "text" => "Option 2",
                                        "postbackData" => "card_2"
                                    ]
                                ]
                            ],
                            "media" => [
                                "height" => "MEDIUM",
                                "contentInfo" => [
                                    "fileUrl" => "'\$VIDEO_URL'",
                                    "forceRefresh" => "false"
                                ]
                            ]
                        ]
                    ]
                ]
            ]
        ]
    ]
);

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

全文を見る

コードを実行する

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

php send-rich-card-carousel.php

前提条件

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

pip install vonage python-dotenv

コードを書く

send-rich-card-carousel.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": {
        "richCard": {
            "carouselCard": {
                "cardWidth": "MEDIUM",
                "cardContents": [
                    {
                        "title": "Option 1: Photo",
                        "description": "Do you prefer this photo?",
                        "suggestions": [
                            {
                                "reply": {
                                    "text": "Option 1",
                                    "postbackData": "card_1",
                                }
                            }
                        ],
                        "media": {
                            "height": "MEDIUM",
                            "contentInfo": {
                                "fileUrl": MESSAGES_IMAGE_URL,
                                "forceRefresh": "false",
                            },
                        },
                    },
                    {
                        "title": "Option 2: Video",
                        "description": "Or this video?",
                        "suggestions": [
                            {
                                "reply": {
                                    "text": "Option 2",
                                    "postbackData": "card_2",
                                }
                            }
                        ],
                        "media": {
                            "height": "MEDIUM",
                            "contentInfo": {
                                "fileUrl": MESSAGES_VIDEO_URL,
                                "forceRefresh": "false",
                            },
                        },
                    },
                ],
            }
        }
    }
}

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

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

全文を見る

コードを実行する

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

python messages/rcs/send-rich-card-carousel.py

前提条件

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

gem install vonage

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

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

全文を見る

コードを書く

send-rich-card-carousel.rb に以下を追加する：

message = client.messaging.rcs(
  type: 'carousel',
  message: {
    cards: [
      {
        title: "Option 1: Photo",
        text: "Do you prefer this photo?",
        media_url: MESSAGES_IMAGE_URL,
        media_height: "SHORT",
        media_description: "Picture of a cat",
        thumbnail_url: MESSAGES_IMAGE_URL,
        media_force_refresh: false,
        suggestions: [
        {
            type: "reply",
            text: "Option 1",
            postback_data: "card_1"
          }
        ]
      },
      {
        title: "Option 2: Video",
        text: "Or this video?",
        media_url: MESSAGES_VIDEO_URL,
        media_height: "SHORT",
        media_description: "Video of a cat",
        thumbnail_url: MESSAGES_IMAGE_URL,
        media_force_refresh: false,
        suggestions: [
        {
            type: "reply",
            text: "Option 2",
            postback_data: "card_2"
          }
        ]
      }
    ]
  },
  opts: {
    rcs: {
      card_width: "SMALL"
    }
  }
)

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

全文を見る

コードを実行する

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

ruby send-rich-card-carousel.rb

試してみる

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