Webhooks от Meta

Платформа WhatsApp Business

Webhooks for WhatsApp Business Accounts

Вы можете получать уведомления в реальном времени при внесении изменений в аккаунт WhatsApp Business (WABA), подписавшись на уровне аккаунта WhatsApp Business. Чтобы настроить Webhooks для аккаунта WhatsApp Business:

  1. Настройте конечную точку и Webhooks. Следуйте тем же шагам, что и для настройки Webhooks для Страниц Facebook.
  2. Подпишите свое приложение на уровне аккаунта WhatsApp Business. Вы должны подписать приложение, принадлежащее вашей компании. Приложения, к которым вашей компании предоставлен доступ, не могут получать уведомления Webhook.
  3. Убедитесь, что приложение прошло проверку и запросило разрешение whatsapp_business_management.

GET, POST, and DELETE calls to /{whats-app-business-account-id}/subscribed_apps are now subject to Business Use Case Rate Limits.

Set up Your Endpoint and Webhooks

Follow our Webhooks Getting Started guide to create your endpoint and configure your webhook endpoint. When you configure your endpoint, make sure to choose WhatsApp Business Account and subscribe to individual WhatsApp Business Account (WABA) fields.

Available Subscription Fields

Доступные поля подписки

Имя поля Описание

account_review_update

Уведомления об окончании проверки аккаунта WhatsApp Business.

account_update

Уведомления об изменениях в вашем аккаунте WhatsApp Business. Это могут быть обновление номера телефона, нарушение политики, блокировка аккаунта WhatsApp Business и др.

business_capability_update

Уведомления об изменении ограничений. Например, это может быть ограничение на количество номеров телефонов, связанных с одним аккаунтом WhatsApp Business, или на количество переписок для каждого номера телефона.

message_template_status_update

Уведомления об одобрении, отклонении или отключении шаблона сообщения.

messages

Уведомления о получении вашей компанией сообщения от клиента, об отправке вами сообщения клиенту, о доставке сообщения клиенту и о прочтении вашего сообщения клиентом.

phone_number_name_update

Уведомления об одобрении или отклонении имени, связанного с номером телефона.

phone_number_quality_update

Уведомления об обновлении статуса, связанного с качеством, для номера телефона.

security

Уведомления о следующем:

  • вы запросили отключение кода двухшаговой проверки;
  • двухшаговая проверка отключена;
  • код двухшаговой проверки обновлен.

    • Подробнее обо всех полях с полезными данными см. в справке по Webhooks для аккаунта WhatsApp Business , а о типах уведомлений messages, которые можно получать, — в справке по Webhooks для облачного API WhatsApp .

    Subscribe Your App

    You need to subscribe your app to webhooks on a given WABA. We only send notifications if your webhooks-configured app is subscribed to webhooks on a given WABA, and only if the app has permission to edit that WABA.

    Create a Subscription

    Request

    To subscribe your app to webhooks on a WABA, send a POST request to the WABA > Subscribed Apps endpoint.

    curl -X POST 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/subscribed_apps' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'

    Response

    Upon success:

    {
  "success": "true"
}

    Get Subscribed Apps

    To get a list of apps subscribed to webhooks on a WABA, send a GET request to the WABA > Subscribed Apps endpoint.

    Request

    curl 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/subscribed_apps' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'

    Response

    A successful response will list the subscribed apps:

    {
  "data": [
    {
      "whatsapp_business_api_data": {
        "link": "<APP_1_URL>",
        "name": "<APP_1_NAME>",
        "id": "<APP_1_ID>"
      }
    },
    {
      "whatsapp_business_api_data": {
        "link": "<APP_2_URL>",
        "name": "<APP_2_NAME>",
        "id": "<APP_2_ID>"
      }
    },
    ...
  ]
}

    Delete a subscription

    To unsubscribe your app from webhooks on a WABA, send a DELETE request to the subscribed_apps endpoint.

    Request

    curl -X DELETE 'https://graph.facebook.com/<AP_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/subscribed_apps' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'

    Response

    A successful response will read:

    {
  "success": "true"
}

    Subscribe with Graph API Explorer

    If you don't want to subscribe your app with direct API calls, you can easily do it with Graph API Explorer.

    Replace the me?fields=id,name query with <WHATSAPP_BUSINESS_ACCT_ID>/subscribed_apps. It will subscribe the app you use to send the POST request in Graph Explorer.

    Your app must have permission to edit the WhatsApp business account in order to successfully subscribe.

    Example Webhook payload:

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