Démarrage rapide : Envoyer des messages WhatsApp à l’aide de messages avancés

Prérequis

• Compte WhatsApp Business inscrit auprès de votre ressource Azure Communication Services

• Numéro de téléphone WhatsApp actif pour recevoir des messages

• Environnement de développement .NET (comme Visual Studio, Visual Studio Code ou Interface CLI .NET)

Configuration

Créer le projet .NET

dotnet build
dotnet run

dotnet new console -o AdvancedMessagingQuickstart

cd AdvancedMessagingQuickstart
dotnet build

Installer le package

Installez le package NuGet Azure.Communication.Messages dans votre projet C#.

dotnet add package Azure.Communication.Messages

dotnet add package Azure.Communication.Messages

Configurer le framework d’application

Ouvrez le fichier Program.cs dans un éditeur de texte.

Remplacez le contenu de vote fichier Program.cs par le code suivant :

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Communication.Messages;

namespace AdvancedMessagingQuickstart
{
    class Program
    {
        public static async Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Send WhatsApp Messages");

            // Quickstart code goes here
        }
    }
}

Pour utiliser les fonctionnalités de messagerie avancée, nous ajoutons une directive using afin d’inclure l’espace de noms Azure.Communication.Messages.

using Azure.Communication.Messages;

Modèle objet

Les classes et interfaces suivantes gèrent certaines des principales fonctionnalités du kit de développement logiciel (SDK) Messagerie avancée Azure Communication Services pour .NET.

Exemples de code

Suivez ces étapes pour ajouter les extraits de code nécessaires à la fonction Main de votre fichier Program.cs.

• Authentifier le client
• Définir un ID d’inscription de canal
• Définir la liste des destinataires
• Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp
  • Envoyer un modèle de message à un utilisateur WhatsApp
  • Lancer la conversation à partir de l’utilisateur
• Envoyer un SMS à un utilisateur WhatsApp
• Envoyer un message multimédia à un utilisateur WhatsApp

Authentifier le client

NotificationMessagesClient est utilisé pour se connecter à votre ressource Azure Communication Services.

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

// Retrieve connection string from environment variable
string connectionString = 
    Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");

// Instantiate the client
var notificationMessagesClient = new NotificationMessagesClient(connectionString);

setx COMMUNICATION_SERVICES_KEY "<your key>"

// Retrieve key from environment variable
string key = 
    Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_KEY");

// Configure authentication
var endpoint = new Uri("https://<resource name>.communication.azure.com");
var credential = new AzureKeyCredential(key);

// Instantiate the client
var notificationMessagesClient = 
    new NotificationMessagesClient(endpoint, credential);

Définir un ID d’inscription de canal

Le GUID de l’ID d’inscription de canal a été créé pendant l’inscription du canal. Vous pouvez le rechercher dans le portail sous l’onglet Canaux de votre ressource Azure Communication Services.

Attribuez-le à une variable appelée channelRegistrationId.

var channelRegistrationId = new Guid("<your channel registration ID GUID>");

Définir la liste des destinataires

Vous devez fournir un numéro de téléphone réel associé à un compte WhatsApp. Ce compte WhatsApp reçoit les modèles de messages, les messages multimédias et les SMS envoyés dans ce guide de démarrage rapide. Pour ce guide de démarrage rapide, ce numéro de téléphone peut être votre numéro de téléphone personnel.

Le numéro de téléphone du destinataire ne peut pas être le numéro de téléphone professionnel (ID d’expéditeur) associé à l’inscription du canal WhatsApp. L’ID d’expéditeur s’affiche comme étant l’expéditeur des messages textuels et multimédias envoyés au destinataire.

Le numéro de téléphone doit inclure le code du pays. Pour plus d’informations sur la mise en forme des numéros de téléphone, consultez la documentation WhatsApp sur les Formats des numéros de téléphone.

Créez la liste des destinataires de la façon suivante :

var recipientList = new List<string> { "<to WhatsApp phone number>" };

Exemple :

// Example only
var recipientList = new List<string> { "+14255550199" };

Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp

Les conversations entre un compte WhatsApp Business et un utilisateur WhatsApp peuvent être lancées de deux manières :

• L’entreprise envoie un message modèle à l’utilisateur WhatsApp.
• L’utilisateur WhatsApp envoie n’importe quel message au numéro professionnel.

Quelle que soit la façon dont la conversation a été démarrée, une entreprise ne peut envoyer des modèles de messages qu’une fois que l’utilisateur a envoyé un message à l’entreprise. Ce n’est qu’une fois que l’utilisateur a envoyé un message à l’entreprise que celle-ci est autorisée à lui envoyer des messages multimédias ou des SMS pendant la conversation active. Une fois la fenêtre de conversation de 24 heures expirée, la conversation doit être relancée. Pour en savoir plus sur les conversations, consultez la définition sur le site Plateforme WhatsApp Business.

(Option 1) Lancer une conversation à partir de l’entreprise : Envoyer un modèle de message

Lancez une conversation en envoyant un message modèle.

Commencez par créer un MessageTemplate en utilisant les valeurs d’un modèle.

Voici la création de MessageTemplate à partir d’un modèle par défaut, sample_template.
Si vous n’avez pas accès à sample_template, passez à l’Option 2. Les utilisateurs avancés peuvent consulter la page Modèles pour découvrir comment envoyer un autre modèle avec l’option 1.

Le Kit de développement logiciel (SDK) Messages permet à Contoso d’envoyer des modèles de messages WhatsApp aux utilisateurs de WhatsApp. Pour envoyer un modèle de message, vous devez :

• NotificationMessagesClient authentifié
• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Détails du modèle
  • Un nom comme « exemple de modèle »
  • Une langue comme « en_us »
  • Paramètres le cas échéant

// Assemble the template content
string templateName = "sample_template";
string templateLanguage = "en_us";
var messageTemplate = new MessageTemplate(templateName, templateLanguage);

Pour obtenir plus d’exemples sur l’assemblage de votre MessageTemplate et la création de votre propre modèle, consultez la ressource suivante :

• Envoyer des messages modèles WhatsApp

Pour plus d’informations sur les exigences WhatsApp relatives aux modèles, consultez les informations de référence de l’API WhatsApp Business Platform :

• Créer et gérer des modèles
• Composants du modèle
• Envoi de modèles de message

Assemblez puis envoyez le modèle de message :

// Assemble template message
var templateContent = 
    new TemplateNotificationContent(channelRegistrationId, recipientList, messageTemplate);

// Send template message
Response<SendMessageResult> sendTemplateMessageResult = 
    await notificationMessagesClient.SendAsync(templateContent);

À présent, l’utilisateur doit répondre au modèle de message. À partir du compte d’utilisateur WhatsApp, répondez au message modèle reçu du compte WhatsApp Business. Le contenu du message n’a pas d’importance pour ce scénario.

(Option 2) Lancer la conversation à partir de l’utilisateur

L’autre option pour lancer une conversation entre un compte WhatsApp Business et un utilisateur WhatsApp est de laisser l’utilisateur lancer la conversation. Pour ce faire, à partir de votre compte WhatsApp personnel, envoyez un message à votre numéro professionnel (ID d’expéditeur).

Envoyer un SMS à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des messages textes WhatsApp, lancés par des utilisateurs WhatsApp. Pour envoyer un message texte, vous devez :

• NotificationMessagesClient authentifié
• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Corps/texte du message à envoyer

Dans cet exemple, nous répondons à l’utilisateur WhatsApp avec le texte « Merci pour vos commentaires.\n Du SDK de Messagerie de Notification ».

Assemblez puis envoyez le SMS :

// Assemble text message
var textContent = 
    new TextNotificationContent(channelRegistrationId, recipientList, "Thanks for your feedback.\n From Notification Messaging SDK");

// Send text message
Response<SendMessageResult> sendTextMessageResult = 
    await notificationMessagesClient.SendAsync(textContent);

Envoyer un message multimédia à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des messages multimédias WhatsApp aux utilisateurs de WhatsApp. Pour envoyer un message multimédia incorporé, vous avez besoin des éléments suivants :

• NotificationMessagesClient authentifié
• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• MediaUri de l’image

Par exemple, créez un URI :

var uri = new Uri("https://aka.ms/acsicon1");

Assemblez puis envoyez le message multimédia :

// Assemble media message
var mediaContent = 
    new MediaNotificationContent(channelRegistrationId, recipientList, uri);

// Send media message
Response<SendMessageResult> sendMediaMessageResult = 
    await notificationMessagesClient.SendAsync(mediaContent);

Exécuter le code

Générez et exécutez votre programme.

Pour envoyer un SMS ou un message multimédia à un utilisateur WhatsApp, il doit y avoir une conversation active entre le compte WhatsApp Business et l’utilisateur WhatsApp.
Si vous n’avez pas de conversation active, pour les besoins de ce guide de démarrage rapide, vous devez ajouter une attente entre l’envoi du modèle de message et l’envoi du SMS. Ce délai supplémentaire vous donne suffisamment de temps pour répondre à l’entreprise sur le compte WhatsApp de l’utilisateur. Pour référence, l’exemple complet fourni dans Exemple de code affiche une invite d’entrée utilisateur manuelle avant d’envoyer le message suivant.

En cas de réussite, vous recevez trois messages sur le compte WhatsApp de l’utilisateur.

dotnet build
dotnet run

dotnet build
dotnet run

Exemple de code complet

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Azure;
using Azure.Communication.Messages;

namespace AdvancedMessagingQuickstart
{
    class Program
    {
        public static async Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Send WhatsApp Messages\n");

            string connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");
            NotificationMessagesClient notificationMessagesClient = 
                new NotificationMessagesClient(connectionString);

            var channelRegistrationId = new Guid("<Your Channel ID>");
            var recipientList = new List<string> { "<Recipient's WhatsApp Phone Number>" };

            // Send sample template sample_template
            string templateName = "sample_template";
            string templateLanguage = "en_us";
            MessageTemplate sampleTemplate = new MessageTemplate(templateName, templateLanguage);
            TemplateNotificationContent templateContent = 
                new TemplateNotificationContent(channelRegistrationId, recipientList, sampleTemplate);
            Response<SendMessageResult> sendTemplateMessageResult = 
                await notificationMessagesClient.SendAsync(templateContent);

            PrintResult(sendTemplateMessageResult);
            Console.WriteLine("Template message sent.\nWait until the WhatsApp user responds " +
                "to the template message, then press any key to continue.\n");
            Console.ReadKey();

            // Send a text message
            string messageText = "Thanks for your feedback.";
            TextNotificationContent textContent =
                new TextNotificationContent(channelRegistrationId, recipientList, messageText);
            Response<SendMessageResult> sendTextMessageResult =
                await notificationMessagesClient.SendAsync(textContent);

            PrintResult(sendTextMessageResult);
            Console.WriteLine($"Text message sent to my phoneNumber.\nPress any key to continue.\n");
            Console.ReadKey();

            // Send a media message
            Uri uri = new Uri("https://aka.ms/acsicon1");
            MediaNotificationContent mediaContent =
                new MediaNotificationContent(channelRegistrationId, recipientList, uri);
            Response<SendMessageResult> sendMediaMessageResult =
                await notificationMessagesClient.SendAsync(mediaContent);

            PrintResult(sendMediaMessageResult);
            Console.WriteLine("Media message sent.\nPress any key to exit.\n");
            Console.ReadKey();
        }

        public static void PrintResult(Response<SendMessageResult> result)
        {
            Console.WriteLine($"Response: {result.GetRawResponse().Status} " +
                $"({result.GetRawResponse().ReasonPhrase})");
            Console.WriteLine($"Date: " +
                $"{result.GetRawResponse().Headers.First(header => header.Name == "Date").Value}");
            Console.WriteLine($"ClientRequestId: {result.GetRawResponse().ClientRequestId}");
            Console.WriteLine($"MS-CV: " +
                $"{result.GetRawResponse().Headers.First(header => header.Name == "MS-CV").Value}");
            foreach (var receipts in result.Value.Receipts)
            {
                Console.WriteLine($"MessageId: {receipts.MessageId}");
            }
            Console.WriteLine($"\n");
        }
    }
}

Prérequis

• Compte WhatsApp Business inscrit auprès de votre ressource Azure Communication Services

• Numéro de téléphone WhatsApp actif pour recevoir des messages

• Kit de développement Java (JDK)version 8 ou ultérieure

• Apache Maven

Configuration

Pour configurer un environnement afin d’envoyer des messages, effectuez les étapes décrites dans les sections suivantes.

Créer une application Java

Ouvrez votre terminal ou votre fenêtre Commande, puis accédez au répertoire dans lequel vous souhaitez créer votre application Java. Exécutez la commande suivante pour générer le projet Java à partir du modèle maven-archetype-quickstart.

mvn archetype:generate -DgroupId="com.communication.quickstart" -DartifactId="communication-quickstart" -DarchetypeArtifactId="maven-archetype-quickstart" -DarchetypeVersion="1.4" -DinteractiveMode="false"

L’objectif generate crée un répertoire qui porte le même nom que la valeur artifactId. Sous ce répertoire, le répertoire src/main/java contient le code source du projet, le répertoire src/test/java contient la source de test et le fichier pom.xml est le modèle objet du projet (POM, Project Object Model).

Installer le package

Ouvrez le fichier pom.xml dans votre éditeur de texte. Ajoutez l’élément dépendance suivant au groupe de dépendances.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-messages</artifactId>
    <version>1.0.0</version>
</dependency>

Configurer le framework d’application

Ouvrez /src/main/java/com/communication/quickstart/App.java dans un éditeur de texte, ajoutez des directives d’importation, puis supprimez l’instruction System.out.println("Hello world!"); :

package com.communication.quickstart;

import com.azure.communication.messages.*;
import com.azure.communication.messages.models.*;

import java.util.ArrayList;
import java.util.List;
public class App
{
    public static void main( String[] args )
    {
        // Quickstart code goes here.
    }
}

Modèle objet

Les classes et interfaces suivantes gèrent certaines des principales fonctionnalités du kit de développement logiciel (SDK) Messagerie avancée Azure Communication Services pour Java.

Exemples de code

Suivez ces étapes pour ajouter les extraits de code nécessaires à la fonction principale de votre fichier App.java.

• Authentifier le client
• Définir un ID d’inscription de canal
• Définir la liste des destinataires
• Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp
  • Envoyer un modèle de message à un utilisateur WhatsApp
  • Lancer la conversation à partir de l’utilisateur
• Envoyer un SMS à un utilisateur WhatsApp
• Envoyer un message multimédia à un utilisateur WhatsApp

Authentifier le client

Il existe différentes options disponibles pour authentifier un client de message :

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

// You can get your connection string from your resource in the Azure portal.
String connectionString = System.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING");

NotificationMessagesClient notificationClient = new NotificationMessagesClientBuilder()
    .connectionString(connectionString)
    .buildClient();

Définir un ID d’inscription de canal

Le GUID de l’ID d’inscription de canal a été créé pendant l’inscription du canal. Vous pouvez le rechercher dans le portail sous l’onglet Canaux de votre ressource Azure Communication Services.

Attribuez-le à une variable appelée channelRegistrationId.

String channelRegistrationId = "<your channel registration id GUID>";

Définir la liste des destinataires

Vous devez fournir un numéro de téléphone réel associé à un compte WhatsApp. Ce compte WhatsApp reçoit les messages textuels et multimédias envoyés dans ce guide de démarrage rapide. Pour ce guide de démarrage rapide, ce numéro de téléphone peut être votre numéro de téléphone personnel.

Le numéro de téléphone du destinataire ne peut pas être le numéro de téléphone professionnel (ID d’expéditeur) associé à l’inscription du canal WhatsApp. L’ID d’expéditeur s’affiche comme étant l’expéditeur des messages textuels et multimédias envoyés au destinataire.

Le numéro de téléphone doit inclure le code du pays. Pour plus d’informations sur la mise en forme des numéros de téléphone, consultez la documentation WhatsApp sur les Formats des numéros de téléphone.

Créez la liste des destinataires de la façon suivante :

List<String> recipientList = new ArrayList<>();
recipientList.add("<to WhatsApp phone number>");

Exemple :

// Example only
List<String> recipientList = new ArrayList<>();
recipientList.add("+14255550199");

Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp

Les conversations entre un compte WhatsApp Business et un utilisateur WhatsApp peuvent être lancées de deux manières :

• L’entreprise envoie un message modèle à l’utilisateur WhatsApp.
• L’utilisateur WhatsApp envoie n’importe quel message au numéro professionnel.

Quelle que soit la façon dont la conversation a été démarrée, une entreprise ne peut envoyer des modèles de messages qu’une fois que l’utilisateur a envoyé un message à l’entreprise. Ce n’est qu’une fois que l’utilisateur a envoyé un message à l’entreprise que celle-ci est autorisée à lui envoyer des messages multimédias ou des SMS pendant la conversation active. Une fois la fenêtre de conversation de 24 heures expirée, la conversation doit être relancée. Pour en savoir plus sur les conversations, consultez la définition sur le site Plateforme WhatsApp Business.

(Option 1) Lancer une conversation à partir de l’entreprise : Envoyer un modèle de message

Lancez une conversation en envoyant un message modèle.

Commencez par créer un MessageTemplate en utilisant les valeurs d’un modèle.

Voici la création de MessageTemplate à partir d’un modèle par défaut, sample_template.
Si vous n’avez pas accès à sample_template, passez à l’Option 2. Les utilisateurs avancés peuvent consulter la page Modèles pour découvrir comment envoyer un autre modèle avec l’option 1.

Le Kit de développement logiciel (SDK) Messages permet à Contoso d’envoyer des modèles de messages Whatsapp aux utilisateurs de WhatsApp. Pour envoyer des modèles de messages, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Détails du modèle
  • Un nom comme « exemple de modèle »
  • Une langue comme « en_us »
  • Paramètres le cas échéant

// Assemble the template content
String templateName = "sample_template";
String templateLanguage = "en_us";
MessageTemplate messageTemplate = new MessageTemplate(templateName, templateLanguage);

// Assemble template message
TemplateNotificationContent templateContent = new TemplateNotificationContent(channelRegistrationId, recipientList, messageTemplate);

// Send template message
SendMessageResult templateMessageResult = notificationClient.send(templateContent);

// Process result
for (MessageReceipt messageReceipt : templateMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

À présent, l’utilisateur doit répondre au modèle de message. À partir du compte d’utilisateur WhatsApp, répondez au message modèle reçu du compte WhatsApp Business. Le contenu du message n’a pas d’importance pour ce scénario.

(Option 2) Lancer la conversation à partir de l’utilisateur

L’autre option pour lancer une conversation entre un compte WhatsApp Business et un utilisateur WhatsApp est de laisser l’utilisateur lancer la conversation. Pour ce faire, à partir de votre compte WhatsApp personnel, envoyez un message à votre numéro professionnel (ID d’expéditeur).

Envoyer un SMS à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des messages textuels Whatsapp, lancés par des utilisateurs Whatsapp. Pour envoyer des messages textuels, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Corps/texte du message à envoyer

Dans cet exemple, nous répondons à l’utilisateur WhatsApp avec le texte « Merci pour vos commentaires.\n Du SDK de Messagerie de Notification ».

Assemblez puis envoyez le SMS :

// Assemble text message
TextNotificationContent textContent = new TextNotificationContent(channelRegistrationId, recipientList, "“Thanks for your feedback.\n From Notification Messaging SDK");

// Send text message
SendMessageResult textMessageResult = notificationClient.send(textContent);

// Process result
for (MessageReceipt messageReceipt : textMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

Envoyer un message multimédia à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des images par message Whatsapp aux utilisateurs de WhatsApp. Pour envoyer des images par message, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• MediaUri de l’image

Par exemple, créez un URI :

String mediaUrl = "https://aka.ms/acsicon1";

Assemblez puis envoyez le message multimédia :

// Assemble media message
MediaNotificationContent mediaContent = new MediaNotificationContent(channelRegistrationId, recipientList, mediaUrl);

// Send media message
SendMessageResult mediaMessageResult = notificationClient.send(mediaContent);

// Process result
for (MessageReceipt messageReceipt : mediaMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

Exécuter le code

1. Accédez au répertoire contenant le fichier pom.xml, puis compilez le projet à l’aide de la commande mvn.

   mvn compile
   

2. Exécutez l’application en exécutant la commande mvn suivante.

   mvn exec:java -D"exec.mainClass"="com.communication.quickstart.App" -D"exec.cleanupDaemonThreads"="false"
   

Exemple de code complet

Vous trouverez le code finalisé pour ce guide de démarrage rapide sur GitHub.

Prérequis

• Compte WhatsApp Business inscrit auprès de votre ressource Azure Communication Services

• Numéro de téléphone WhatsApp actif pour recevoir des messages

• Node.js versions Active LTS et Maintenance LTS (8.11.1 et 10.14.1 recommandées).

  • Dans une fenêtre de terminal ou de commande, exécutez node --version pour vérifier que Node.js est installé.

Configuration

Pour configurer un environnement afin d’envoyer des messages, effectuez les étapes décrites dans les sections suivantes.

Création d’une application Node.js

1. Créez un répertoire pour votre application et accédez-y en ouvrant votre fenêtre de terminal ou de commande, puis exécutez la commande suivante.

   mkdir advance-messages-quickstart && cd advance-messages-quickstart
   

2. Exécutez la commande suivante pour créer un fichier package.json avec des paramètres par défaut.

   npm init -y
   

3. Utilisez un éditeur de texte pour créer un fichier nommé send-messages.js dans le répertoire racine du projet.

4. Ajoutez l’extrait de code suivant au fichier send-messages.js.

   async function main() {
       // Quickstart code goes here.
   }
   
   main().catch((error) => {
       console.error("Encountered an error while sending message: ", error);
       process.exit(1);
   });
   

Dans les sections suivantes, vous ajoutez tout le code source pour ce guide de démarrage rapide au fichier send-messages.js que vous avez créé.

Installer le package

Utilisez la commande npm install pour installer le kit SDK Messagerie avancée Azure Communication Services pour JavaScript.

npm install @azure-rest/communication-messages --save

L’option --save liste la bibliothèque comme dépendance dans votre fichier package.json.

Modèle objet

Les classes et interfaces suivantes gèrent certaines des principales fonctionnalités du kit de développement logiciel (SDK) Messagerie avancée Azure Communication Services pour JavaScript.

Exemples de code

Suivez ces étapes pour ajouter les extraits de code nécessaires à la fonction principale de votre fichier send-messages.js.

• Authentifier le client
• Définir un ID d’inscription de canal
• Définir la liste des destinataires
• Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp
  • Envoyer un modèle de message à un utilisateur WhatsApp
  • Lancer la conversation à partir de l’utilisateur
• Envoyer un SMS à un utilisateur WhatsApp
• Envoyer un message multimédia à un utilisateur WhatsApp

Authentifier le client

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

const MessageClient = require("@azure-rest/communication-messages").default;

// Set Connection string
const connectionString = process.env["COMMUNICATION_SERVICES_CONNECTION_STRING"];

// Instantiate the client
const client = MessageClient(connectionString);

setx COMMUNICATION_SERVICES_KEY "<your key>"

const AzureKeyCredential = require("@azure/core-auth").AzureKeyCredential;
const MessageClient = require("@azure-rest/communication-messages").default;

// Configure authentication
const endpoint = "https://<resource name>.communication.azure.com";
const credential = new AzureKeyCredential("<your key credential>");

// Instantiate the client
const client = MessageClient(endpoint, credential);

Définir un ID d’inscription de canal

Le GUID de l’ID d’inscription de canal a été créé pendant l’inscription du canal. Vous pouvez le rechercher dans le portail sous l’onglet Canaux de votre ressource Azure Communication Services.

Attribuez-le à une variable appelée channelRegistrationId.

const channelRegistrationId = "<your channel registration id GUID>";

Définir la liste des destinataires

Vous devez fournir un numéro de téléphone réel associé à un compte WhatsApp. Ce compte WhatsApp reçoit les modèles de messages, les messages multimédias et les SMS envoyés dans ce guide de démarrage rapide. Pour ce guide de démarrage rapide, ce numéro de téléphone peut être votre numéro de téléphone personnel.

Le numéro de téléphone du destinataire ne peut pas être le numéro de téléphone professionnel (ID d’expéditeur) associé à l’inscription du canal WhatsApp. L’ID d’expéditeur s’affiche comme étant l’expéditeur des messages textuels et multimédias envoyés au destinataire.

Le numéro de téléphone doit inclure le code du pays. Pour plus d’informations sur la mise en forme des numéros de téléphone, consultez la documentation WhatsApp sur les Formats des numéros de téléphone.

Créez la liste des destinataires de la façon suivante :

const recipientList = ["<to WhatsApp phone number>"];

Exemple :

// Example only
const recipientList = ["+14255550199"];

Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp

Les conversations entre un compte WhatsApp Business et un utilisateur WhatsApp peuvent être lancées de deux manières :

• L’entreprise envoie un message modèle à l’utilisateur WhatsApp.
• L’utilisateur WhatsApp envoie n’importe quel message au numéro professionnel.

Quelle que soit la façon dont la conversation a été démarrée, une entreprise ne peut envoyer des modèles de messages qu’une fois que l’utilisateur a envoyé un message à l’entreprise. Ce n’est qu’une fois que l’utilisateur a envoyé un message à l’entreprise que celle-ci est autorisée à lui envoyer des messages multimédias ou des SMS pendant la conversation active. Une fois la fenêtre de conversation de 24 heures expirée, la conversation doit être relancée. Pour en savoir plus sur les conversations, consultez la définition sur le site Plateforme WhatsApp Business.

(Option 1) Lancer une conversation à partir de l’entreprise : Envoyer un modèle de message

Lancez une conversation en envoyant un message modèle.

Commencez par créer un MessageTemplate en utilisant les valeurs d’un modèle.

Voici la création de MessageTemplate à partir d’un modèle par défaut, sample_template.
Si vous n’avez pas accès à sample_template, passez à l’Option 2. Les utilisateurs avancés peuvent consulter la page Modèles pour découvrir comment envoyer un autre modèle avec l’option 1.

Le Kit de développement logiciel (SDK) Messages permet à Contoso d’envoyer des modèles de messages Whatsapp aux utilisateurs de WhatsApp. Pour envoyer des modèles de messages, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Détails du modèle
  • Un nom comme « exemple de modèle »
  • Une langue comme « en_us »
  • Paramètres le cas échéant

// Assemble the template content
const template = {
    name: "sample_template",
    language: "en_US"
};

Pour obtenir plus d’exemples sur l’assemblage de votre MessageTemplate et la création de votre propre modèle, consultez la ressource suivante :

• Envoyer des messages modèles WhatsApp

Pour plus d’informations sur les exigences WhatsApp relatives aux modèles, consultez les informations de référence de l’API WhatsApp Business Platform :

• Créer et gérer des modèles
• Composants du modèle
• Envoi de modèles de message

// Send template message
const templateMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "template",
        template: template
    }
});

// Process result
if (templateMessageResult.status === "202") {
    templateMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

À présent, l’utilisateur doit répondre au modèle de message. À partir du compte d’utilisateur WhatsApp, répondez au message modèle reçu du compte WhatsApp Business. Le contenu du message n’a pas d’importance pour ce scénario.

(Option 2) Lancer la conversation à partir de l’utilisateur

L’autre option pour lancer une conversation entre un compte WhatsApp Business et un utilisateur WhatsApp est de laisser l’utilisateur lancer la conversation. Pour ce faire, à partir de votre compte WhatsApp personnel, envoyez un message à votre numéro professionnel (ID d’expéditeur).

Envoyer un SMS à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des messages textuels Whatsapp, lancés par des utilisateurs Whatsapp. Pour envoyer des messages textuels, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Corps/texte du message à envoyer

Dans cet exemple, nous répondons à l’utilisateur WhatsApp avec le texte « Merci pour vos commentaires.\n Du SDK de Messagerie de Notification ».

Assemblez et envoyez le message multimédia :

// Send text message
const textMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "text",
        content: "Thanks for your feedback.\n From Notification Messaging SDK"
    }
});

// Process result
if (textMessageResult.status === "202") {
    textMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

Envoyer un message multimédia à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des images par message Whatsapp aux utilisateurs de WhatsApp. Pour envoyer des images par message, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• MediaUri de l’image

Pour envoyer un message multimédia, fournissez une URL à une image. Par exemple,

const url = "https://aka.ms/acsicon1";

Assemblez et envoyez le message multimédia :

// Send media message
const mediaMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "image",
        mediaUri: url
    }
});

// Process result
if (mediaMessageResult.status === "202") {
    mediaMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

Exécuter le code

Utilisez la commande node pour exécuter le code que vous avez ajouté au fichier send-messages.js.

node ./send-messages.js

Exemple de code complet

Vous pouvez télécharger l’exemple d’application sur GitHub.

Prérequis

• Compte WhatsApp Business inscrit auprès de votre ressource Azure Communication Services.

• Numéro de téléphone WhatsApp actif devant recevoir des messages.

• Python 3.7+ pour votre système d’exploitation.

Configuration

Créer une application Python

Dans une fenêtre de terminal ou de console, créez un dossier pour votre application et accédez-y.

mkdir messages-quickstart && cd messages-quickstart

Installer le package

Vous devez utiliser la bibliothèque de client Azure Communication Messages pour Python version 1.0.0 ou ultérieure.

À partir de l'invite de commandes, exécutez la commande suivante :

pip install azure-communication-messages

Configurer le framework d’application

Créez un nouveau fichier appelé messages-quickstart.py et ajoutez la structure de programme de base.

type nul > messages-quickstart.py   

Structure de programme basique

import os

class MessagesQuickstart(object):
    print("Azure Communication Services - Advanced Messages SDK Quickstart")

if __name__ == '__main__':
    messages = MessagesQuickstart()

Modèle objet

Les classes et les interfaces suivantes gèrent certaines des principales fonctionnalités du SDK Azure Communication Services Messages pour Python.

Exemples de code

Suivez ces étapes pour ajouter les extraits de code nécessaires au programme python messages-quickstart.py.

• Authentifier le client
• Définir un ID d’inscription de canal
• Définir la liste des destinataires
• Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp
  • Envoyer un modèle de message à un utilisateur WhatsApp
  • Lancer la conversation à partir de l’utilisateur
• Envoyer un SMS à un utilisateur WhatsApp
• Envoyer un message multimédia à un utilisateur WhatsApp

Authentifier le client

L’envoi de messages est effectué à l’aide de NotificationMessagesClient. NotificationMessagesClient est authentifié à l’aide de la chaîne de connexion acquise à partir d’une ressource Azure Communication Services dans le portail Azure. Pour plus d’informations sur les chaînes de connexion, consultez Accéder à vos chaînes de connexion et points de terminaison de service à l’aide d’Azure CLI.

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

    # Get a connection string to our Azure Communication Services resource.
    connection_string = os.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING")
    
    def send_template_message(self):
        from azure.communication.messages import NotificationMessagesClient

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)

    # Get a connection string to our Azure Communication Services resource.
    endpoint_string = os.getenv("COMMUNICATION_SERVICES_ENDPOINT_STRING")
    
    def send_template_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.identity import DefaultAzureCredential

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient(endpoint=self.endpoint_string,
                                                    credential=DefaultAzureCredential())

setx COMMUNICATION_SERVICES_ENDPOINT_STRING "<https://<resource name>.communication.azure.com>"
setx COMMUNICATION_SERVICES_KEY "<your key>"

    # Get a connection string to our Azure Communication Services resource.
    endpoint_string = os.getenv("COMMUNICATION_SERVICES_ENDPOINT_STRING")
    key = os.getenv("COMMUNICATION_SERVICES_KEY")

    def send_template_message(self):
        from azure.core.credentials import AzureKeyCredential
        from azure.communication.messages import NotificationMessagesClient

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient(endpoint=self.endpoint_string,
                                                    credential=AzureKeyCredential(self.key))

Définir un ID d’inscription de canal

Le GUID de l’ID d’inscription de canal a été créé pendant l’inscription du canal. Vous pouvez le rechercher dans le portail sous l’onglet Canaux de votre ressource Azure Communication Services.

Attribuez-le à une variable appelée channelRegistrationId.

    channelRegistrationId = os.getenv("WHATSAPP_CHANNEL_ID_GUID")

Définir la liste des destinataires

Vous devez fournir un numéro de téléphone réel associé à un compte WhatsApp. Ce compte WhatsApp reçoit les modèles de messages, les messages multimédias et les SMS envoyés dans ce guide de démarrage rapide. Pour ce guide de démarrage rapide, ce numéro de téléphone peut être votre numéro de téléphone personnel.

Le numéro de téléphone du destinataire ne peut pas être le numéro de téléphone professionnel (ID d’expéditeur) associé à l’inscription du canal WhatsApp. L’ID d’expéditeur s’affiche comme étant l’expéditeur des messages textuels et multimédias envoyés au destinataire.

Le numéro de téléphone doit inclure le code du pays. Pour plus d’informations sur la mise en forme des numéros de téléphone, consultez la documentation WhatsApp sur les Formats des numéros de téléphone.

Définissez la liste des destinataires de la façon suivante :

    phone_number = os.getenv("RECIPIENT_WHATSAPP_PHONE_NUMBER")

Exemple d’utilisation :

    # Example only
    to=[self.phone_number],

Commencer à envoyer des messages entre une entreprise et un utilisateur WhatsApp

Les conversations entre un compte WhatsApp Business et un utilisateur WhatsApp peuvent être lancées de deux manières :

• L’entreprise envoie un message modèle à l’utilisateur WhatsApp.
• L’utilisateur WhatsApp envoie n’importe quel message au numéro professionnel.

Quelle que soit la façon dont la conversation a été démarrée, une entreprise ne peut envoyer des modèles de messages qu’une fois que l’utilisateur a envoyé un message à l’entreprise. Ce n’est qu’une fois que l’utilisateur a envoyé un message à l’entreprise que celle-ci est autorisée à lui envoyer des messages multimédias ou des SMS pendant la conversation active. Une fois la fenêtre de conversation de 24 heures expirée, la conversation doit être relancée. Pour en savoir plus sur les conversations, consultez la définition sur le site Plateforme WhatsApp Business.

(Option 1) Lancer une conversation à partir de l’entreprise : Envoyer un modèle de message

Lancez une conversation en envoyant un message modèle.

Commencez par créer un MessageTemplate en utilisant les valeurs d’un modèle.

Voici la création de MessageTemplate à partir d’un modèle par défaut, sample_template.
Si vous n’avez pas accès à sample_template, passez à l’Option 2. Les utilisateurs avancés peuvent consulter la page Modèles pour découvrir comment envoyer un autre modèle avec l’option 1.

Le Kit de développement logiciel (SDK) Messages permet à Contoso d’envoyer des modèles de messages Whatsapp aux utilisateurs de WhatsApp. Pour envoyer des modèles de messages, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Détails du modèle
  • Un nom comme « exemple de modèle »
  • Une langue comme « en_us »
  • Paramètres le cas échéant

Pour obtenir plus d’exemples sur l’assemblage de votre MessageTemplate et la création de votre propre modèle, consultez la ressource suivante :

• Envoyer des messages modèles WhatsApp

Pour plus d’informations sur les exigences WhatsApp relatives aux modèles, consultez les informations de référence de l’API WhatsApp Business Platform :

• Créer et gérer des modèles
• Composants du modèle
• Envoi de modèles de message

Pour envoyer un modèle de message WhatsApp, ajoutez le code ci-dessous dans la fonction send_template_message(self).

        input_template: MessageTemplate = MessageTemplate(
            name="<<template_name>>",
            language="<<template_language>>")
        template_options = TemplateNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            template=input_template
        )

        # calling send() with whatsapp template details
        message_responses = messaging_client.send(template_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Templated Message with message id {} was successfully sent to {}."
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

Ajoutez send_template_message() appel à la méthode principale.

    # Calling send_template_message()
    messages.send_template_message()

À présent, l’utilisateur doit répondre au modèle de message. À partir du compte d’utilisateur WhatsApp, répondez au message modèle reçu du compte WhatsApp Business. Le contenu du message n’a pas d’importance pour ce scénario.

(Option 2) Lancer la conversation à partir de l’utilisateur

L’autre option pour lancer une conversation entre un compte WhatsApp Business et un utilisateur WhatsApp est de laisser l’utilisateur lancer la conversation. Pour ce faire, à partir de votre compte WhatsApp personnel, envoyez un message à votre numéro professionnel (ID d’expéditeur).

Envoyer un SMS à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des messages textuels Whatsapp, lancés par des utilisateurs Whatsapp. Pour envoyer des messages textuels, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• Corps/texte du message à envoyer

Dans cet exemple, nous répondons à l’utilisateur WhatsApp avec le texte « Merci pour vos commentaires.\n Du SDK de Messagerie de Notification ».

    def send_text_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( TextNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        text_options = TextNotificationContent (
            channel_registration_id=self.channelRegistrationId,
            to= [self.phone_number],
            content="Thanks for your feedback.\n From Notification Messaging SDK",
        )
        
        # calling send() with whatsapp message details
        message_responses = messaging_client.send(text_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Text Message with message id {} was successfully sent to {}."
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

Mettez à jour la méthode Main pour qu’elle exécute send_text_message()

    #Calling send_text_message()
    messages.send_text_message()

Envoyer un message multimédia à un utilisateur WhatsApp

Le SDK Messages permet à Contoso d’envoyer des images par message Whatsapp aux utilisateurs de WhatsApp. Pour envoyer des images par message, les informations ci-dessous sont requises :

• ID de canal WhatsApp
• Numéro de téléphone du destinataire en format E16
• MediaUri de l’image

Exemple de media_uri utilisé pour envoyer un message WhatsApp multimédia.

input_media_uri : str = "https://aka.ms/acsicon1"

    def send_image_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( ImageNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "https://aka.ms/acsicon1"
        image_message_options = ImageNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(image_message_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Image containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

Mettez à jour la méthode Main pour qu’elle exécute send_image_message()

    # Calling send_image_message()
    messages.send_image_message()

Exécuter le code

Pour exécuter le code, vérifiez que vous êtes dans le répertoire où se trouve votre fichier messages-quickstart.py.

python messages-quickstart.py

Azure Communication Services - Advanced Messages Quickstart
WhatsApp Templated Message with message id <<GUID>> was successfully sent to <<ToRecipient>>
WhatsApp Text Message with message id <<GUID>> was successfully sent to <<ToRecipient>>
WhatsApp Image containing Message with message id <<GUID>> was successfully sent to <<ToRecipient>>

Exemple de code complet

import os

class MessagesQuickstart(object):
    print("Azure Communication Services - Advanced Messages SDK Quickstart using connection string.")
    # Advanced Messages SDK implementations goes in this section.
   
    connection_string = os.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING")
    phone_number = os.getenv("RECIPIENT_PHONE_NUMBER")
    channelRegistrationId = os.getenv("WHATSAPP_CHANNEL_ID")

    def send_template_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( TemplateNotificationContent , MessageTemplate )

        # client creation
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_template: MessageTemplate = MessageTemplate(
            name="<<TEMPLATE_NAME>>",
            language="<<LANGUAGE>>")
        template_options = TemplateNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            template=input_template
        )

        # calling send() with WhatsApp template details.
        message_responses = messaging_client.send(template_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Templated Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

    def send_text_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( TextNotificationContent )

        # client creation
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)

        text_options = TextNotificationContent (
            channel_registration_id=self.channelRegistrationId,
            to= [self.phone_number],
            content="Hello World via ACS Advanced Messaging SDK.",
        )
        
        # calling send() with WhatsApp message details
        message_responses = messaging_client.send(text_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Text Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

    def send_image_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( ImageNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "https://aka.ms/acsicon1"
        image_message_options = ImageNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(image_message_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Image containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

if __name__ == '__main__':
    messages = MessagesQuickstart()
    messages.send_template_message()
    messages.send_text_message()
    messages.send_image_message()

Autres exemples

Vous pouvez consulter et télécharger d’autres exemples de codes pour le SDK Python Messages sur GitHub.