Enviar uma mensagem RCS Standalone Rich Card
Neste trecho de código, você aprenderá a enviar uma mensagem RCS Rich Card usando o card tipo de mensagem do canal RCS da Messages API
- Para obter mais informações sobre o RCS Messaging, consulte Entendendo as mensagens RCS
- Para um guia detalhado sobre o
cardtipo de mensagem, consulte Tipos de mensagens de Rich Cards do RCS
Exemplo
Veja a seguir a descrição de todas as variáveis utilizadas em cada trecho de código:
| Chave | Descrição |
|---|---|
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. |
NOTA: Não use um espaço à esquerda + ou 00 Ao digitar um número de telefone, comece com o código do país, por exemplo 447700900000.
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
Escreva o código
Adicione o seguinte ao arquivo ` 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"
}
}'Execute seu código
Salve este arquivo no seu computador e execute-o:
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
npm install @vonage/server-sdk @vonage/messagesCrie um arquivo chamado ` send-rich-card-standalone.js ` e insira o seguinte 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} : {}),
},
);Escreva o código
Adicione o seguinte ao arquivo ` 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));Execute seu código
Salve este arquivo no seu computador e execute-o:
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
Adicione o seguinte ao arquivo ` build.gradle`:
implementation 'com.vonage:server-sdk-kotlin:2.1.1'Crie um arquivo chamado ` SendRcsRichCard ` e adicione o código a seguir ao método ` main `:
val client = Vonage {
applicationId(VONAGE_APPLICATION_ID)
privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}Escreva o código
Adicione o seguinte ao método ` main ` do arquivo ` SendRcsRichCard `:
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"
)
)
)
)
)
)
)
))
}
)Execute seu código
Podemos usar o plugin “ aplicativo ” para o Gradle a fim de simplificar a execução do nosso aplicativo. Atualize seu arquivo ` build.gradle ` com o seguinte:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Execute o seguinte comando ` gradle ` para rodar seu aplicativo, substituindo ` com.vonage.quickstart.kt.messages.rcs ` pelo pacote que contém ` SendRcsRichCard`:
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
Adicione o seguinte ao arquivo ` build.gradle`:
implementation 'com.vonage:server-sdk:9.3.1'Crie um arquivo chamado ` SendRcsRichCard ` e adicione o código a seguir ao método ` main `:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();Escreva o código
Adicione o seguinte ao método ` main ` do arquivo ` SendRcsRichCard `:
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());Execute seu código
Podemos usar o plugin “ aplicativo ” para o Gradle a fim de simplificar a execução do nosso aplicativo. Atualize seu arquivo ` build.gradle ` com o seguinte:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Execute o seguinte comando ` gradle ` para rodar seu aplicativo, substituindo ` com.vonage.quickstart.messages.rcs ` pelo pacote que contém ` SendRcsRichCard`:
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
Install-Package VonageEscreva o código
Adicione o seguinte ao arquivo ` 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);Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
composer require vonage/clientCrie um arquivo chamado ` send-rich-card-standalone.php ` e insira o seguinte código:
$keypair = new \Vonage\Client\Credentials\Keypair(
file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
VONAGE_APPLICATION_ID
);
$client = new \Vonage\Client($keypair);Escreva o código
Adicione o seguinte ao arquivo ` 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);Execute seu código
Salve este arquivo no seu computador e execute-o:
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
pip install vonage python-dotenvEscreva o código
Adicione o seguinte ao arquivo ` 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)Execute seu código
Salve este arquivo no seu computador e execute-o:
Pré-requisitos
Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.
gem install vonageCrie um arquivo chamado ` send-rich-card-standalone.rb ` e insira o seguinte código:
client = Vonage::Client.new(
application_id: VONAGE_APPLICATION_ID,
private_key: VONAGE_PRIVATE_KEY
)Escreva o código
Adicione o seguinte ao arquivo ` 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
)Execute seu código
Salve este arquivo no seu computador e execute-o:
Experimente
Ao executar o código, uma mensagem é enviada para o número de destino.