Веб-хуки | Документация для разработчиков

В этом документе описываются веб-хуки и способы их использования платформой WhatsApp Business.

Вебхуки — это HTTP-запросы, содержащие JSON-данные, которые отправляются с серверов Meta на указанный вами сервер. Платформа WhatsApp Business использует вебхуки для информирования вас о входящих сообщениях, статусе исходящих сообщений и другой важной информации, такой как изменения статуса вашей учетной записи, обновления возможностей обмена сообщениями и изменения оценок качества ваших шаблонов.

Например, это веб-хук, описывающий сообщение, отправленное пользователем WhatsApp компании:

Для приема веб-хуков необходимо создать и настроить конечную точку веб-хука. Инструкции по созданию собственной конечной точки см. в нашем «Создание конечной точки веб-хука». документе

Если вы пока не готовы создать собственную конечную точку, вы можете создать тестовую конечную точку веб-перехватчика , которая будет выводить данные веб-перехватчика в консоль. Однако обратите внимание, что прежде чем вы сможете использовать свое приложение в производственной среде, вы должны создать собственную конечную точку.

Для получения веб-хуков вам потребуются следующие разрешения:

Если вы являетесь непосредственным разработчиком, используйте системного пользователя для предоставления приложению этих разрешений при генерации системного токена.

Если вы являетесь поставщиком решений и вам необходимы эти разрешения для предоставления соответствующих услуг вашим бизнес-клиентам, вы должны получить одобрение на расширенный доступ к этим разрешениям через процедуру проверки приложения , прежде чем ваши бизнес-клиенты смогут предоставить вашему приложению эти разрешения во время регистрации.

После создания и настройки конечной точки веб-перехватчика (или настройки тестовой конечной точки веб-перехватчика) используйте управления приложением > WhatsApp > Конфигурация , чтобы подписаться на отдельные поля веб-перехватчика.

Обратите внимание, что если вы создали приложение, используя взаимодействия с клиентами через WhatsApp , перейдите в Панель управления приложениями > Сценарии использования > Настройка > Конфигурация .

Название поля	Описание
account_alerts	Веб account_alerts для корпоративного телефонного номера лимита сообщений, профиля компаниии официального бизнес-аккаунта .
account_review_update	Веб account_review_update уведомляет вас о том, что учетная запись WhatsApp Business была проверена на соответствие нашим правилам.
account_update	уведомляет -хук account_update WhatsApp Business бизнес-подтверждения, предоставленных партнером , о международной аутентификации или об основном местоположении бизнеса, когда учетная запись передается партнеру по решениям, о нарушениях политики или условий, об удалении, повторном подключении или об удалении учетной записи.
автоматические события	automatic_events , который отправил вам сообщение через вашу рекламу Click to WhatsApp, если вы включили по автоматическим событиям .
обновление_возможностей_бизнеса	Веб business_capability_update уведомляет вас об изменениях в возможностях бизнес-аккаунта WhatsApp или бизнес-портфеля (лимиты на сообщения, лимиты на номера телефонови т. д.).
история	Веб истории используется для синхронизации истории чатов в приложении WhatsApp Business для бизнес-клиентов, подключенных поставщиком решений.
message_template_components_update	Веб message_template_components_update уведомляет вас об изменениях в компонентах шаблона.
message_template_quality_update	Веб message_template_quality_update шаблона оценке качества.
message_template_status_update	Веб message_template_status_update уведомляет вас об изменениях статуса существующего шаблона.
сообщения	Веб сообщений описывает сообщения, отправленные пользователем WhatsApp компании, а также статус сообщений, отправленных компанией пользователю WhatsApp.
партнерские_решения	Веб -хук partner_solutions описывает изменения статуса многопартнерского решения.
payment_configuration_update	уведомляет перехватчик payment_configuration_update вас об изменениях в конфигурации платежей для Payments API India и Payments API Brazil.
номер_имя_телефона_обновление	Веб phone_number_name_update уведомляет вас о проверки отображаемого имени .
обновление_качества_телефонного_номера	Веб phone_number_quality_update бизнес-телефонного номера уровня пропускной способности.
безопасность	Веб безопасности уведомляет вас об изменениях в настройках безопасности корпоративного телефонного номера.
smb_app_state_sync	Веб smb_app_state_sync используется для синхронизации контактов пользователей приложения WhatsApp Business, которые были подключены через поставщика решений.
smb_message_echoes	Веб smb_message_echoes уведомляет вас о сообщениях, отправленных через приложение WhatsApp Business или сопутствующее («связанное») устройство бизнес-клиентом, подключенным к Cloud API через поставщика решений.
template_category_update	Веб template_category_update шаблона категории.
пользовательские_настройки	Веб user_preferences пользователем WhatsApp настройках получения маркетинговых сообщений.

вы можете использовать альтернативную конечную точку веб-перехватчика. определенных полей веб-перехватчика Это может быть полезно для целей тестирования или если вы являетесь поставщиком решений и хотите использовать уникальные конечные точки веб-перехватчика для каждого из ваших подключенных клиентов.

ознакомьтесь с нашим веб-хуки, Чтобы узнать, как переопределять

Размер полезной нагрузки веб-хука может достигать 3 МБ.

Если мы отправим запрос веб-хука на вашу конечную точку, и ваш сервер ответит кодом состояния HTTP, отличным от 200, или если мы не сможем доставить веб-хук по другой причине, мы будем продолжать попытки с уменьшающейся частотой до тех пор, пока запрос не будет успешно выполнен, в течение до 7 дней.

Обратите внимание, что повторные попытки будут отправлены всем приложениям, подписанным на веб-хуки (и соответствующие поля) для бизнес-аккаунта WhatsApp. Это может привести к дублированию уведомлений веб-хуков.

см. в документе Graph API, посвященном mTLS для веб-хуков Инструкции по включению и использованию mTLS

IP-адреса наших веб-серверов можно получить, выполнив в терминале следующую команду:

whois -ч кто.радб.сеть —'-i происхождение AS32934'| grep '^route'| awk '{print $2}'| сортировать

Вы также можете использовать нашу геолокационную ленту, чтобы загрузить CSV-файлсо списком наших IP-адресов.

Однако обратите внимание, что мы периодически меняем наши IP-адреса, поэтому, чтобы избежать необходимости повторного формирования списка разрешенных IP-адресов, мы рекомендуем использовать mTLS.

Если вы не получаете веб-хуки: