Messages API Sandbox

Le bac à sable de l'API Messages est un moyen rapide d'essayer l'envoi de messages via certains canaux de messagerie à l'aide de l'API Messages de Vonage. Il ne nécessite pas la mise en place de comptes externes auprès des fournisseurs (tels que WhatsApp Business Account). Cela signifie que vous pouvez essayer ces canaux de l'API Messages tout de suite en utilisant votre compte Vonage.

• WhatsApp
• Viber
• Facebook Messenger
• Instagram

Pour utiliser le bac à sable afin d'essayer d'envoyer des messages pour un canal particulier, votre numéro ou votre identifiant associé à ce canal doit d'abord être ajouté à la liste des numéros/identifiants autorisés pour le canal. Vous devrez envoyer un message au bac à sable en suivant les instructions de la page d'accueil du site web de la Commission européenne. Tableau de bord afin que votre numéro ou votre identifiant puisse être mis sur liste d'attente.

Veuillez noter que :

• Les numéros et ID inscrits sur la liste d'autorisation sont associés à des clés API Vonage spécifiques. Si vous autorisez le même numéro/ID avec une clé API Vonage différente (par exemple, via un compte Vonage Dashboard séparé), ce numéro/ID sera supprimé de la liste d'autorisation de l'Environnement de test pour la clé API pour laquelle il a été ajouté précédemment.
• L'Environnement de test utilise un point de terminaison API différent de l'API Messages de production. Assurez-vous d'utiliser le point de terminaison de l'Environnement de test lorsque vous essayez l'API Messages via l'Environnement de test.
• Le bac à sable est destiné à à l'essai l'API Messages, par exemple lors d'une première exploration de l'API. Il n'est pas destiné à être utilisé dans le cadre d'un environnement d'assurance qualité ou d'un environnement de mise à l'essai pour tester votre intégration avant de la mettre en service. Si vous avez déjà décidé d'intégrer l'API Messages dans votre application, nous vous recommandons de créer votre propre Account en suivant les instructions du tableau de bord pour le canal concerné.

Messages API Sandbox Pricing

L'utilisation de l'Environnement de test de l'API Messages est gratuite. Une limite mensuelle d'utilisation équitable de 100 messages/mois s'applique. Si cette limite est dépassée, vos demandes de messages renverront un message de type 429 Erreur HTTP.

Limite du taux

L'environnement de test de l'API Messages est limité à un message par seconde.

Créez votre bac à sable

Suivez les étapes ci-dessous pour configurer un canal dans l'Environnement de test (notez que chaque canal doit être configuré séparément).

1. Aller à la page Messages API Sandbox sur le tableau de bord.
2. Si vous disposez de plusieurs clés API dans la base de données Clé API sélectionnez la clé API à associer au bac à sable que vous êtes en train de configurer.
3. Cliquez sur le bouton Ajouter au bac à sable associé au canal que vous souhaitez configurer et suivez les instructions du tableau de bord de ce canal.

Configurer les webhooks

1. Saisissez l'adresse de votre application Inbound URL du webhook. Le webhook entrant est l'URL vers laquelle les messages entrants sont transférés.
2. Saisissez l'adresse de votre application Statut URL du webhook. Le webhook d'état est l'URL à laquelle vous recevrez les mises à jour de l'état des messages.
3. Cliquez sur le bouton Sauvegarder les webhooks bouton.

Tentatives de relance du webhook

Les webhooks entrants et d'état sont réessayés sur la base d'une notification dans l'environnement Sandbox de l'API Messages. Toute réponse non-200 à un webhook incitera Vonage à réessayer périodiquement à des intervalles de plus en plus longs : 5, 10, 20, 40, 80, 160, 320, 640, puis toutes les 900 secondes pendant 24 heures.

Envoyer un message test via l'API Sandbox de Messages

Une fois que votre numéro ou votre ID de destinataire est autorisé, vous devez utiliser le point de terminaison Messages API Sandbox pour envoyer vos messages de test. Le point de terminaison from dans la demande doit être l'ID ou le numéro associé au compte externe spécifique de Vonage Sandbox. Pour vos tests, la valeur de la demande from est déjà renseigné dans les extraits de code fournis dans le document Tableau de bord. Il est important de noter que vous devrez remplacer la valeur de la to avec votre numéro ou l'ID du destinataire qui est autorisé sur le compte externe spécifique de Vonage Sandbox.

L'exemple ci-dessous montre comment utiliser l'Environnement de test pour envoyer un message texte WhatsApp, mais la même approche générale peut être utilisée pour d'autres canaux. Notez l'utilisation du point de terminaison Sandbox plutôt que le point de terminaison standard Messages (si vous utilisez l'un des SDK de serveur, vous devez remplacer le point de terminaison par défaut).

Vous trouverez ci-dessous la description de toutes les variables utilisées dans chaque extrait de code :

curl -X POST $MESSAGES_SANDBOX_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."
  }'

npm install @vonage/server-sdk @vonage/messages

const vonage = new Vonage(
  {
    applicationId: VONAGE_APPLICATION_ID,
    privateKey: VONAGE_PRIVATE_KEY,
  },
  {
    apiHost: MESSAGES_SANDBOX_URL,
  },
);

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));

System.out.println(VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build()
		.getMessagesClient()
		.useSandboxEndpoint()
		.sendMessage(WhatsappTextRequest.builder()
			.from(MESSAGES_SANDBOX_WHATSAPP_NUMBER)
			.to(MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER)
			.text("Hello from Vonage, "+System.getenv("NAME"))
			.build()
		).getMessageUuid()
);

Install-Package Vonage

composer require vonage/client

pip install vonage python-dotenv

gem install vonage

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

Essayez-le

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

Prochaines étapes

Maintenant que vous avez essayé ces canaux avec l'Environnement de test de l'API Messages, voici quelques étapes que vous pouvez suivre pour construire avec l'API Messages elle-même :

Mettez en place vos canaux sociaux

La procédure exacte à suivre dépend de la chaîne elle-même. Vous pouvez commencer par le canal Comptes externes du tableau de bord de Vonage, ou consultez d'abord la documentation de démarrage spécifique au canal :

• Premiers pas avec WhatsApp
• Premiers pas avec Facebook Messenger
• Premiers pas avec les messages professionnels Viber

En savoir plus sur les canaux sociaux

Lisez notre documentation spécifique à chaque canal pour en savoir plus sur chaque canal social et son fonctionnement :

• Comprendre la messagerie WhatsApp
• Comprendre la messagerie Facebook
• Comprendre la messagerie Viber