Enviar un mensaje RCS Rich Card Carousel
En este fragmento de código aprenderá a enviar un mensaje RCS Rich Card Carousel utilizando la función carousel tipo de mensaje del canal RCS de Messages API
- Para más información sobre RCS Messaging Comprender la mensajería RCS
- Para obtener una guía detallada sobre el
carouseltipo de mensaje véase RCS Rich Cards Tipos de mensajes
Ejemplo
A continuación encontrará la descripción de todas las variables utilizadas en cada fragmento de código:
| Clave | Descripción |
|---|---|
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 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 |
RCS_SENDER_ID | The sender ID for the RCS message. |
NOTA: No utilice un + o 00 cuando introduzca un número de teléfono, empiece por el prefijo del país, por ejemplo 447700900000.
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
Escriba el código
Añada lo siguiente a 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"
}
}'Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
npm install @vonage/server-sdk @vonage/messagesCrea un archivo llamado send-rich-card-carousel.js y añade el siguiente código:
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} : {}),
},
);Escriba el código
Añada lo siguiente a 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));Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
Añada lo siguiente a build.gradle:
implementation 'com.vonage:server-sdk-kotlin:2.1.1'Crea un archivo llamado SendRcsRichCardCarousel y añade el siguiente código al método main:
val client = Vonage {
applicationId(VONAGE_APPLICATION_ID)
privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}Escriba el código
Añada lo siguiente al método main del archivo SendRcsRichCardCarousel:
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"
)
)
)
)
)
)
))
}
)Ejecute su código
Podemos utilizar el plugin aplicación para Gradle para simplificar la ejecución de nuestra aplicación. Actualiza tu build.gradle con lo siguiente:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Ejecute el siguiente comando gradle para ejecutar su aplicación, sustituyendo com.vonage.quickstart.kt.messages.rcs por el paquete que contiene SendRcsRichCardCarousel:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
Añada lo siguiente a build.gradle:
implementation 'com.vonage:server-sdk:9.3.1'Crea un archivo llamado SendRcsRichCardCarousel y añade el siguiente código al método main:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();Escriba el código
Añada lo siguiente al método main del archivo SendRcsRichCardCarousel:
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());Ejecute su código
Podemos utilizar el plugin aplicación para Gradle para simplificar la ejecución de nuestra aplicación. Actualiza tu build.gradle con lo siguiente:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Ejecute el siguiente comando gradle para ejecutar su aplicación, sustituyendo com.vonage.quickstart.messages.rcs por el paquete que contiene SendRcsRichCardCarousel:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
Install-Package VonageEscriba el código
Añada lo siguiente a SendRcsCarouselRichCardMessage.cs:
var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new RcsCustomRequest
{
To = MESSAGES_TO_NUMBER,
From = RCS_SENDER_ID,
Custom =
new
{
ContentMessage = new
{
RichCard = new
{
CarouselCard = new
{
CardWidth = "MEDIUM",
CardContents = new[]
{
new
{
Title = "Option 1: Photo",
Description = "Do you prefer this photo?",
Media = new
{
Height = "MEDIUM",
ContentInfo = new
{
FileUrl = MESSAGES_IMAGE_URL,
ForceRefresh = false
}
},
Suggestions = new[]
{
new
{
Reply = new
{
Text = "Option 1",
PostbackData = "card_1"
}
}
}
},
new
{
Title = "Option 2: Video",
Description = "Do you prefer this video?",
Media = new
{
Height = "MEDIUM",
ContentInfo = new
{
FileUrl = MESSAGES_VIDEO_URL,
ForceRefresh = false
}
},
Suggestions = new[]
{
new
{
Reply = new
{
Text = "Option 2",
PostbackData = "card_2"
}
}
}
}
}
}
}
}
}
};
var response = await vonageClient.MessagesClient.SendAsync(request);
Console.WriteLine($"Message UUID: {response.MessageUuid}");Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
composer require vonage/clientCrea un archivo llamado send-rich-card-carousel.php y añade el siguiente código:
$keypair = new \Vonage\Client\Credentials\Keypair(
file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
VONAGE_APPLICATION_ID
);
$client = new \Vonage\Client($keypair);Escriba el código
Añada lo siguiente a 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);Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
pip install vonage python-dotenvEscriba el código
Añada lo siguiente a 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)Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
gem install vonageCrea un archivo llamado send-rich-card-carousel.rb y añade el siguiente código:
Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Pruébalo
Al ejecutar el código, se envía un mensaje al número de destino.