Локальный API платформы WhatsApp Business

Webhooks для локального API

Подпишитесь на Webhooks, чтобы получать уведомления о сообщениях, которые отправляются вашей компании, и обновлениях профилей клиентов. Подробные сведения о Webhooks для платформы WhatsApp Business см. в обзоре Webhooks.

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

Прежде чем начать

Вам понадобятся:

  • код с поддержкой HTTPS и действующим сертификатом SSL;
  • конечная точка URL обратного вызова, принимающая входящие запросы от Coreapp;
  • конечная точка URL обратного вызова, которая возвращает ответ HTTPS 200 OK при получении уведомления.

Повторные попытки

Если уведомление по какой-либо причине не было доставлено или запрос Webhook вернул код статуса HTTP, отличный от 200, мы попытаемся доставить уведомление ещё раз. Попытки будут повторяться через увеличивающиеся промежутки времени, пока не истечет время ожидания (обычно оно составляет 24 часа, но может быть и иным) или пока уведомление не будет доставлено.

Настройка конечной точки URL обратного вызова

Отправьте запрос PATCH к конечной точке /v1/settings/application, указав в параметре webhooks конечную точку URL обратного вызова. Также можно настроить параметры sent_status и callback_persist.

Пример запроса

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

В случае успеха ответ содержит код 200 OK с объектом по умолчанию null или объектом JSON.

Подробнее о настройке приложения и дополнительных параметрах Webhooks см. в справке по настройкам приложения.

Полезная нагрузка уведомления Webhooks

Когда происходит событие-триггер, платформа WhatsApp Business обнаруживает его и отправляет уведомление на URL Webhook, указанный вами раннее. Можно получать два типа уведомлений:

  • Полученные сообщения: это оповещение о том, что вам пришло сообщение. В документации они также могут называться "входящими сообщениями".
  • Уведомления о статусе и расценках: это оповещение о том, что статус сообщения изменился — например, сообщение было прочитано или доставлено. В документации они также могут называться "исходящими сообщениями".

Информацию о каждом поле см. в разделе Компоненты.

Уведомление об ошибке

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

Конечные точки тестового приложения

Чтобы протестировать Webhooks, создайте тестовое приложение с конечной точкой для получения уведомлений.