Enviar uma mensagem RCS com sugestão de ação (abrir um URL)

Neste trecho de código, você aprenderá a enviar uma mensagem de ação sugerida do RCS usando o text tipo de mensagem do canal RCS da Messages API. Essa mensagem solicitará que o destinatário abra uma URL no navegador padrão do dispositivo ou no aplicativo registrado.

Exemplo

Veja a seguir a descrição de todas as variáveis utilizadas em cada trecho de código:

ChaveDescriçã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 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.

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-suggested-action-open-url.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": "Check out our latest offers!",
    "suggestions": [
      {
        "type": "open_url",
        "text": "Open product page",
        "postback_data": "postback_data_1234",
        "url": "http://example.com/",
        "description": "A URL for the Example website"
      }
    ]
  }'

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

bash send-suggested-action-open-url.sh

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/messages

Crie um arquivo chamado ` send-suggested-action-open-url.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} : {}),
  },
);

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` send-suggested-action-open-url.js`:

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      text: 'Need some help? Call us now or visit our website for more information.',
      suggestions: [
        {
          action: {
            text: 'Call us',
            postbackData: 'postback_data_1234',
            fallbackUrl: 'https://www.example.com/contact/',
            dialAction: {
              phoneNumber: '+447900000000',
            },
          },
        },
        {
          action: {
            text: 'Visit site',
            postbackData: 'postback_data_1234',
            openUrlAction: {
              url: 'http://example.com/',
            },
          },
        },
      ],
    },
  },
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

node send-suggested-action-open-url.js

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 ` SendRcsSuggestedOpenUrl ` e adicione o código a seguir ao método ` main `:

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

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao método ` main ` do arquivo ` SendRcsSuggestedOpenUrl `:

val messageId = client.messages.send(
    rcsCustom {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "text" to "Check out our latest offers!",
                "suggestions" to listOf(
                    mapOf(
                        "action" to mapOf(
                            "text" to "Open product page",
                            "postbackData" to "postback_data_1234",
                            "openUrlAction" to mapOf(
                                "url" to "https://example.com/product"
                            )
                        )
                    )
                )
            )
        ))
    }
)

Ver código-fonte completo

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 ` SendRcsSuggestedOpenUrl`:

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

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 ` SendRcsSuggestedOpenUrl ` 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();

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao método ` main ` do arquivo ` SendRcsSuggestedOpenUrl `:

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"text", "Check out our latest offers!",
				"suggestions", List.of(
					Map.of(
						"action", Map.of(
							"text", "Open product page",
							"postbackData", "postback_data_1234",
							"openUrlAction" , Map.of(
								"url", "https://example.com/product"
							)
						)
					)
				)
			))
		).build()
);
System.out.println("Message sent successfully. ID: " + response.getMessageUuid());

Ver código-fonte completo

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 ` SendRcsSuggestedOpenUrl`:

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

Pré-requisitos

Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.

Install-Package Vonage

Escreva o código

Adicione o seguinte ao arquivo ` SendRcsSuggestedActionOpenUrlMessage.cs`:

var request = new RcsTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "Check out our latest offers!",
    Suggestions =
    [
        new OpenUrlSuggestion(
            "Open product page", 
            "postback_data_1234",
            new Uri("http://example.com/"), 
            "A URL for the Example website")
    ]
};
var response = await vonageClient.MessagesClient.SendAsync(request);

Ver código-fonte completo

Pré-requisitos

Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.

composer require vonage/client

Crie um arquivo chamado ` send-suggested-action-open-url.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);

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` send-suggested-action-open-url.php`:

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "text" => "Check out our latest offers!",
            "suggestions" => [
                [
                    "action" => [
                        "text" => "Open product page",
                        "postbackData" => "postback_data_1234",
                        "openUrlAction" => ["url" => "http://example.com/"],
                    ],
                ],
            ],
        ],
    ]
);

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

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

php send-suggested-action-open-url.php

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-dotenv

Escreva o código

Adicione o seguinte ao arquivo ` send-suggested-action-open-url.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": "Check out our latest offers!",
        "suggestions": [
            {
                "action": {
                    "text": "Open product page",
                    "postbackData": "postback_data_1234",
                    "openUrlAction": {"url": "http://example.com/"},
                }
            }
        ],
    }
}

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

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

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

python messages/rcs/send-suggested-action-open-url.py

Pré-requisitos

Se você não tiver um aplicativo, acesse criar um. Certifique-se também de acessar configure seus webhooks.

gem install vonage

Crie um arquivo chamado ` send-suggested-action-open-url.rb ` e insira o seguinte código:

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

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` send-suggested-action-open-url.rb`:

message = client.messaging.rcs(
  type: 'text',
  message: "Check out our latest offers!",
  opts: {
    suggestions: [
      {
        type: "open_url",
        text: "Open product page",
        postback_data: "postback_data_1234",
        url: "https://www.example.com/",
        description: "A URL for the Example website"
      }
    ]
  }
)

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

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

ruby send-suggested-action-open-url.rb

Experimente

Ao executar o código, uma mensagem é enviada para o número de destino.