Enviar un mensaje de acción sugerida RCS (Abrir una URL)

En este fragmento de código aprenderá a enviar un mensaje RCS Suggested Action utilizando el comando text del canal RCS de la Messages API. Este mensaje pedirá al destinatario que abra una URL en el navegador predeterminado o en la aplicación registrada de su dispositivo.

Para más información sobre RCS Messaging Comprender la mensajería RCS
Para obtener una guía detallada sobre las fichas de sugerencias, consulte Sugerencias RCS Chips

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 `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: 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-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 fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

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

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

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

Crea un archivo llamado send-suggested-action-open-url.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} : {}),
  },
);

Ver fuente completa

Escriba el código

Añada lo siguiente a 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 fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

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

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 SendRcsSuggestedOpenUrl y añade el siguiente código al método main:

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

Ver fuente completa

Escriba el código

Añada lo siguiente al método main del archivo 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 fuente completa

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

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

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

Ver fuente completa

Escriba el código

Añada lo siguiente al método main del archivo 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 fuente completa

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

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

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

Install-Package Vonage

Escriba el código

Añada lo siguiente a SendRcsSuggestedActionOpenUrlMessage.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
            {
                Text = "Check out our latest offers!",
                Suggestions = new[]
                {
                    new
                    {
                        Action = new
                        {
                            Text = "Open product page",
                            PostbackData = "postback_data_1234",
                            OpenUrlAction = new
                            {
                                Url = "https://example.com"
                            }
                        }
                    }
                }
            }
        }
};
var response = await vonageClient.MessagesClient.SendAsync(request);
Console.WriteLine($"Message UUID: {response.MessageUuid}");

Ver fuente completa

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

composer require vonage/client

Crea un archivo llamado send-suggested-action-open-url.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);

Ver fuente completa

Escriba el código

Añada lo siguiente a 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 fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

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

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

pip install vonage python-dotenv

Escriba el código

Añada lo siguiente a 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 fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

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

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

gem install vonage

Crea un archivo llamado send-suggested-action-open-url.rb y añade el siguiente código:

Ver fuente completa

Escriba el código

Añada lo siguiente a send-suggested-action-open-url.rb:

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

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

Pruébalo

Al ejecutar el código, se envía un mensaje al número de destino.