Détails techniques de Dispatch API

Product deprecation notice

From August 31st 2025, the Vonage Dispatch API will be closed to new users, though the product will continue to be supported for existing users. If you are looking to build a messaging application with failover functionality, failover is now supported directly in the Messages API.

For general information about the Messages Failover feature please refer to this guide. For guidance on migrating from Dispatch API to Messages API Failover, please refer to this guide.

If you have any further questions regarding this product deprecation, please contact your account manager or support for help.

L'API Dispatch de Vonage permet au développeur d'envoyer des messages aux utilisateurs en utilisant une stratégie à canaux multiples.

Un exemple de flux de travail pourrait spécifier l'envoi d'un message via Facebook Messenger, et si ce message n'est pas lu, l'utilisateur peut recevoir un message via Viber. Si ce message n'est pas non plus lu, l'utilisateur peut alors recevoir un message par SMS.

La Dispatch API fournit le mécanisme permettant d'ordonner les messages et de spécifier leur conditions de réussite. L'API Dispatch utilise l'API Messages pour envoyer les messages.

Le diagramme suivant illustre la relation entre l'API Dispatch et l'API Messages :

Messages and Dispatch Overview

Bêta

Cette API est actuellement en version bêta.

Dans cette version, Vonage fournit un modèle de basculement. Le modèle de basculement indique au Messages API pour envoyer un message au canal spécifié. Si ce message échoue immédiatement ou si l'option condition_status n'est pas atteint dans le délai spécifié, le message suivant est envoyé.

Vonage est toujours heureux de recevoir vos commentaires. Vos suggestions nous aident à améliorer le produit. Si vous avez besoin d'aide, veuillez envoyer un courriel à soutien et mentionnez Workflow API dans la ligne d'objet. Veuillez noter que pendant la période de bêta, l'assistance est limitée au lundi au vendredi.

Caractéristiques prises en charge

Dans cette version, vous pouvez :

  • Envoyer SMS, Facebook Messenger, WhatsApp et Viber Business Messages avec Dispatch, qui s'appuie sur le système d'information de l'entreprise. Messages API.
  • Basculement au message suivant si la condition n'est pas remplie dans le délai imparti ou si le message échoue immédiatement.

L'état de la condition est l'état que le message renvoie. Avec Facebook Messenger et Viber Business Messages, vous pouvez utiliser delivered et read comme état de la condition. Avec les SMS, vous ne pouvez utiliser que delivered.

API Comptes externes

Les API Comptes externes est utilisé pour gérer vos Account pour Viber Business Messages, Facebook Messenger et WhatsApp lorsque vous utilisez ces canaux avec les API Messages et Dispatch.

Pour commencer

Dans cet exemple, vous devrez remplacer les variables suivantes par des valeurs réelles en utilisant n'importe quelle méthode pratique :

Clé Description
VONAGE_API_KEY Clé API Vonage qui peut être obtenue auprès de votre Tableau de bord de l'API Vonage.
VONAGE_API_SECRET Le secret de l'API de Vonage, qui peut être obtenu auprès de votre Tableau de bord de l'API Vonage.
FB_SENDER_ID Votre ID de page. L'identifiant FB_SENDER_ID est la même que celle de la to.id que vous avez reçue dans l'événement de messagerie entrante sur votre URL Inbound Message Webhook.
FB_RECIPIENT_ID Le PSID de l'utilisateur auquel vous souhaitez répondre. Le PSID de l'utilisateur auquel vous voulez répondre. FB_RECIPIENT_ID est le PSID de l'utilisateur Facebook auquel vous envoyez un message. Cette valeur est la from.id que vous avez reçue dans l'événement de messagerie entrante sur votre URL Inbound Message Webhook.
FROM_NUMBER Un numéro de téléphone que vous possédez ou un texte permettant d'identifier l'expéditeur.
TO_NUMBER Le numéro du téléphone auquel le message sera envoyé.

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.

Le code suivant montre comment créer un flux de travail qui tente d'envoyer un message via Facebook Messenger et qui, s'il n'est pas lu dans le délai imparti, envoie un message par SMS :

Rédiger le code

Ajouter ce qui suit à send-message-with-failover-basic-auth.sh:

curl -X POST https://api.nexmo.com/v0.1/dispatch \
  -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "template":"failover",
    "workflow": [
      {
        "from": { "type": "messenger", "id": '$FB_SENDER_ID' },
        "to": { "type": "messenger", "id": '$FB_RECIPIENT_ID' },
        "message": {
          "content": {
            "type": "text",
            "text": "This is a Facebook Messenger Message sent from the Dispatch API"
          }
        },
        "failover":{
          "expiry_time": 600,
          "condition_status": "read"
        }
      },
      {
        "from": {"type": "sms", "number": '$FROM_NUMBER'},
        "to": { "type": "sms", "number": '$TO_NUMBER'},
        "message": {
          "content": {
            "type": "text",
            "text": "This is an SMS sent from the Dispatch API"
          }
        }
      }
    ]
  }'

Voir la source complète

Exécutez votre code

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

bash send-message-with-failover-basic-auth.sh

Concepts

Extraits de code

Tutoriels

Cas d'utilisation

Référence