Envoyer un message texte

Dans cet extrait de code, vous apprendrez à envoyer un message WhatsApp à l'aide de l'API Messages. Pour WhatsApp, la taille maximale du texte est de 4096 caractères, Unicode compris.

Pour un guide étape par étape sur ce sujet, vous pouvez lire notre tutoriel Envoi de messages WhatsApp avec l'API Messages.

IMPORTANT : Si un client ne vous a pas envoyé de message au préalable, la première fois que vous envoyez un message à un utilisateur, WhatsApp exige que le message contienne un modèle. Ceci est expliqué plus en détail dans la section Comprendre le sujet de WhatsApp.

Il est possible de formater le texte sélectionné dans le message à l'aide de caractères de formatage. Les \n peut également être utilisé pour insérer de nouvelles lignes. Les options de formatage sont résumées dans le tableau suivant :

Formatage Exemple
Mettre en italique Mettre en italique _this_ texte.
Gras Gras *this* texte.
Barré Barré ~this~ texte.
Monospace Monospace ``ceci``` texte.
Nouvelle ligne Utilisation \n pour insérer une nouvelle ligne.

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_APPLICATION_PRIVATE_KEY_PATH

Private key path.

VONAGE_PRIVATE_KEY_PATH

Private key path.

BASE_URL

For production use the base URL is https://api.nexmo.com/. For sandbox testing the base URL is https://messages-sandbox.nexmo.com/.

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.

WHATSAPP_NUMBER

The WhatsApp number that has been allocated to you by Vonage. For sandbox testing the number is 14157386102.

VONAGE_WHATSAPP_NUMBER

Refer to WHATSAPP_NUMBER above.

VONAGE_NUMBER

Refer to WHATSAPP_NUMBER above.

TO_NUMBER

Replace with the number you are sending to. E.g. 447700900001

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 dossier de candidature, vous pouvez vous adresser à créer un. Veillez également à configurer vos webhooks.

Rédiger le code

Ajouter ce qui suit à send-text.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": "'${WHATSAPP_SENDER_ID}'",
    "channel": "whatsapp",
    "message_type": "text",
    "text": "This is a WhatsApp text message sent using the Vonage Messages API."
  }'

Voir la source complète

Exécutez votre code

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

bash send-text.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 @vonage/messages

Créez un fichier nommé send-text.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-text.js:

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: 'text',
  text: 'This is a WhatsApp text message sent using the Vonage Messages API.',
})
  .then((resp) => console.log(resp.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-text.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é SendWhatsappText 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 SendWhatsappText:

val messageId = client.messages.send(
    whatsappText {
        to(MESSAGES_TO_NUMBER)
        from(WHATSAPP_SENDER_ID)
        text("This is a WhatsApp text message sent using the Messages API")
    }
)

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.whatsapp par le paquet contenant SendWhatsappText:

gradle run -Pmain=com.vonage.quickstart.kt.messages.whatsapp.SendWhatsappText

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é SendWhatsappText 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 SendWhatsappText:

var response = client.getMessagesClient().sendMessage(
		WhatsappTextRequest.builder()
			.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.text("This is a WhatsApp Message text message sent using the Messages API")
			.build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());

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.whatsapp par le paquet contenant SendWhatsappText:

gradle run -Pmain=com.vonage.quickstart.messages.whatsapp.SendWhatsappText

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 à SendWhatsAppText.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new WhatsAppTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = WHATSAPP_SENDER_ID,
    Text = "A WhatsApp text message sent using the Vonage Messages API"
};
var response = await vonageClient.MessagesClient.SendAsync(request);

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é send-text.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-text.php:

$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppText(
    TO_NUMBER,
    FROM_NUMBER,
    'This is a text message sent using the Vonage PHP SDK'
);

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

Voir la source complète

Exécutez votre code

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

php send-text.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 à send-text.py:

from vonage import Auth, Vonage
from vonage_messages import WhatsappText

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

message = WhatsappText(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    text='Hello from the Vonage Messages API.',
)

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/whatsapp/send-text.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é send-text.rb et ajoutez le code suivant :

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à send-text.rb:

message = client.messaging.whatsapp(
  type: 'text',
  message: "This is a WhatsApp Message text message sent using the Messages API"
)

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

Voir la source complète

Exécutez votre code

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

ruby send-text.rb

Essayez-le

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