Skip to content

L'API Reach Messaging - Prise en Main - Java

L'envoi de SMS avec l'API Reach Messaging de TalkyLabs est possible avec seulement quelques lignes de code Java.

Dans ce qui suit, nous fournissons un guide étape par étape pour faciliter vos débuts. Dans ce guide, vous apprendrez comment :

Information Circle

  • 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

Information Circle

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

Information Circle

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

Information Circle

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.

Warning

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

Information Circle

Si vous avez déjà installé la bibliothèque cliente Java, vous pouvez sauter cette étape et envoyer directement votre premier message.

Vous devez vous assurer que le kit de développement Java (JDK) est installé sur votre ordinateur. Vous pouvez le vérifier en exécutant la commande suivante:

javac -version

S'il est installé, vous verrez quelque chose comme:

javac 11.0.20.1

Notre bibliothèque cliente Java est compatible avec le JDK 8+. Pour installer manuellement la bibliothèque, téléchargez le code source, décompressez-le, naviguer dans le dossier reach-java et exécutez

mvn install

Cette commande va générer dans le dossier target un jar plat dont le nom ressemble à reach-1.0.0-jar-with-dependencies.jar. Ce jar sera utilisé ci-dessous.

Si vous préférez, vous pouvez utiliser des outils tels que Maven ou Gradle. Reportez-vous au code source de la bibliothèque client pour plus de détails.

Envoyer un message

Maintenant que la bibliothèque cliente Java 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.java et collez-y l'exemple de code ci-dessous.

import com.talkylabs.reach.Reach;
import com.talkylabs.reach.base.ResourceSet;
import com.talkylabs.reach.rest.api.messaging.MessagingItem;

public class SendMessage {

  public static final String API_USER = System.getenv("REACH_TALKYLABS_API_USER");
  public static final String API_KEY = System.getenv("REACH_TALKYLABS_API_KEY");

  public static void main(String[] args) {

    Reach.init(API_USER, API_KEY);

    MessagingItem message = MessagingItem
        .sender(
          "+237671234567", // dest
          "+237691234567", // src 
          "Hello World! This is a sms message."
        )
        .send();

    System.out.println(message.getMessageId());
  }
}

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.

Warning

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 compilez-le avec la commande suivante dans votre terminal (remplacez 1.0.0 par le numéro de version approprié):

javac -cp reach-1.0.0-jar-with-dependencies.jar SendMessage.java

Une fois la compilation terminée, exécutez la classe résultante en utilisant la commande ci-dessous:

java -cp .:reach-1.0.0-jar-with-dependencies.jar SendMessage

Si vous êtes sous Windows, utilisez plutôt cette commande:

java -cp ".;reach-1.0.0-jar-with-dependencies.jar" SendMessage

Et voilà ! Dans quelques instants, votre message sera envoyé au numéro de téléphone de destination.