WhatsApp-Benachrichtigungsabonnements

System-Webhooks werden ausgelöst, wenn ein Ereignis bei einer WABA oder einer Telefonnummer eintritt. Sie können jetzt diese Webhooks abonnieren, um Benachrichtigungen über Änderungen an den Einstellungen Ihres WhatsApp Business Accounts zu erhalten. Es gibt viele MeldungsartenWenn Sie eine Nachricht von einem Kunden erhalten haben, können Sie diese in Ihrem Account speichern, z. B. Aktualisierungen von Accounts, Änderungen von Nachrichtenvorlagen, Aktualisierungen von Telefonnummern.

Diese Benachrichtigungen können auf zwei Arten empfangen werden:

  • Über Webhaken - Benachrichtigungen über eine benutzerdefinierte Webhook-URL erhalten
  • Über Slack - Benachrichtigungen in einem bestimmten Kanal innerhalb Ihres Slack-Arbeitsbereichs erhalten.

Um ein Abonnement zu erstellen, können Sie eine Anfrage an die Erstellen eines Abonnement-Endpunkts der Kanalmanager-API.

Erstellen eines WhatsApp-Benachrichtigungsabonnements mit Webhooks

Um Aktualisierungen per Webhook zu erhalten, müssen Sie zunächst eine benutzerdefinierte Webhook-URL erstellen, die so konfiguriert ist, dass sie

POST
-Anfragen akzeptiert; werfen Sie einen Blick auf unsere Webhaken Anleitung, wenn Sie sich nicht sicher sind, wie Sie dies tun können. Sie können dann eine Anfrage an den Endpunkt für Abonnements mit den folgenden Parametern senden, um das Abonnement zu erstellen:

{
    "type": "webhook",
    "whatsapp_subscribe_types": "account_alerts,account_update",
    "vonage_subscribe_types": "vonage_number_onboarded",
    "webhook": {
      "url": "https://example.com/webhook"
    }
}

Hier:

  • url sollte Ihre benutzerdefinierte Webhook-URL enthalten.
  • whatsapp_subscribe_types ist ein optionaler Parameter, mit dem Sie bestimmte WhatsApp auflisten können Meldungsarten die Sie über Ihr Abonnement erhalten möchten. Ist dies nicht der Fall, umfasst das Abonnement alle Abonnementtypen.
  • vonage_subscribe_types ist ein optionaler Parameter, mit dem Sie bestimmte Vonage-Produkte auflisten können. Meldungsarten die Sie über Ihr Abonnement erhalten möchten. Ist dies nicht der Fall, umfasst das Abonnement alle Abonnementtypen.

Ein vollständiges Codebeispiel finden Sie in der Erstellen eines WhatsApp-Benachrichtigungsabonnements mit Webhooks Codeschnipsel.

Beispiel Webhooks

Dieses Beispiel zeigt eine Aktualisierung des Vorlagenstatus; wie in der event ist, wurde die Vorlage abgelehnt:

{
    "notification_id": "id",
    "timestamp": "2023-02-21T15:34:39Z",
    "channel": "whatsapp",
    "whatsapp": {
        "waba_info": {
            "waba_id": "<WABA_ID>",
            "solution_id": "<WABA_SOLUTION_ID>", // if present
            "api_key": "<WABA_API_KEY>"
        },
        "notification_type": "message_template_status_update",
        "notification_value": {
            "event": "REJECTED",
            "message_template_id": "<TEMPLATE_ID>",
            "message_template_name": "<TEMPLATE_NAME>",
            "message_template_language": "<LANGUAGE_AND_LOCALE_CODE>",
            "reason": "<REJECTION_REASON>"
        }
    }
}

In diesem Beispiel zeigt der Webhook eine Account-Aktualisierung an, bei der eine Rufnummer hinzugefügt wurde:

{
    "notification_id": "id",
    "timestamp": "2023-02-21T15:34:39Z",
    "channel": "whatsapp",
    "whatsapp": {
        "waba_info": {
            "waba_id": "<WABA_ID>",
            "solution_id": "<WABA_SOLUTION_ID>", // if present
            "api_key": "<WABA_API_KEY>"
        },
        "whatsapp_number_info": {
            "phone_number": "<PHONE_NUMBER>",
            "api_key": "<NUMBER_API_KEY>"
        },
        "notification_type": "account_update",
        "notification_value": {
            "phone_number": "<PHONE_NUMBER>",
            "event": "PHONE_NUMBER_ADDED"
        }
    }
}

Die notification_value Objekt, das in den Beispiel-Webhook-Nutzdaten gezeigt wird, ist eine Durchleitung des value Objekt in Meta-Webhook-Payloads.

Erstellen eines WhatsApp-Benachrichtigungsabonnements für Slack

Um Benachrichtigungen über Slack zu erhalten, können Sie eine Anfrage an die subscriptions Endpunkt mit den folgenden Parametern:

{
    "type": "slack",
    "whatsapp_subscribe_types": "account_alerts,account_update,message_template_status_update",
    "slack": {
      "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    }
}

Hier:

  • Die url Feld sollte eine eingehende Webhook-URL enthalten, die für Ihren Slack-Arbeitsbereich erstellt wurde. Bitte beachten Sie die Slack Webhook-Dokumentation für weitere Informationen über die Konfiguration dieser URL.
  • whatsapp_subscribe_types ist ein optionaler Parameter, mit dem Sie bestimmte Meldungsarten die Sie über Ihr Abonnement erhalten möchten. Ist dies nicht der Fall, umfasst das Abonnement alle Abonnementtypen.

Ein vollständiges Codebeispiel finden Sie in der Erstellen eines WhatsApp-Benachrichtigungsabonnements für Slack Codeschnipsel.

Beispiel Benachrichtigung

Sobald Ihr Abonnement erstellt ist, erhalten Sie Aktualisierungen im angegebenen Slack-Kanal, zum Beispiel:

An example Slack notification showing a WhatsApp account update

Arten von Benachrichtigungen

  • Es gibt viele mögliche Werte für whatsapp_subscribe_typesdie sowohl in den Webhook- als auch in den Slack-Benachrichtigungen angezeigt werden. Die vollständige Liste der Benachrichtigungstypen und ihre Beschreibungen finden Sie in der Meta-WhatsApp-Dokumentation.
  • Derzeit gibt es nur einen möglichen Wert für vonage_subscribe_typesdas ist vonage_number_onboarded.

Alle Abonnements auflisten

Um alle Ihre bestehenden Abonnements aufzulisten, senden Sie eine

GET
-Anfrage an die subscriptions Endpunkt; Codebeispiele finden Sie in der Vorhandene Benachrichtigungsabonnements auflisten Codeschnipsel.

Löschen eines Abonnements

Um ein Abonnement zu löschen, senden Sie eine

DELETE
-Anfrage mit der eindeutigen ID des Abonnements, das Sie löschen möchten. Codebeispiele finden Sie in der Löschen eines Abonnements Codeschnipsel.

Weitere Lektüre