Перейти к основному содержимому

Справочник по веб-перехватчикам сообщений контактов | Документация для разработчиков

Справочник веб-перехватчика для сообщений контактов

Обновлено: 22 октября 2025 г
сообщений бизнес-аккаунта WhatsApp для сообщений, содержащих один или несколько контактов.

Триггеры

    Пользователь WhatsApp отправляет сообщения одному или нескольким контактам компании.Пользователь WhatsApp отправляет один или несколько контактов в компанию через рекламное объявление, нажав на кнопку «Написать в WhatsApp».

    Синтаксис

    Обратите внимание, что многие свойства объекта контакта могут быть опущены, если пользователь WhatsApp решит не делиться ими или если его устройство не позволяет это сделать.
    {
    "object": "whatsapp_business_account",
    "entry": [
    {
    "id": "
    < WHATSAPP_BUSINESS_ACCOUNT_ID > ", "changes": [
    {
    "value": {
    "messaging_product": "whatsapp",
    "metadata": {
    "display_phone_number": "
    < BUSINESS_DISPLAY_PHONE_NUMBER > ", "phone_number_id": "
    < BUSINESS_PHONE_NUMBER_ID > " },
    "contacts": [
    {
    "profile": {
    "name": "
    < WHATSAPP_USER_PROFILE_NAME > " },
    "wa_id": "
    < WHATSAPP_USER_ID > ", "identity_key_hash": "
    < IDENTITY_KEY_HASH > " d --> }
    ],
    "сообщения": [
    {
    "от": "
    < WHATSAPP_USER_PHONE_NUMBER > ", "id": "
    < WHATSAPP_MESSAGE_ID > ", "timestamp": "
    < WEBHOOK_TRIGGER_TIMESTAMP > ", "type": "контакты",
    "контакты": [
    {
    "адреса": [
    {
    "город": "
    < CONTACT_CITY > ", "страна": "
    < CONTACT_COUNTRY > ", "country_code": "
    < CONTACT_COUNTRY_CODE > ", "штат": "
    < CONTACT_STATE > ", "улица": "
    < CONTACT_STREET > ", "type": "
    < CONTACT_ADDRESS_TYPE > ", "zip": "
    < CONTACT_ZIP > " }
    ],
    "день рождения": "
    < CONTACT_BIRTHDAY > ", "электронная почта": [
    {
    "электронная почта": "
    < CONTACT_EMAIL > ", "type": "
    < CONTACT_EMAIL_TYPE > " }
    ],
    "name": {
    "formatted_name": "
    < CONTACT_FORMATTED_NAME > ", "first_name": "
    < CONTACT_FIRST_NAME > ", "last_name": "
    < CONTACT_LAST_NAME > ", "middle_name": "
    < CONTACT_MIDDLE_NAME > ", "suffix": "
    < CONTACT_NAME_SUFFIX > ", "prefix": "
    < CONTACT_NAME_PREFIX > " },
    "org": {
    "company": "
    < CONTACT_ORG_COMPANY > ", "department": "
    < CONTACT_ORG_DEPARTMENT > ", "title": "
    < CONTACT_ORG_TITLE > " },
    "phones": [
    {
    "phone": "
    < CONTACT_PHONE > ", "wa_id": "
    < CONTACT_WHATSAPP_PHONE_NUMBER > ", "type": "
    < CONTACT_PHONE_TYPE > " }
    ],
    "urls": [
    {
    "url": "
    < CONTACT_URL > ", "type": "
    < CONTACT_URL_TYPE > " }
    ]
    }
    ],

    WhatsApp ad --> "referral": {
    "source_url": "
    < AD_URL > ", "source_id": "
    < AD_ID > ", "source_type": "ad",
    "body": "
    < AD_PRIMARY_TEXT > ", "headline": "
    < 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 > ", "welcome_message": {
    "text": "
    < AD_GREETING_TEXT > " }
    }
    }
    ]
    },
    "field": "messages"
    }
    ]
    }
    ]
    }

    Параметры

    Заполнитель Описание Пример значения
    <AD_CLICK_ID>
    Нить
    Идентификатор клика по рекламе в WhatsApp.
    Свойство ctwa_clid полностью опускается для сообщений, исходящих от рекламы в статусе WhatsApp ( размещение рекламы в статусе WhatsApp ) .
    Aff-n8ZTODiE79d22KtAwQKj9e_mIEOOj27vDVwFjN80dp4_0NiNhEgpGo0AhemvuSoifXaytfTzcchptiErTKCqTrJ5nW1h7IHYeYymGb5K5J5iTROpBhWAGaIAeUzHL50
    <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
    <CONTACT_ADDRESS_TYPE>
    Нить
    Тип адреса, например, домашний или рабочий.
    Домашняя страница
    <CONTACT_BIRTHDAY>
    Нить
    Дата рождения контактного лица.
    1999-01-23
    <CONTACT_CITY>
    Нить
    Город указан в контактном адресе.
    Менло-Парк
    <CONTACT_COUNTRY_CODE>
    Нить
    Код страны по стандарту ISO указан в контактном адресе.
    НАС
    <CONTACT_COUNTRY>
    Нить
    Страна, указанная в контактном адресе.
    Соединенные Штаты
    <CONTACT_EMAIL_TYPE>
    Нить
    Тип электронной почты, например, личная или рабочая.
    Личное
    <CONTACT_EMAIL>
    Нить
    Адрес электронной почты контактного лица.
    <CONTACT_FIRST_NAME>
    Нить
    Имя контактного лица.
    Барбара
    <CONTACT_FORMATTED_NAME>
    Нить
    Отформатированное имя контакта.
    Барбара Дж. Джонсон
    <CONTACT_LAST_NAME>
    Нить
    Фамилия контактного лица.
    Джонсон
    <CONTACT_MIDDLE_NAME>
    Нить
    Второе имя Контакта.
    Джоана
    <CONTACT_NAME_PREFIX>
    Нить
    Префикс имени контакта.
    Доктор.
    <CONTACT_NAME_SUFFIX>
    Нить
    Суффикс имени контактного лица.
    Эсквайр.
    <CONTACT_ORG_COMPANY>
    Нить
    Название компании, в которой работает контактное лицо.
    Социальное цунами
    <CONTACT_ORG_DEPARTMENT>
    Нить
    Название отдела, в котором работает контактное лицо.
    Инженерное дело
    <CONTACT_ORG_TITLE>
    Нить
    Должность контактного лица.
    Программист
    <CONTACT_PHONE_TYPE>
    Нить
    Тип телефонного номера. Например, мобильный, основной, iPhone, домашний, рабочий и т. д.
    КЛЕТКА
    <CONTACT_PHONE>
    Нить
    Номер телефона контактного лица.
    +14125550829
    <CONTACT_STATE>
    Нить
    Штат указан в контактном адресе.
    Калифорния
    <CONTACT_STREET>
    Нить
    Улица указана в контактном адресе.
    1. Хакерский путь
    <CONTACT_URL_TYPE>
    Нить
    Тип веб-сайта. Например, корпоративный, рабочий, личный, страница в Facebook, Instagram и т. д.
    Компания
    <CONTACT_URL>
    Нить
    URL-адрес веб-сайта, связанного с контактом или его компанией.
    socialtsunami.com
    <CONTACT_WHATSAPP_PHONE_NUMBER>
    Нить
    Номер WhatsApp для связи.
    14125550829
    <CONTACT_ZIP>
    Нить
    Почтовый индекс указан в контактном адресе.
    94025
    <IDENTITY_KEY_HASH>
    Нить
    Хэш ключа идентификации. Включается только в том случае, если включена проверки изменений идентификатора .
    DF2lS5v2W6x=
    <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.
    Шина Нельсон

    Пример

    {
    "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.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTA zODEwMTQ0RgA=" , "timestamp"
    : "1744344496" , "type"
    : "contacts" , "contacts"
    : [ {
    "name"
    : { "first_name"
    : "Barbara" , "last_name"
    : "Johnson" , "formatted_name"
    : "Barbara J. Johnson" },
    "org"
    : { "company"
    : "Social Tsunami" },
    "phones"
    : [ {
    "phone"
    : "+1 (415) 555-0829" , "wa_id"
    : "14125550829" , "type"
    : "MOBILE" }
    ]
    }
    ]
    }
    ]
    },
    "field"
    : "messages" }
    ]
    }
    ]
    }