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

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

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

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

Триггеры

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

    Синтаксис

    Примечание что многие свойства объекта контакта могут быть опущены, если пользователь WhatsApp решит не делиться ими или если его устройство не позволяет ими поделиться.
    {
      "object": "whatsapp_business_account",
      "вход": [
        {
          "идентификатор": "<Идентификатор бизнес-аккаунта WhatsApp>",
          "изменения": [
            {
              "ценить": {
                "messaging_product": "whatsapp",
                "метаданные": {
                  "display_phone_number": "<НОМЕР ТЕЛЕФОНА ДЛЯ ОТОБРАЖЕНИЯ НА ТЕЛЕФОНЕ>",
                  "phone_number_id": "<Идентификатор номера бизнес-телефона>"
                },
                "контакты": [
                  {
                    "профиль": {
                      "имя": "<ИМЯ_ПОЛЬЗОВАТЕЛЯ_WHATSAPP>"
                    },
                    "wa_id": "<Идентификатор_пользователя_WhatsApp>",
                    "identity_key_hash": "<IDENTITY_KEY_HASH><!-- only included if identity change check enableд -->
                  }
                ],
                "сообщения": [
                  {
                    "от": "<Номер телефона пользователя WhatsApp>",
                    "идентификатор": "<Идентификатор сообщения WhatsApp>",
                    "временная метка": "<WEBHOOK_TRIGGER_TIMESTAMP>",
                    "тип": "контакты",
                    "контакты": [
                      {
                        "адреса": [
                          {
                            "город": "<КОНТАКТНЫЙ ГОРОД>",
                            "страна": "<КОНТАКТНАЯ СТРАНА>",
                            "country_code": "<КОНТАКТНЫЙ_КОД_СТРАНЫ>",
                            "состояние": "<КОНТАКТНОЕ_СОСТОЯНИЕ>",
                            "улица": "<CONTACT_STREET>",
                            "тип": "<ТИП КОНТАКТНОГО_АДРЕСА>",
                            "zip": "<КОНТАКТНЫЙ_ZIP>"
                          }
                        ],
                        "день рождения": "<КОНТАКТНЫЙ_ДЕНЬ РОЖДЕНИЯ>",
                        "электронные письма": [
                          {
                            "электронная почта": "<КОНТАКТНЫЙ_EMAIL>",
                            "тип": "<ТИП_ЭЛЕКТРОННОЙ ПОЧТЫ_КОНТАКТА>"
                          }
                        ],
                        "имя": {
                          "formatted_name": "<КОНТАКТНОЕ_ИМЯ_В_ФОРМАТИРОВАННОМ_ФОРМАТЕ>",
                          "имя": "<КОНТАКТНОЕ_ИМЯ>",
                          "фамилия": "<ФАМИЛИЯ_КОНТАКТА>",
                          "второе имя": "<ОТЧЕСТВО_КОНТАКТНОГО_ПУНКТА>",
                          "суффикс": "<КОНТАКТНОЕ_ИМЯ_СУФФИКС>",
                          "префикс": "<CONTACT_NAME_PREFIX>"
                        },
                        "org": {
                          "компания": "<CONTACT_ORG_COMPANY>",
                          "отделение": "<КОНТАКТНЫЙ_ОРГ_ОТДЕЛ>",
                          "заголовок": "<CONTACT_ORG_TITLE>"
                        },
                        "телефоны": [
                          {
                            "телефон": "<КОНТАКТНЫЙ_ТЕЛЕФОН>",
                            "wa_id": "<КОНТАКТНЫЙ НОМЕР ТЕЛЕФОНА В WHATSAPP>",
                            "тип": "<КОНТАКТНЫЙ_ТИП_ТЕЛЕФОНА>"
                          }
                        ],
                        "urls": [
                          {
                            "url": "<КОНТАКТНЫЙ_URL>",
                            "тип": "<CONTACT_URL_TYPE>"
                          }
                        ]
                      }
                    ],

    <!-- only included if message sent via a Click to Реклама WhatsApp -->
                    "реферал": {
                      "source_url": "<AD_URL>",
                      "source_id": "<AD_ID>",
                      "source_type": "ad",
                      "тело": "<AD_PRIMARY_TEXT>",
                      "заголовок": "<ЗАГОЛОВОК РЕКЛАМЫ>",
                      "media_type": "<AD_MEDIA_TYPE>",
                      "image_url": "<AD_IMAGE_URL>",
                      "video_url": "<AD_VIDEO_URL>",
                      "thumbnail_url": "<ПРЕВЬЮ РЕКЛАМНОГО ВИДЕО>",
                      "ctwa_clid": "<AD_CLICK_ID>",
                      "welcome_message": {
                        "текст": "<AD_GREETING_TEXT>"
                      }
                    }
                  }
                ]
              },
              "поле": "сообщения"
            }
          ]
        }
      ]
    }

    Параметры

    Заполнитель Описание Пример значения
    <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. Возможные значения:
    изображение - Обозначает рекламное изображение.
    видео - Обозначает видеоролик.
    изображение
    <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.
    Шина Нельсон

    Пример

    {
    "объект""whatsapp_business_account",
    "вход": [
        {
    "идентификатор""102290129340398",
    "изменения": [
            {
    "ценить": {
    "messaging_product""WhatsApp",
    "метаданные": {
    "display_phone_number""15550783881",
    "идентификатор_номера_телефона""106540352242922"
                },
    "контакты": [
                  {
    "профиль": {
    "имя"«Шина Нельсон»
                    },
    "ва_ид""16505551234"
                  }
                ],
    "сообщения": [
                  {
    "от""16505551234",
    "идентификатор""wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTAzODEwMTQ0RgA=",
    "временная метка""1744344496",
    "тип""контакты",
    "контакты": [
                      {
    "имя": {
    "имя""Барбара",
    "фамилия""Джонсон",
    "formatted_name""Барбара Дж. Джонсон"
                        },
    "org": {
    "компания"«Социальное цунами»
                        },
    "телефоны": [
                          {
    "телефон""+1 (415) 555-0829",
    "ва_ид""14125550829",
    "тип""МОБИЛЬНЫЙ"
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
    "поле""сообщения"
            }
          ]
        }
      ]
    }