Technische Details der 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.

Die Dispatch API von Vonage ermöglicht es dem Entwickler, Nachrichten an Benutzer zu senden, die eine Strategie mit mehreren Kanälen verwenden.

In einem Arbeitsablauf könnte beispielsweise festgelegt werden, dass eine Nachricht über den Facebook-Messenger gesendet wird. Wird diese Nachricht nicht gelesen, kann dem Nutzer eine Nachricht über Viber gesendet werden. Wenn auch diese Nachricht nicht gelesen wird, könnte dem Nutzer eine Nachricht per SMS geschickt werden.

Die Dispatch API bietet den Mechanismus, mit dem Nachrichten geordnet und ihre Erfolgsbedingungen. Die Dispatch API verwendet die Messages API, um die Nachrichten zu senden.

Das folgende Diagramm veranschaulicht die Beziehung zwischen der Dispatch API und der Messages API:

Messages and Dispatch Overview

Beta

Diese API befindet sich derzeit im Beta-Stadium.

In dieser Version stellt Vonage ein Failover-Template zur Verfügung. Das Failover-Template instruiert die Messages API um eine Nachricht an den angegebenen Kanal zu senden. Wenn diese Nachricht sofort fehlschlägt oder wenn die condition_status nicht innerhalb der angegebenen Zeitspanne erreicht wird, wird die nächste Nachricht gesendet.

Vonage freut sich immer über Ihr Feedback. Ihre Vorschläge helfen uns, das Produkt zu verbessern. Wenn Sie Hilfe benötigen, senden Sie bitte eine E-Mail an Unterstützung und geben Sie in der Betreffzeile Workflow API an. Bitte beachten Sie, dass die Supportzeiten während der Beta-Phase auf Montag bis Freitag beschränkt sind.

Unterstützte Funktionen

In dieser Version können Sie:

  • Senden Sie SMS, Facebook Messenger, WhatsApp und Viber Business Messages mit Dispatch auf der Basis der Messages API.
  • Ausfallsicherung zur nächsten Meldung, wenn der Bedingungsstatus nicht innerhalb der Zeitspanne erfüllt wird oder die Meldung sofort fehlschlägt.

Der Bedingungsstatus ist der Status, den die Nachricht zurückgibt. Bei Facebook Messenger und Viber Business Messages können Sie Folgendes verwenden delivered und read Status als Konditionsstatus. Bei SMS können Sie nur verwenden delivered.

Externe Accounts API

Die Externe Accounts API wird verwendet, um Ihre Konten für Viber Business Messages, Facebook Messenger und WhatsApp zu verwalten, wenn Sie diese Kanäle mit den Messages- und Dispatch-APIs nutzen.

Erste Schritte

In diesem Beispiel müssen Sie die folgenden Variablen mit einer beliebigen Methode durch aktuelle Werte ersetzen:

Schlüssel Beschreibung
VONAGE_API_KEY Vonage API-Schlüssel, den Sie von Ihrem Vonage API Dashboard.
VONAGE_API_SECRET Vonage-API-Geheimnis, das Sie von Ihrem Vonage API Dashboard.
FB_SENDER_ID Ihre Seiten-ID. Die FB_SENDER_ID ist dasselbe wie die to.id Wert, den Sie im Inbound-Messenger-Ereignis auf Ihrer Inbound Message Webhook URL erhalten haben.
FB_RECIPIENT_ID Die PSID des Benutzers, dem Sie antworten möchten. Die FB_RECIPIENT_ID ist die PSID des Facebook-Benutzers, dem du eine Nachricht sendest. Dieser Wert ist der from.id Wert, den Sie im Inbound-Messenger-Ereignis auf Ihrer Inbound Message Webhook URL erhalten haben.
FROM_NUMBER Eine eigene Telefonnummer oder ein Text zur Identifizierung des Absenders.
TO_NUMBER Die Nummer des Telefons, an das die Nachricht gesendet werden soll.

HINWEIS: Verwenden Sie kein führendes + oder 00 Wenn Sie eine Telefonnummer eingeben, beginnen Sie mit der Landesvorwahl, z. B. 447700900000.

Der folgende Code zeigt, wie man einen Workflow erstellt, der versucht, eine Nachricht über Facebook Messenger zu senden, und wenn diese nicht innerhalb des Zeitlimits gelesen wird, wird eine Nachricht per SMS gesendet:

Schreiben Sie den Code

Fügen Sie Folgendes zu send-message-with-failover-basic-auth.sh hinzu:

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"
          }
        }
      }
    ]
  }'

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

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

Concepts

Code-Schnipsel

Anleitungen

Anwendungsfälle

Referenz