WhatsApp Business Platform > Business Management API > Reference

Webhooks-Komponenten

Webhooks verfügen auf oberster Ebene über ein Array-Feld, aus dem hervorgeht, was kommuniziert wird. Die Mitglieder des Arrays sind JSON-Objekte mit detaillierten Feldern, die für den Webhook relevant sind.

Webhooks der WhatsApp Business Management API können folgende Objekte enthalten:

Parameter Beschreibung

Parameter	Beschreibung
`object`	Dies ist das Objekt, das abonniert wurde. Bei Embedded Signup ist dies immer `whatsapp_business_account`.
`entry`	Das Objekt enthält die Details der Änderung, die den Webhooks-Aufruf ausgelöst hat.

object

Dies ist das Objekt, das abonniert wurde.

Bei Embedded Signup ist dies immer whatsapp_business_account.

entry

Das Objekt enthält die Details der Änderung, die den Webhooks-Aufruf ausgelöst hat.

Das Objekt `entry`

Parameter	Beschreibung
`id`	ID der WhatsApp Business-Kontos, zu denen dieser Webhook gehört
`time`	Zeit des Eintrags
`changes`	Änderungen, die den Webhooks-Aufruf ausgelöst haben. Siehe `changes`-Objekt.

`changes`

Parameter	Beschreibung (Klicke für unterstützte Werte auf den Pfeil in der linken Spalte.)
`field`	Enthält den Typ von Benachrichtigung, die du zu diesem Webhook erhältst.
Unterstützte Werte	`account_alerts` `account_review_update` `account_update` `business_capability_update` `message_template_quality_update` `message_template_status_update` `phone_number_name_update` `phone_number_quality_update` `security` `template_category_update`
`value`	Enthält Details zu den Änderungen, die sich auf das angegebene `field` beziehen. Siehe `value`-Objekt.

`value`

Parameter	Beschreibung (Klicke für unterstützte Werte auf den Pfeil in der linken Spalte.)
`ban_info`	Wird zu Webhooks hinzugefügt, wenn ein Konto gesperrt wurde. Dieses Objekt hat zwei Eigenschaften: `waba_ban_state`: Die Optionen sind folgende: `DISABLE` `REINSTATE` `SCHEDULE_FOR_DISABLE` `waba_ban_date`
`current_limit`	Enthält die aktuelle Einschränkungsstufe für dieses Konto.
Unterstützte Werte	`TIER_50` `TIER_250` `TIER_1K` `TIER_10K` `TIER_100K` `TIER_UNLIMITED`
`decision`	Wird verwendet, wenn eine Entscheidung zu Konten oder Telefonnummern getroffen wurde.
Unterstützte Werte	`APPROVED` `REJECTED`
`display_phone_number`	Enthält die angezeigte Telefonnummer des Business-Kontos, das die Benachrichtigung ausgelöst hat.
`event`	Wird verwendet, wenn in einem bestimmten WABA ein Event aufgetreten ist. Klicke auf den Pfeil in der linken Spalte, um alle verfügbaren Optionen anzuzeigen.
Aktualisierungen von Display-Namen	`APPROVED`: Die Überprüfung war erfolgreich und der Name wurde genehmigt. Wenn ein Unternehmen sein Zertifikat zuvor nicht herunterladen konnte, sollte es jetzt dazu in der Lage sein, um seinen Display-Namen zu verwenden. `DEFERRED`: Die Überprüfung wird verschoben und das Unternehmen kann seinen Display-Namen verwenden, indem es das Zertifikat herunterlädt. `REJECTED`: Die Überprüfung war nicht erfolgreich und der Name wurde aus dem angegebenen Grund abgelehnt. Wenn ein Unternehmen sein Zertifikat zuvor nicht herunterladen konnte, muss es nun einen erneuten Antrag auf Überprüfung des Display-Namens stellen, um Zugriff auf das Zertifikat zu erhalten. Wenn ein Unternehmen sein Zertifikat bereits verwendet, hat die Ablehnung des Display-Namens bei der Überprüfung keine Auswirkungen auf den Geschäftsbetrieb. Das Bestehen der Überprüfung ist jedoch nötig, damit das Unternehmen seine Nachrichten- und Kontobeschränkungen erweitern kann.
Aktualisierung der Nachrichtenvorlagenqualität	Vorheriger Qualitätswert: `GREEN` `RED` `UNKNOWN` `YELLOW` Neuer Qualitätswert: `GREEN` `RED` `UNKNOWN` `YELLOW`
Aktualisierungen des Nachrichtenvorlagenstatus	`APPROVED` `DISABLED` `IN_APPEAL` `PENDING` `REINSTATED` `REJECTED` `FLAGGED`
Aktualisierungen von Telefonnummern	`DOWNGRADE` `FLAGGED` `ONBOARDING` `UNFLAGGED` `UPGRADE`
Aktualisierung der Vorlagenkategorie	Vorherige Kategorien: `MARKETING` `OTP` `TRANSACTIONAL` Neue Kategorien: `AUTHENTICATION` `MARKETING` `UTILITY`
Code für Verifizierung in zwei Schritten	`PIN_CHANGED:` Code für Verifizierung in zwei Schritten wurde aktualisiert (nur Cloud API) `PIN_RESET_REQUEST:` Anfrage zur Deaktivierung des Codes für Verifizierung in zwei Schritten `PIN_RESET_SUCCESS:` Code für Verifizierung in zwei Schritten wurde deaktiviert
WABA-Aktualisierungen	`ACCOUNT_RESTRICTION`: Diese Option wird verwendet, um zu melden, dass eine Einschränkung auferlegt wurde, wenn ein WABA gegen eine Richtlinie der WhatsApp Business Platform verstoßen hat. `DISABLED_UPDATE` `VERIFIED_ACCOUNT`
`max_daily_conversation_per_phone`	Immer vorhanden, wenn `field=business_capability_update`. Gibt die Anzahl der Vorlagennachrichten an, die du mit jeder Unternehmenstelefonnummer deines WhatsApp-Unternehmenskontos senden kannst, die über einen genehmigten Display-Namen verfügt. Siehe Messaging-Einschränkungen.
`max_phone_numbers_per_business`	Umfasst die maximale Anzahl von Telefonnummern, die zu einem Unternehmen gehören können. Wenn field=business_capability_update, hat ein Webhook entweder max_phone_numbers_per_business oder max_phone_numbers_per_waba present.
`max_phone_numbers_per_waba`	Umfasst die maximale Anzahl von Telefonnummern, die zu einem WABA gehören können. Wenn field=business_capability_update, hat ein Webhook entweder max_phone_numbers_per_business oder max_phone_numbers_per_waba.
`reason`	Grund für die Ablehnung der Vorlage. Mögliche Werte `ABUSIVE_CONTENT` – Inhalt wurde als missbräuchlich eingestuft. `INCORRECT_CATEGORY` – Kategorie wurde als nicht korrekt ermittelt. Siehe Vorlagenkategorien. `INVALID_FORMAT` – Inhalt ist dupliziert oder Beispiele fehlen. `NONE` – Dies ist der Standard und wird festgelegt, wenn die Vorlage genehmigt wurde. `SCAM` – Inhalt wurde als Scam eingestuft.
`rejection_reason`	Wenn eine Anfrage abgelehnt wurde, wird in diesem Feld der Grund für diese Ablehnung angezeigt.
`requested_verified_name`	In diesem Feld wird der Name angezeigt, der zur Bestätigung gesendet wurde.
`restriction_info` Enum	Wird verwendet, um auferlegte Einschränkung für einen bestimmten WABA zu melden, wenn dieser WABA gegen eine der Richtlinien der WhatsApp Business Platform verstoßen hat. Dieses Feld enthält eine Liste der Einschränkungstypen mit den jeweiligen Ablaufdaten. Mögliche Einschränkungstypen sind: `RESTRICTED_ADD_PHONE_NUMBER_ACTION` `RESTRICTED_BIZ_INITIATED_MESSAGING` `RESTRICTED_CUSTOMER_INITIATED_MESSAGING` Ablaufdaten werden im DateTime-Format (Datum/Uhrzeit) angegeben.
`requester`	ID desder Nutzerin, der*die die Deaktivierung des Codes für die Verifizierung in zwei Schritten angefordert hat oder die Deaktivierung oder eine Aktualisierung bereits vorgenommen hat.

Beispiele

Aktualisierung des Nachrichtenvorlagenstatus

Vorlage genehmigt

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "whatsapp-business-account-id",
      "time": 1604703141,
      "changes": [
        {
          "field": "message_template_status_update",
          "value": { 
              "event": "APPROVED",
              "message_template_id": 1234567, 
              "message_template_name": "My message template",
              "message_template_language": "en-US",
              "reason": null 
         }
       }
      ]
    }
  ]
}

Vorlage abgelehnt

{
  "object": "whatsapp_business_account"
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "time": <TIMESTAMP>,
      "changes": [
        {
          "value": {
            "event": "REJECTED",
            "message_template_id": <TEMPLATE_ID>,
            "message_template_name": "<TEMPLATE_NAME>",
            "message_template_language": "<LANGUAGE_AND_LOCALE_CODE>",
            "reason": "<REJECTION_REASON>"
          },
          "field": "message_template_status_update"
        }
      ]
    }
  ]
}

Vorlage zur Deaktivierung geplant

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "field": "message_template_status_update",
          "value": { 
              "event": "FLAGGED",
              "message_template_id": TEMPLATE-ID, 
              "message_template_name": "My message template",
              "message_template_language": "en-US",
              "reason": null,
              "disable_info": {
                  "disable_date": "DATE",
              }
         }
       }
      ]
    }
  ]
}

Vorlage pausiert

{
  "object": "whatsapp_business account",
  "entry": [
    {
      "id": "10908...",
      "time": 1661885238,
      "changes": [
        {
          "value": {
            "event": "PAUSED",
            "message_template_id": 6048...,
            "message_template_name": "welcome",
            "message_template_language": "en_US",
            "reason": "NONE",
            "other_info": {
              "title": "SECOND_PAUSE",
              "description": "Your WhatsApp message template has been paused for 6 hours until Aug 31 at 12:47 AM UTC because it continued to have issues."
            }
          },
          "field": "message_template_status_update"
        }
      ]
    }
  ],
}

Löschung der Vorlagennachricht ausstehend

{
  "object": "whatsapp_business account",
  "entry": [
    {
      "id": "10310...",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "PENDING_DELETION",
            "message_template_id": 1137...,
            "message_template_name": "<MY_TEMPLATE_NAME>",
            "message_template_language": "en_US",
            "reason": "NONE"            
            }
          },
          "field": "message_template_status_update"
        }
      ]
    }
  ],
}

Aktualisierung der Vorlagenkategorie

Vorlagenkategorie geändert

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<ID>",
      "time": <TIME>,
      "changes": [
        {
          "field": "template_category_update",
          "value": {            
            "message_template_id": <MESSAGE_TEMPLATE_ID>,
            "message_template_name": "<MESSAGE_TEMPLATE_NAME>",
            "message_template_language": "<MESSAGE_TEMPLATE_LANGUAGE",
            "previous_category": "<PREVIOUS_CATEGORY>",
            "new_category": "<NEW_CATEGORY>"
          }
        }
      ]
    }
  ]
}

Aktualisierung der Nachrichtenvorlagenqualität

Qualitätsbewertung der Vorlage geändert

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "time": <TIMESTAMP>,
      "changes": [
        {
          "field": "message_template_quality_update",
          "value": {
            "previous_quality_score": "<PREVIOUS_QUALITY_SCORE>",
            "new_quality_score": "<NEW_QUALITY_SCORE>",
            "message_template_id": <TEMPLATE_ID>,
            "message_template_name": "<TEMPLATE_NAME>",
            "message_template_language": "<LANGUAGE_AND_LOCALE_CODE>"
          }
        }
      ]
    }
  ]
}

Aktualisierungen von Telefonnummern

Namensaktualisierung erhalten

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "waba-id",
      "time": 1608243053,
      "changes": [
        {
          "field": "phone_number_name_update",
          "value": {
            "display_phone_number": "16505551111",
            "decision": "APPROVED",
            "requested_verified_name": "WhatsApp",
            "rejection_reason": null
          }
        }
      ]
    }
  ]
}

Qualitätsaktualisierung erhalten

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "waba-id",
      "time": 1608243062,
      "changes": [
        {
          "field": "phone_number_quality_update",
          "value": {
            "display_phone_number": "16505551111",
            "event": "FLAGGED",
            "current_limit": "TIER_10K"
          }
        }
      ]
    }
  ]
}

WABA-Aktualisierungen

Sandbox-Nummer auf verifiziertes Konto hochgestuft

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "whatsapp-business-account-id",
      "time": 1604703058,
      "changes": [
        {
          "field": "account_update",
          "value": {
            "phone_number": "16505551111",
            "event": "VERIFIED_ACCOUNT"
          }
        }
      ]
    }
  ]
}

WhatsApp Business-Konto gesperrt

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "whatsapp-business-account-id",
      "time": 1604703058,
      "changes": [
        {
          "field": "account_update",
          "value": {
            "event": "DISABLED_UPDATE"
            "ban_info": {
              "waba_ban_state": ["SCHEDULE_FOR_DISABLE", "DISABLE", "REINSTATE"],
              "waba_ban_date": "January 31, 2021"
            }
          }
        }
      ]
    }
  ]
}

WhatsApp Business-Konto verstößt gegen Richtlinie

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "ACCOUNT_VIOLATION",
            "violation_info": {
              "violation_type": "VIOLATION_TYPE"
            }
          },
          "field": "account_update"
        }
      ]
    }
  ]
}

WhatsApp Business-Konto nach Richtlinienverstößen eingeschränkt

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "ACCOUNT_RESTRICTION",
            "restriction_info": [
               {"restriction_type": 
                 "RESTRICTED_BIZ_INITIATED_MESSAGING" | 
                 "RESTRICTION_ON_ADD_PHONE_NUMBER_ACTION" | 
                 "RESTRICTED_CUSTOMER_INITIATED_MESSAGING", 
                 "expiration": TIMESTAMP}
                 ]
            }
          },
          "field": "account_update"
        }
      ]
    }
  ]
}

WhatsApp Business-Konto deaktiviert

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "DISABLED_UPDATE",
            "ban_info": {
              "waba_ban_state": 
               "SCHEDULE_FOR_DISABLE" | 
               "DISABLE" | 
               "REINSTATE",
               "waba_ban_date": TIMESTAMP
            }
          },
          "field": "account_update"
        }
      ]
    }
  ]
}

Überprüfung des WhatsApp Business-Kontos abgeschlossen

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "whatsapp-business-account-id",
      "time": 1604703141,
      "changes": [
        {
          "field": "account_review_update",
          "value": {
            "decision": "APPROVED"
          }
        }
      ]
    }
  ]
}

WhatsApp Business-Konto aufgrund von Richtlinienverstößen eingeschränkt

{
  "field": "account_update",
  "value": {
    "phone_number": "PHONE_NUMBER",
    "event": "ACCOUNT_RESTRICTION",
    "restriction_info": [
      {
        "restriction_type": "RESTRICTION_ADD_PHONE_NUMBER_ACTION",
        "expiration": TIMESTAMP
      },
      {
        "restriction_type": "RESTRICTED_BIZ_INITIATED_MESSAGING",
        "expiration": TIMESTAMP
      },
      {
        "restriction_type": "RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
        "expiration": TIMESTAMP
      }
    ]
  }
}

WhatsApp Business-Konto gelöscht

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
              "phone_number": "15551...",
              "event": "ACCOUNT_DELETED",
           },
          "field": "account_update"
        }
      ]
    }
  ]
}

WhatsApp Business-Konto von Partner entfernt

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
              "phone_number": "15551...",
              "event": "PARTNER_REMOVED",
           },
          "field": "account_update"
        }
      ]
    }
  ]
}

Aktualisierungen von Unternehmensfunktionen

{
    "object": "whatsapp_business_account",
    "entry": [
      {
        "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
        "time": TIMESTAMP,
        "changes": [
          {
            "field": "business_capability_update",
            "value": {
              "max_daily_conversation_per_phone": NUMBER,
              "max_phone_numbers_per_business": NUMBER
            }
          }
        ]
      }
    ]
  }

Kontohinweise

Erhöhung des Nachrichtenlimits abgelehnt

{
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "time": <UNIX_TIMESTAMP>,
      "changes": [
        {
          "value": {
            "entity_type": "BUSINESS",
            "entity_id": "<BUSINESS_ID>",
            "alert_severity": "CRITICAL",
            "alert_status": "ACTIVE",
            "alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_FAILED",
            "alert_description": "Based on your activity, limits cannot be increased for your business <BUSINES_NAME>. Contact support for more information."
          },
          "field": "account_alerts"
        }
      ]
    }
  ],
  "object": "whatsapp_business_account"
}

Erhöhung des Nachrichtenlimits abgelehnt, höhere Nutzung erforderlich

{
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "time": <UNIX_TIMESTAMP>,
      "changes": [
        {
          "value": {
            "entity_type": "BUSINESS",
            "entity_id": "<BUSINESS_ID>",
            "alert_severity": "WARNING",
            "alert_status": "ACTIVE",
            "alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_DEFERRED",
            "alert_description": "Limits cannot be increased for your business <BUSINES_NAME>. Use WhatsApp Business platform actively for several days and follow our messaging policies."
          },
          "field": "account_alerts"
        }
      ]
    }
  ],
  "object": "whatsapp_business_account"
}

Erhöhung des Nachrichtenlimits abgelehnt, weitere Informationen erforderlich

{
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "time": <UNIX_TIMESTAMP>,
      "changes": [
        {
          "value": {
            "entity_type": "BUSINESS",
            "entity_id": "<BUSINESS_ID>",
            "alert_severity": "WARNING",
            "alert_status": "ACTIVE",
            "alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_NEED_MORE_INFO",
            "alert_description": "Additional verification is required for your business <BUSINESS_NAME>. Go to Security Center in Meta for Business to complete identity verification. To continue without completing additional verification, your business can use WhatsApp Business platform actively for several days and follow our messaging policies."
          },
          "field": "account_alerts"
        }
      ]
    }
  ],
  "object": "whatsapp_business_account"
}

WhatsApp Business Platform | Cloud API | On-Premises API | Business Management API