RCSスタンドアロン・リッチカード・メッセージの送信
このコード・スニペットでは、RCSリッチ・カード・メッセージの送信方法について説明します。 card Messages API RCSチャネルのメッセージタイプ
- RCSメッセージングの詳細については RCSメッセージングを理解する
- についての詳しいガイドは
cardメッセージタイプ 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 |
JWT | Used to authenticate your request. See |
IMAGE_URL | The link to the image file to send. |
TO_NUMBER | The number you are sending the RCS message to in E.164 format. For example |
RCS_SENDER_ID | The sender ID for the RCS message. |
注: 先頭の + または 00 電話番号を入力する場合は、国番号から始めます。 447700900000.
コードを書く
send-rich-card-standalone.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": "card",
"card": {
"title": "Quick question",
"text": "Do you like this picture?",
"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": "Yes",
"postback_data": "suggestion_1"
},
{
"type": "reply",
"text": "I love it!",
"postback_data": "suggestion_2"
}
]
},
"rcs": {
"card_orientation": "HORIZONTAL",
"image_alignment": "RIGHT"
}
}'コードを実行する
このファイルをあなたのマシンに保存し、実行する:
前提条件
npm install @vonage/server-sdk @vonage/messagessend-rich-card-standalone.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-standalone.js に以下を追加する:
vonage.messages.send({
messageType: 'custom',
channel: Channels.RCS,
custom: {
contentMessage: {
richCard: {
standaloneCard: {
thumbnailImageAlignment: 'RIGHT',
cardOrientation: 'VERTICAL',
cardContent: {
title: 'Quick question',
description: 'Do you like this picture?',
media: {
height: 'TALL',
contentInfo: {
fileUrl: MESSAGES_IMAGE_URL,
forceRefresh: 'false',
},
},
suggestions: [
{
reply: {
text: 'Yes',
postbackData: 'suggestion_1',
},
},
{
reply: {
text: 'I love it!',
postbackData: 'suggestion_2',
},
},
],
},
},
},
},
},
to: MESSAGES_TO_NUMBER,
from: RCS_SENDER_ID,
})
.then(({ messageUUID }) => console.log(messageUUID))
.catch((error) => console.error(error));コードを実行する
このファイルをあなたのマシンに保存し、実行する:
前提条件
コードを書く
SendRcsRichCard ファイルのmain メソッドに以下を追加する:
val messageId = client.messages.send(
rcsCustom {
to(MESSAGES_TO_NUMBER)
from(RCS_SENDER_ID)
custom(mapOf(
"contentMessage" to mapOf(
"richCard" to mapOf(
"standaloneCard" to mapOf(
"thumbnailImageAlignment" to "RIGHT",
"cardOrientation" to "VERTICAL",
"cardContent" to mapOf(
"title" to "Quick question",
"description" to "Do you like this picture?",
"media" to mapOf(
"height" to "TALL",
"contentInfo" to mapOf(
"fileUrl" to MESSAGES_IMAGE_URL,
"forceRefresh" to "false"
)
),
"suggestions" to listOf(
mapOf(
"reply" to mapOf(
"text" to "Yes",
"postbackData" to "suggestion_1"
)
),
mapOf(
"reply" to mapOf(
"text" to "I love it!",
"postbackData" to "suggestion_2"
)
)
)
)
)
)
)
))
}
)コードを実行する
Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''以下のgradle コマンドを実行し、com.vonage.quickstart.kt.messages.rcs をSendRcsRichCard を含むパッケージに置き換えてアプリケーションを実行する:
前提条件
build.gradle に以下を追加する:
implementation 'com.vonage:server-sdk:9.3.1'SendRcsRichCard という名前のファイルを作成し、main メソッドに以下のコードを追加する:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();コードを書く
SendRcsRichCard ファイルのmain メソッドに以下を追加する:
var response = client.getMessagesClient().sendMessage(
RcsCustomRequest.builder()
.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
.custom(Map.of("contentMessage", Map.of(
"richCard", Map.of("standaloneCard", Map.of(
"thumbnailImageAlignment", "RIGHT",
"cardOrientation", "VERTICAL",
"cardContent", Map.of(
"title", "Quick question",
"description", "Do you like this picture?",
"media", Map.of(
"height", "TALL",
"contentInfo", Map.of(
"fileUrl", MESSAGES_IMAGE_URL,
"forceRefresh", "false"
)
),
"suggestions", List.of(
Map.of(
"reply", Map.of(
"text", "Yes",
"postbackData", "suggestion_1"
)
),
Map.of(
"reply", Map.of(
"text", "I love it!",
"postbackData", "suggestion_2"
)
)
)
)
))
))
).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 をSendRcsRichCard を含むパッケージに置き換えてアプリケーションを実行する:
コードを書く
SendRcsStandaloneRichCardMessage.cs に以下を追加する:
var request = new RcsCardRequest()
{
To = MESSAGES_TO_NUMBER,
From = RCS_SENDER_ID,
Card = new CardAttachment("Quick question", "Do you like this picture?", new Uri(MESSAGES_IMAGE_URL))
.WithMediaDescription("Picture of a cat")
.WithMediaHeight(CardAttachment.Height.Short)
.WithThumbnailUrl(new Uri(MESSAGES_IMAGE_URL))
.AppendSuggestion(new ReplySuggestion("Yes", "suggestion_1"))
.AppendSuggestion(new ReplySuggestion("I love it!", "suggestion_2")),
Rcs = new MessageRcs()
{
CardOrientation = RcsCardOrientation.Horizontal,
ImageAlignment = RcsImageAlignment.Right,
},
};
var response = await vonageClient.MessagesClient.SendAsync(request);前提条件
composer require vonage/clientsend-rich-card-standalone.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-standalone.php に以下を追加する:
$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
'07778887777',
'09997485156',
[
"contentMessage" => [
"richCard" => [
"standaloneCard" => [
"thumbnailImageAlignment" => "RIGHT",
"cardOrientation" => "VERTICAL",
"cardContent" => [
"title" => "Quick question",
"description" => "Do you like this picture?",
"media" => [
"height" => "TALL",
"contentInfo" => [
"fileUrl" => "'\$IMAGE_URL'",
"forceRefresh" => "false"
]
],
"suggestions" => [
[
"reply" => [
"text" => "Yes",
"postbackData" => "suggestion_1"
]
],
[
"reply" => [
"text" => "I love it!",
"postbackData" => "suggestion_2"
]
]
]
]
]
]
]
]
);
$client->messages()->send($rcsCard);コードを実行する
このファイルをあなたのマシンに保存し、実行する:
コードを書く
send-rich-card-standalone.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": {
"standaloneCard": {
"thumbnailImageAlignment": "RIGHT",
"cardOrientation": "VERTICAL",
"cardContent": {
"title": "Quick question",
"description": "Do you like this picture?",
"media": {
"height": "TALL",
"contentInfo": {
"fileUrl": MESSAGES_IMAGE_URL,
"forceRefresh": "false",
},
},
"suggestions": [
{
"reply": {
"text": "Yes",
"postbackData": "suggestion_1",
}
},
{
"reply": {
"text": "I love it!",
"postbackData": "suggestion_2",
}
},
],
},
}
}
}
}
message = RcsCustom(
to=MESSAGES_TO_NUMBER,
from_=RCS_SENDER_ID,
custom=custom_dict,
)
response = client.messages.send(message)
print(response)コードを実行する
このファイルをあなたのマシンに保存し、実行する:
前提条件
コードを書く
send-rich-card-standalone.rb に以下を追加する:
message = client.messaging.rcs(
type: 'card',
message: {
title: "Quick question",
text: "Do you like this picture?",
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: "Yes",
postback_data: "suggestion_1"
},
{
type: "reply",
text: "I love it!",
postback_data: "suggestion_2"
}
]
},
opts: {
rcs: {
card_orientation: "HORIZONTAL",
image_alignment: "RIGHT"
}
}
)
client.messaging.send(
from: RCS_SENDER_ID,
to: MESSAGES_TO_NUMBER,
**message
)コードを実行する
このファイルをあなたのマシンに保存し、実行する:
試してみる
コードを実行すると、宛先番号にメッセージが送信される。