Révoquer un message RCS sortant

Dans cet extrait de code, vous apprendrez comment envoyer un RCS file à l'aide de l'API Messages.

Pour plus d'informations sur la messagerie RCS, voir Comprendre la messagerie 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.
`GEOSPECIFIC_MESSAGES_API_URL`	The URL for the Geo-specific Messages API endpoint. One of `https://api-eu.nexmo.com/v1/messages`, `https://api-us.nexmo.com/v1/messages`, `https://api-ap.nexmo.com/v1/messages`.
`GEOSPECIFIC_VONAGE_API_HOST`	The hostname for the Geo-specific API endpoint. One of `api-eu.nexmo.com`, `api-us.nexmo.com`, `api-ap.nexmo.com`.
`JWT`	Used to authenticate your request. See Authentication for more information, including how to generate a JWT.
`MESSAGE_UUID`	The UUID of the specific message.

NOTE : L'URI de base doit être géo-spécifique au message révoqué.

Conditions préalables

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

Rédiger le code

Ajouter ce qui suit à revoke-message.sh:

curl -X PATCH "${GEOSPECIFIC_MESSAGES_API_URL}/${MESSAGES_MESSAGE_ID}" \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{"status": "revoked"}'

Voir la source complète

Exécutez votre code

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

bash revoke-message.sh

Conditions préalables

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

npm install @vonage/server-sdk

Créez un fichier nommé revoke-message.js et ajoutez le code suivant :

const { Vonage } = require('@vonage/server-sdk');

/**
 * 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 à revoke-message.js:

vonage.messages.updateMessage(MESSAGE_ID, 'revoked')
  .then(() => console.log('Message revoked'))
  .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 revoke-message.js

Conditions préalables

Si vous n'avez pas de dossier de candidature, vous pouvez vous adresser à 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é RevokeMessage 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 RevokeMessage:

client.messages.existingMessage(MESSAGES_MESSAGE_ID, MESSAGES_GEOSPECIFIC_API_HOST).revoke()

Voir la source complète

Exécutez votre code

Nous pouvons utiliser le plugin application 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') : ''

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

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

Conditions préalables

Si vous n'avez pas de dossier de candidature, vous pouvez vous adresser à 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é RevokeMessage 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 RevokeMessage:

client.getMessagesClient().revokeOutboundMessage(MESSAGES_MESSAGE_ID, MESSAGES_GEOSPECIFIC_API_HOST);

Voir la source complète

Exécutez votre code

Nous pouvons utiliser le plugin application 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') : ''

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

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

Conditions préalables

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

Install-Package Vonage

Rédiger le code

Ajouter ce qui suit à RevokeMessage.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
await vonageClient.MessagesClient.UpdateAsync(RcsUpdateMessageRequest.Build(MESSAGES_MESSAGE_ID));

Voir la source complète

Conditions préalables

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

composer require vonage/client

Créez un fichier nommé revoke-message.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 à revoke-message.php:

$messageUuid = '1a5737ad-efd8-4efb-8edd-70d5b8b4ada7';

$client->messages()->updateRcsStatus($messageUuid, \Vonage\Messages\Client::RCS_STATUS_REVOKED);

Voir la source complète

Exécutez votre code

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

php revoke-message.php

Conditions préalables

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

pip install vonage python-dotenv

Rédiger le code

Ajouter ce qui suit à revoke-message.py:

from vonage import Auth, Vonage

client = Vonage(
    auth=Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

response = client.messages.revoke_rcs_message(MESSAGES_MESSAGE_ID)
print(response)

Voir la source complète

Exécutez votre code

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

python messages/rcs/revoke-message.py

Conditions préalables

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

gem install vonage

Créez un fichier nommé revoke-message.rb et ajoutez le code suivant :

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à revoke-message.rb:

client.messaging.update(
  message_uuid: MESSAGES_MESSAGE_ID,
  status: 'revoked'
)

Voir la source complète

Exécutez votre code

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

ruby revoke-message.rb

Essayez-le

Lorsque vous exécutez le code, une demande est faite pour révoquer le message sortant.