Справочник по веб-перехватчикам текстовых сообщений | Документация для разработчиков
Справочник по веб-перехватчикам текстовых сообщений
Обновлено: 27 октября 2025 г
сообщений бизнес-аккаунта WhatsApp для сообщений, содержащих только текст.
Триггеры
Синтаксис
{ "object": "whatsapp_business_account", "entry": [ { "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID> ", "изменения": [ { "значение": { "messaging_product": "whatsapp", "метаданные": { "отображаемый_номер_телефона": "<BUSINESS_DISPLAY_PHONE_NUMBER> ", "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID> " }, "контакты": [ { "профиль": { "имя": "<WHATSAPP_USER_PROFILE_NAME> " }, "wa_id": "<WHATSAPP_USER_ID> ", "identity_key_hash": "<IDENTITY_KEY_HASH> "<!-- only included if identity change check enabled --> } ], "сообщения": [ { "из": "<WHATSAPP_USER_PHONE_NUMBER> ", "идентификатор": "<WHATSAPP_MESSAGE_ID> ", "временная метка": "<WEBHOOK_TRIGGER_TIMESTAMP> ", "type": "text", "text": { "body": "<MESSAGE_TEXT_BODY> " },<!-- only if message originated from a "Message business" button --> "контекст": { "из": "<BUSINESS_DISPLAY_PHONE_NUMBER> ", "идентификатор": "<CONTEXTUAL_WHATSAPP_MESSAGE_ID> ", "referred_product": { "catalog_id": "<PRODUCT_CATALOG_ID> ", "product_retailer_id": "<PRODUCT_ID> " } },<!-- only if message forwarded to business by a user --> "контекст": { "переслано": true,<!-- only included if forwarded 5 times or less --> "frequently_forwarded": true<!-- only included if forwarded more than 5 times --> },<!-- only included if message sent via a Click to WhatsApp ad --> "referral": { "source_url": "<AD_URL> ", "source_id": "<AD_ID> ", "source_type": "ad", "body": "<AD_PRIMARY_TEXT> ", "заголовок": "<AD_HEADLINE> ", "media_type": "<AD_MEDIA_TYPE> ", "image_url": "<AD_IMAGE_URL> ", "video_url": "<AD_VIDEO_URL> ", "thumbnail_url": "<AD_VIDEO_THUMBNAIL> ", "ctwa_clid": "<AD_CLICK_ID> ",<!-- omitted if message sent via a WhatsApp Status ad placement --> "welcome_message": { "text": "<AD_GREETING_TEXT> " } } } ] }, "field": "messages" } ] } ] }Параметры
| Заполнитель | Описание | Пример значения |
|---|---|---|
<AD_CLICK_ID>Нить | Идентификатор клика по рекламе в WhatsApp. Свойство ctwa_clid полностью опускается для сообщений, исходящих от рекламы в статусе WhatsApp ( размещение рекламы в статусе WhatsApp ) . | |
<AD_GREETING_TEXT>Нить | Нажмите, чтобы открыть приветственное сообщение в WhatsApp. | Здравствуйте! Дайте нам знать, чем мы можем вам помочь! |
<AD_HEADLINE>Нить | Нажмите, чтобы открыть заголовок рекламного объявления WhatsApp. | Пообщайтесь с нами |
<AD_ID>Нить | Нажмите, чтобы открыть рекламный ID WhatsApp. | 120226305854810726 |
<AD_IMAGE_URL>Нить | Нажмите, чтобы перейти по ссылке на изображение в рекламе WhatsApp. Эта ссылка отображается только в том случае, если это графическая реклама. | https://scontent.xx.fbcdn.net/v/t45.1... |
<AD_MEDIA_TYPE>Нить | Тип медиафайла для рекламы в WhatsApp: Click to ad. Возможные значения: image — Обозначает рекламное изображение.видео — Обозначает видеорекламу. | изображение |
<AD_PRIMARY_TEXT>Нить | Нажмите, чтобы открыть основной текст объявления в WhatsApp. | Летние суккуленты уже здесь! |
<AD_URL>Нить | Перейдите по ссылке, чтобы перейти к рекламному объявлению в WhatsApp. | https://fb.me/3cr4Wqqkv |
<AD_VIDEO_THUMBNAIL>Нить | Нажмите, чтобы перейти по ссылке на миниатюру рекламного видео WhatsApp. Эта ссылка отображается только в том случае, если это видеореклама. | https://scontent.xx.fbcdn.net/v/t45.3... |
<AD_VIDEO_URL>Нить | Нажмите, чтобы перейти по ссылке на видеоролик в рекламе WhatsApp. Эта ссылка отображается только в том случае, если реклама является видеорекламой. | https://scontent.xx.fbcdn.net/v/t45.2... |
<BUSINESS_DISPLAY_PHONE_NUMBER>Нить | Номер телефона компании, отображаемый на экране. | 15550783881 |
<BUSINESS_PHONE_NUMBER_ID>Нить | Идентификатор номера служебного телефона. | 106540352242922 |
<CONTEXTUAL_WHATSAPP_MESSAGE_ID>Нить | Идентификатор сообщения WhatsApp, которое пользователь WhatsApp использовал для доступа к кнопке «Сообщение бизнесу». | wamid.HBgLMTY1MDM4Nzk0MzkVAgARGA9wcm9kdWN0X2lucXVpcnkA |
<IDENTITY_KEY_HASH>Нить | Хэш ключа идентификации. Включается только в том случае, если включена проверки изменений идентификатора . | DF2lS5v2W6x= |
<MESSAGE_TEXT_BODY>Нить | Текст сообщения. | Доступен ли он в другом цвете? |
<PRODUCT_CATALOG_ID>Нить | 194836987003835 | |
<PRODUCT_ID>Нить | di9ozbzfi4 | |
<WEBHOOK_TRIGGER_TIMESTAMP>Нить | Временная метка Unix, указывающая на момент срабатывания веб-перехватчика. | 1739321024 |
<WHATSAPP_BUSINESS_ACCOUNT_ID>Нить | Идентификатор бизнес-аккаунта WhatsApp. | 102290129340398 |
<WHATSAPP_MESSAGE_ID>Нить | Идентификатор сообщения WhatsApp. | wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA= |
<WHATSAPP_USER_ID>Нить | Идентификатор пользователя WhatsApp. Обратите внимание, что идентификатор пользователя WhatsApp и номер телефона могут не всегда совпадать. | 16505551234 |
<WHATSAPP_USER_PHONE_NUMBER>Нить | Номер телефона пользователя WhatsApp. Это то же значение, которое возвращает API в качестве входного значения при отправке сообщения пользователю WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp могут не всегда совпадать. | +16505551234 |
<WHATSAPP_USER_PROFILE_NAME>Нить | Имя пользователя WhatsApp, как оно отображается в его профиле в клиенте WhatsApp. | Шина Нельсон |
Примеры
Текстовое сообщение
В этом примере описывается текстовое сообщение, отправленное пользователем WhatsApp (пользователь просто ввел текст в поле чата и отправил его).
{ "object": "whatsapp_business_account", "entry": [ { "id": "102290129340398", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Sheena Nelson" }, "wa_id": "16505551234" } ], "messages": [ { "from": "16505551234", "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTAzODEwMTQ0RgA=", "timestamp": "1749416383", "type": "text", "text": { "body": "Есть ли он в другом цвете?" } } ] }, "field": "messages" } ] } ] }Кнопка «Сообщение компании»
В этом примере описывается текстовое сообщение, отправленное пользователем WhatsApp, который использовал Отправить сообщение компании» при просмотре отдельного товара
{ "object": "whatsapp_business_account", "entry": [ { "id": "419561257915477", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Sheena Nelson" }, "wa_id": "16505551234" } ], "messages": [ { "context": { "from": "15550783881", "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGA9wcm9kdWN0X2lucXVpcnkA", "referred_product": { "catalog_id": "194836987003835", "product_retailer_id": "di9ozbzfi4" } }, "from": "16505551234", "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTA2NTUwRkNEMDdFQjJCRUU0NQA=", "timestamp": "1750016800", "text": { "body": "Этот товар еще доступен?" }, "type": "text" } ] }, "field": "messages" } ] } ] }Нажмите, чтобы перейти к рекламе в WhatsApp
В этом примере описывается текстовое сообщение, отправленное пользователем WhatsApp, который нажал на рекламное объявление «Click to WhatsApp » и отправил сгенерированное сообщение компании.
Обратите внимание, что для сообщений, исходящих от рекламы в статусе WhatsApp ( размещение рекламы в статусе WhatsApp ) , свойство
referral.ctwa_clid полностью отсутствует.{ "object": "whatsapp_business_account", "entry": [ { "id": "102290129340398", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Sheena Nelson" }, "wa_id": "16505551234" } ], "messages": [ { "referral": { "source_url": "https://fb.me/3cr4Wqqkv", "source_id": "120226305854810726", "source_type": "ad", "body": "Summer Суккуленты уже здесь!", "заголовок": "Пообщайтесь с нами", "media_type": "image", "image_url": "https://scontent.xx.fbcdn.net/v/t45.1...", "ctwa_clid": "Aff-n8ZTODiE79d22KtAwQKj9e_mIEOOj27vDVwFjN80dp4_0NiNhEgpGo0AhemvuSoifXaytfTzcchptiErTKCqTrJ5nW1h7IHYeYymGb5K5J5iTROpBhWAGaIAeUzHL50", "welcome_message": { "text": "Привет! Дайте нам знать, чем мы можем вам помочь!" } }, "from": "16505551234", "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUQ0N0VFMDA2MTQ0RkJFNkNDNAA=", "timestamp": "1750275992", "text": { "body": "Могу ли я получить больше информации об этом?" }, "type": "text" } ] }, "field": "messages" } ] } ] }