L'API Reach Messaging - Prise en Main - C#
L'envoi de SMS avec l'API Reach Messaging de TalkyLabs est possible avec seulement quelques lignes de code C#.
Dans ce qui suit, nous fournissons un guide étape par étape pour faciliter vos débuts. Dans ce guide, vous apprendrez comment :
S'inscrire à la plateforme Reach
Créer une applet
Récupérer vos identifiants API
Vérifier votre numéro de téléphone
Envoyer un SMS
S'inscrire / S'identifier
Vous pouvez sauter cette section si vous avez déjà un compte sur la plateforme Reach.
Vous pouvez ouvrir un compte sur la plateforme Reach ici. Il vous sera demandé de vérifier votre adresse e-mail pour activer votre compte.
Créer une applet
Vous pouvez sauter cette section si vous avez déjà une applet et que vous voulez l'utiliser ici.
Une applet peut être considérée comme un sous-compte ou un environnement de développement au sein de la plateforme Reach. Il vous permet de regrouper vos opérations dans la plateforme Reach en fonction de vos segments de clientèle, par exemple par pays. Vous pouvez avoir plus d'une applet associée à votre compte.
Pour créer une applet, il suffit de cliquer sur le bouton correspondant dans la console et de spécifier le nom de l'applet ainsi que le pays d'opération, c'est-à-dire le pays où résident la plupart des clients ciblés par les opérations qui seront effectuées dans le cadre de cette applet.
Récupérer vos identifiants API
Après avoir accédé à votre applet, vous pouvez récupérer vos identifiants API en visitant Paramètres -> API dans le menu de gauche.
Comme vous le remarquerez, vous aurez accès à votre Utilisateur API
ainsi qu'à vos Clés API
Test et Live. Rappelez-vous que la clé API Test est pour le mode sandbox où vous pouvez émuler l'envoi des messages tandis que la clé API Live est pour envoyer des messages pour de vrai.
Enfin, notez qu'il est possible de re-générer vos clés API selon vos besoins.
Vérifier votre numéro de téléphone
Vous pouvez sauter cette section si vous avez déjà un numéro vérifié.
Avec une applet, vous pouvez émuler l'envoi de messages dans le mode sandbox en utilisant n'importe quel numéro de téléphone valide. Cependant, pour l'envoi de messages réels, vous ne pouvez utiliser que des numéros de téléphone qui vous appartiennent.
Pour démontrer la propriété d'un numéro de téléphone, vous devez le vérifier. Dans une applet, visitez la section Numéros de téléphone -> Numéros vérifiés dans le menu de gauche pour ajouter votre numéro et lancer une procédure de vérification.
Une fois que le numéro est vérifié, il est valable pendant un certain temps. Pour l'instant, cette période est de trois mois, mais elle peut être modifiée sans préavis. Vous devrez revérifier le numéro pour continuer à l'utiliser après cette période.
Installer la bibliothèque cliente
Si vous avez déjà installé la bibliothèque cliente C#, vous pouvez sauter cette étape et envoyer directement votre premier message.
Si vous développez avec .NET Framework, vous devez vous assurer que Visual Studio est installé.
En revanche, si vous développez avec .NET core, vous devez vous assurer que .NET Core est installé sur votre ordinateur. Vous pouvez le vérifier en exécutant la commande suivante :
dotnet --version
Si .NET Core est installé, vous verrez quelque chose comme :
7.0.400
Dans les deux cas, vous devez créer un projet et utiliser le gestionnaire de paquets NuGet pour installer la bibliothèque cliente C#.
Avec l'IDE Visual Studio (.NET Framework)
Depuis Visual Studio, vous pouvez utiliser l'interface graphique NuGet pour rechercher et installer le paquet NuGet Reach-TalkyLabs. Ou, en guise de raccourci, tapez simplement la commande suivante dans la console du gestionnaire de paquets:
Install-Package Reach-TalkyLabs
Avec les outils de ligne de commande .NET Core
Si vous developpez avec les outils de ligne de commande .NET Core, vous pouvez exécuter la commande suivante depuis le répertoire de votre projet :
dotnet add package Reach-TalkyLabs
Envoyer un message
Maintenant que la bibliothèque cliente C# est installée, vous pouvez envoyer un SMS en utilisant un numéro vérifié valide enregistré dans l'applet. Créez un fichier nommé SendMessage.cs
et collez-y l'exemple de code ci-dessous.
using System;
using Reach;
using Reach.Rest.Api.Messaging;
class SendMessage
{
static void Main(string[] args)
{
string apiUser = Environment.GetEnvironmentVariable("REACH_TALKYLABS_API_USER");
string apiKey = Environment.GetEnvironmentVariable("REACH_TALKYLABS_API_KEY");
ReachClient.Init(apiUser, apiKey);
var message = MessagingItemResource.Send(
dest: "+237671234567",
src: "+237691234567",
body: "Hello World! This is a sms message."
);
Console.WriteLine(message.MessageId);
}
}
Remplacez le numéro de téléphone src
par votre numéro vérifié et le numéro de téléphone dest
par le numéro auquel vous voulez envoyer le message. Les numéros de téléphone doivent être au format E.164.
De même, utilisez vos identifiants API et remplacer les valeurs des variables apiUser
et apiKey
. Rappeler vous d'utiliser votre clé API Live.
Pour cet exercice, vous pouvez coder en dur vos informations d'identification dans le fichier. Cependant, il est fortement recommandé d'utiliser des variables d'environnement pour stocker des données sensibles.
Sauvegardez le fichier et exécutez votre projet dans Visual Studio (.NET Framework), ou lancez la commande suivante dans votre terminal (.NET Core):
dotnet run
Et voilà ! Dans quelques instants, votre message sera envoyé au numéro de téléphone de destination.