Envoyer un message RCS d'action suggérée (partager un lieu)

Dans cet extrait de code, vous apprendrez comment envoyer un message d'action suggérée RCS à l'aide de la commande text du canal RCS de l'API Messages. Ce message invitera le destinataire à partager sa position via l'application cartographique par défaut de son appareil.

Pour plus d'informations sur la messagerie RCS, voir Comprendre la messagerie RCS
Pour un guide détaillé sur les puces de suggestion, voir Puces de suggestion RCS

Exemple

Vous trouverez ci-dessous la description de toutes les variables utilisées dans chaque extrait de code :

Clé	Description
`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.

NOTE : N'utilisez pas de point de départ + ou 00 lorsque vous saisissez un numéro de téléphone, commencez par l'indicatif du pays, par exemple 447700900000.

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

Rédiger le code

Ajouter ce qui suit à send-suggested-action-share-location.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": "Your driver will come and meet you at your specified location.",
    "suggestions": [
      {
        "type": "share_location",
        "text": "Share a location",
        "postback_data": "postback_data_1234"
      }
    ]
  }'

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

bash send-suggested-action-share-location.sh

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

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

Créez un fichier nommé send-suggested-action-share-location.js et ajoutez le code suivant :

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} : {}),
  },
);

Voir la source complète

Rédiger le code

Ajouter ce qui suit à send-suggested-action-share-location.js:

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      text: 'Your driver will come and meet you at your specified location.',
      suggestions: [
        {
          action: {
            text: 'Share a location',
            postbackData: 'postback_data_1234',
            shareLocationAction: {},
          },
        },
      ],
    },
  },
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

node send-suggested-action-share-location.js

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

Ajouter ce qui suit à build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Créez un fichier nommé SendRcsSuggestedShareLocation et ajoutez le code suivant à la méthode main:

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à la méthode main du fichier SendRcsSuggestedShareLocation:

val messageId = client.messages.send(
    rcsCustom {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "text" to "Your driver will come and meet you at your specified location.",
                "suggestions" to listOf(
                    mapOf(
                        "action" to mapOf(
                            "text" to "Share a location",
                            "postbackData" to "postback_data_1234",
                            "shareLocationAction" to emptyMap<String, Any>()
                        )
                    )
                )
            )
        ))
    }
)

Voir la source complète

Exécutez votre code

Nous pouvons utiliser le plugin Applications pour Gradle afin de simplifier l'exécution de notre application. Mettez à jour votre build.gradle avec ce qui suit :

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Exécutez la commande gradle suivante pour exécuter votre application, en remplaçant com.vonage.quickstart.kt.messages.rcs par le paquet contenant SendRcsSuggestedShareLocation:

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

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

Ajouter ce qui suit à build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Créez un fichier nommé SendRcsSuggestedShareLocation et ajoutez le code suivant à la méthode main:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

Voir la source complète

Rédiger le code

Ajouter ce qui suit à la méthode main du fichier SendRcsSuggestedShareLocation:

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"text", "Your driver will come and meet you at your specified location.",
				"suggestions", List.of(
					Map.of(
						"action", Map.of(
							"text", "Share a location",
							"postbackData", "postback_data_1234",
							"shareLocationAction", Map.of()
						)
					)
				)
			))
		).build()
);
System.out.println("Message sent successfully. ID: " + response.getMessageUuid());

Voir la source complète

Exécutez votre code

Nous pouvons utiliser le plugin Applications pour Gradle afin de simplifier l'exécution de notre application. Mettez à jour votre build.gradle avec ce qui suit :

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Exécutez la commande gradle suivante pour exécuter votre application, en remplaçant com.vonage.quickstart.messages.rcs par le paquet contenant SendRcsSuggestedShareLocation:

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

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

Install-Package Vonage

Rédiger le code

Ajouter ce qui suit à SendRcsSuggestedActionShareLocationMessage.cs:

var request = new RcsTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "Your driver will come and meet you at your specified location.",
    Suggestions =
    [
        new ShareLocationSuggestion("Share a location", "postback_data_1234"),
    ]
};
var response = await vonageClient.MessagesClient.SendAsync(request);

Voir la source complète

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

composer require vonage/client

Créez un fichier nommé send-suggested-action-share-location.php et ajoutez le code suivant :

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

Voir la source complète

Rédiger le code

Ajouter ce qui suit à send-suggested-action-share-location.php:

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "text" =>
                "Your driver will come and meet you at your specified location.",
            "suggestions" => [
                [
                    "action" => [
                        "text" => "Share a location",
                        "postbackData" => "postback_data_1234",
                        "shareLocationAction" => [],
                    ],
                ],
            ],
        ],
    ]
);

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

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

php send-suggested-action-share-location.php

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

pip install vonage python-dotenv

Rédiger le code

Ajouter ce qui suit à send-suggested-action-share-location.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": "Your driver will come and meet you at your specified location.",
        "suggestions": [
            {
                "action": {
                    "text": "Share a location",
                    "postbackData": "postback_data_1234",
                    "shareLocationAction": {},
                }
            }
        ],
    }
}


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

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

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

python messages/rcs/send-suggested-action-share-location.py

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

gem install vonage

Créez un fichier nommé send-suggested-action-share-location.rb et ajoutez le code suivant :

Voir la source complète

Rédiger le code

Ajouter ce qui suit à send-suggested-action-share-location.rb:

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

ruby send-suggested-action-share-location.rb

Essayez-le

Lorsque vous exécutez le code, un message est envoyé au numéro de destination.