Полезная нагрузка входящего веб-хука WhatsApp | Документация для разработчиков
Полезная нагрузка входящего веб-перехватчика WhatsApp
Экземпляр для программы магистратуры (LLM)
Версия
Схемы для входящих уведомлений веб-перехватчика WhatsApp.
Определяет структуру полезной нагрузки для сообщений, обновлений статуса и взаимодействий с пользователем
Отправлено пользователями WhatsApp компаниям через веб-хуки.
POST /whatsapp/webhooks
Конечная точка для приема данных веб-хуков для различных типов входящих сообщений WhatsApp.
Синтаксис запроса
Выберите язык
Необходимый
Тип содержимого: application/json
Схема: WebhookPayload
Показать дочерние атрибуты
WebhookPayload
строковый объект · обязательный
Для этих веб-хуков всегда используйте 'whatsapp_business_account'.
массив записей Entry · обязательный
Показать дочерние атрибуты
запись[]Запись
Показать дочерние атрибуты
строковый идентификатор · обязательный
Идентификатор бизнес-аккаунта WhatsApp.
изменениямассива Change·обязательный
Показать дочерние атрибуты
изменения[]Изменение
Показать дочерние атрибуты
Значениедолжно быть одним из следующих: IncomingMessageValueGeneral, IncomingMessageValueSystem, StatusMessageValue, GroupValue·обязательно
Показать дочерние атрибуты
ВходящееСообщениеЗначениеОбщее
Показать дочерние атрибуты
messaging_productstring·required
Всегда пользуйтесь WhatsApp.
метаданныеМетаданные·обязательны
Показать дочерние атрибуты
display_phone_numberstring·required
Номер телефона компании, отображаемый на экране.
phone_number_idстрока·обязательный
Идентификатор номера служебного телефона.
контактовиз ContactProfile·обязательно
Набор профилей контактов отправителя. Включен для всех входящих сообщений, не поступающих через систему.
Показать дочерние атрибуты
контакты[]Профиль контакта
Показать дочерние атрибуты
объект профиля · обязательный
Показать дочерние атрибуты
строка имени · обязательный
Имя пользователя WhatsApp, как оно отображается в его профиле в клиенте WhatsApp.
строка wa_id
Идентификатор пользователя WhatsApp. Обратите внимание, что идентификатор пользователя WhatsApp и номер телефона могут не всегда совпадать.
массив сообщений IncomingMessage · обязательный
Массив объектов сообщений. Структура зависит от свойства 'type'.
Показать дочерние атрибуты
сообщения[]Входящее сообщение
Показать дочерние атрибуты
Текстовое сообщение
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"текст"·обязательный
текстовыйобъект·обязательный
Показать дочерние атрибуты
строка тела · обязательный
Текст сообщения.
объект контекста
Включается только при отправке сообщения через кнопку "Написать компании".
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона компании, отображаемый на экране.
строковый идентификатор · обязательный
Идентификатор сообщения WhatsApp, которое пользователь использовал для доступа к кнопке «Сообщение для бизнеса».
объект referred_product · обязательный
Показать дочерние атрибуты
catalog_idстрока·обязательный
Идентификатор товара в каталоге.
product_retailer_idстрока·обязательный
Идентификатор продукта.
объект направления
Включено только при отправке сообщения через рекламное объявление Click to WhatsApp.
Показать дочерние атрибуты
строка source_url · обязательный
URL объявления.
строка source_id · обязательный
Идентификатор объявления.
source_typeОдин из "ad", "post"·обязательный
строка тела · обязательный
Основной текст объявления.
заголовокстроки·обязательный
Заголовок объявления.
media_typeОдин из вариантов: "image", "video"·обязательный
строка image_url
Указано только для типа носителя изображения.
строка video_url
Указано только для видео media_type.
thumbnail_urlstring
Указано только для видео media_type.
строка ctwa_clid · обязательный
Идентификатор клика по объявлению.
объект welcome_message
Показать дочерние атрибуты
текстоваястрока·обязательный
Приветственный текст объявления.
Реакция
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"реакция"·требуется
объект реакции · требуется
Показать дочерние атрибуты
message_idстрока·обязательный
Идентификатор сообщения WhatsApp, на которое отреагировал пользователь WhatsApp.
строка эмодзи · обязательный
Эмодзи, отправленный пользователем WhatsApp в качестве реакции.
Аудиосообщение
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"аудио"·обязательный
аудиообъект
Показать дочерние атрибуты
mime_typeстрока·обязательный
MIME-тип медиафайла.
строка sha256 · обязательный
Хэш SHA-256 медиаактива.
строковый идентификатор · обязательный
Идентификатор медиафайла. Запрос GET по этому идентификатору может предоставить URL-адрес медиафайла.
логическое значение голоса · обязательно
Логическое значение, указывающее, является ли аудиозапись сделанной с помощью функции записи голоса в приложении WhatsApp (true) или нет (lave).
ДокументСообщение
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"документ"·обязательный
объект документа
Показать дочерние атрибуты
mime_typeстрока·обязательный
MIME-тип медиафайла.
строка sha256 · обязательный
Хэш SHA-256 медиаактива.
строковый идентификатор · обязательный
Идентификатор медиафайла. Запрос GET по этому идентификатору может предоставить URL-адрес медиафайла.
имя файластрока·обязательный
Имя файла медиафайла.
ImageMessage
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"изображение"·обязательный
объект изображения
Показать дочерние атрибуты
mime_typeстрока·обязательный
MIME-тип медиафайла.
строка sha256 · обязательный
Хэш SHA-256 медиаактива.
строковый идентификатор · обязательный
Идентификатор медиафайла. Запрос GET по этому идентификатору может предоставить URL-адрес медиафайла.
строка подписи
Текст подписи к медиафайлу.
НаклейкаСообщение
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"стикер"·обязательный
наклейкаобъект
Показать дочерние атрибуты
mime_typeстрока·обязательный
MIME-тип медиафайла.
строка sha256 · обязательный
Хэш SHA-256 медиаактива.
строковый идентификатор · обязательный
Идентификатор медиафайла. Запрос GET по этому идентификатору может предоставить URL-адрес медиафайла.
анимированныйлогический параметр·обязательный
Логическое значение, указывающее, является ли стикер анимированным (true) или нет (false).
Видеосообщение
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"видео"·обязательно
видеообъект
Показать дочерние атрибуты
mime_typeстрока·обязательный
MIME-тип медиафайла.
строка sha256 · обязательный
Хэш SHA-256 медиаактива.
строковый идентификатор · обязательный
Идентификатор медиафайла. Запрос GET по этому идентификатору может предоставить URL-адрес медиафайла.
строка подписи
Текст подписи к медиафайлу.
LocationMessage
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"местоположение"·обязательный
Объект местоположения · обязательный
Показать дочерние атрибуты
строка адреса · обязательный
Адрес местоположения.
широты(число с плавающей запятой)·обязательно
Широта местоположения.
долготы(число с плавающей запятой)·обязательно
Долгота местоположения.
строка имени · обязательный
Название местоположения.
строка URL
URL-адрес местоположения. Обычно указывается только для адресов предприятий.
ContactSharingMessage
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"контакты"·обязательный
контактовобъекта ContactObject·обязательно
Массив объектов контактов. Многие свойства объектов контактов могут быть опущены, если пользователь WhatsApp решит не делиться ими или если его устройство не позволяет это сделать.
Показать дочерние атрибуты
контакт[]объект
Показать дочерние атрибуты
адресамассива объектов
Показать дочерние атрибуты
адреса[]объект
Показать дочерние атрибуты
городскаяструна
Город, указанный в контактном адресе
кантриструна
Страна, указанная в контактном адресе
Показать дочерние атрибуты
строка country_code
Код страны по стандарту ISO для контактного адреса
строка состояния
Штат, указанный в контактном адресе
уличнаяструна
Улица, указанная в контактном адресе
типстрока
Тип адреса, например, домашний или рабочий
зиплайн
Почтовый индекс в контактном адресе
дня рождения(дата)
Дата рождения контактного лица (ГГГГ-ММ-ДД).
массив объектов электронных писем
Показать дочерние атрибуты
emails[]объект
Показать дочерние атрибуты
emailstring (email)
Адрес электронной почты контакта
типстрока
Тип электронной почты, например, личная или рабочая
имяобъекта
Показать дочерние атрибуты
formatted_namestring·required
Отформатированное имя контакта
строка имени
Имя контактного лица
строка фамилии
Фамилия контактного лица
строка отчества
Второе имя контакта
суффикснаястрока
Суффикс имени контакта
префикснаястрока
Префикс имени контакта
объект организации
Показать дочерние атрибуты
строка компании
Название компании, в которой работает контактное лицо
строка отдела
Название отдела, в котором работает контактное лицо
строка заголовка
Должность контактного лица
телефоновобъектов
Показать дочерние атрибуты
телефоны[]объект
Показать дочерние атрибуты
телефоннаястрока
Номер телефона контактного лица
строка wa_id
Номер WhatsApp контакта. Обратите внимание, что идентификатор пользователя WhatsApp и номер телефона могут не всегда совпадать.
типстрока
Тип телефонного номера. Например, мобильный, основной, iPhone, домашний, рабочий и т. д.
массив объектов urls
Показать дочерние атрибуты
объект urls[]
Показать дочерние атрибуты
URL(uri)
URL-адрес веб-сайта, связанного с контактом или его компанией
типстрока
Тип веб-сайта. Например, корпоративный, рабочий, личный, страница в Facebook, Instagram и т. д.
UnsupportedMessage
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
типОдин из "неподдерживаемый", "неизвестный"·обязательный
объект контекста · обязательный
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона компании, отображаемый на экране.
строковый идентификатор · обязательный
Идентификатор сообщения WhatsApp, содержащего кнопку, на которую нажал пользователь WhatsApp.
объект кнопки · обязательный
Показать дочерние атрибуты
строка полезной нагрузки · обязательный
Полезная нагрузка кнопки быстрого ответа.
текстоваястрока·обязательный
Текст подписи кнопки быстрого ответа.
ButtonMessage
Интерактивное сообщениеОтвет
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"интерактивный"·обязательный
объект контекста · обязательный
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона компании, отображаемый на экране.
строковый идентификатор · обязательный
Идентификатор сообщения WhatsApp, содержащего интерактивный компонент, на который нажал пользователь.
интерактивныйобъект·обязательный
Показать дочерние атрибуты
Тип:Один из "list_reply", "button_reply"·обязательный
Тип интерактивного ответа (ответ в списке или ответ с помощью кнопки).
OrderMessage
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"заказ"·обязательный
объект заказа · обязательный
Показать дочерние атрибуты
catalog_idстрока·обязательный
Идентификатор товара в каталоге.
текстоваястрока·обязательный
Пустая строка.
массив объектов product_items · обязательный
Показать дочерние атрибуты
объект product_items[]
Показать дочерние атрибуты
product_retailer_idстрока·обязательный
Идентификатор продукта.
количествоцелое число·требуемое
Количество товара.
item_priceчисло (float)·обязательно
Цена за единицу товара.
строка валюты · обязательный
Код валюты каталога.
IncomingMessageValueSystem
Показать дочерние атрибуты
messaging_productstring·required
Всегда пользуйтесь WhatsApp.
метаданныеМетаданные·обязательны
Показать дочерние атрибуты
display_phone_numberstring·required
Номер телефона компании, отображаемый на экране.
phone_number_idстрока·обязательный
Идентификатор номера служебного телефона.
массив сообщений SystemMessage · обязательный
Массив, содержащий только объекты сообщений типа 'system'.
Показать дочерние атрибуты
сообщения[]Системное сообщение
Показать дочерние атрибуты
изстроки·обязательный
Номер телефона пользователя WhatsApp. Обратите внимание, что номер телефона и идентификатор пользователя WhatsApp не всегда могут совпадать.
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp.
строка метки времени · обязательно
Временная метка Unix, указывающая на момент срабатывания веб-перехватчика.
тип"система"·обязательный
системныйобъект·обязательный
Показать дочерние атрибуты
строка тела · обязательный
Описание изменения в системе (например, пользователь изменил номер).
строка wa_id
Новый идентификатор пользователя WhatsApp.
тип"user_changed_number"·обязательный
Тип системного сообщения.
неизвестно
StatusMessageValue
Показать дочерние атрибуты
messaging_productstring·required
Всегда пользуйтесь WhatsApp.
метаданныеМетаданные·обязательны
Показать дочерние атрибуты
display_phone_numberstring·required
Номер телефона компании, отображаемый на экране.
phone_number_idстрока·обязательный
Идентификатор номера служебного телефона.
массив статусов · обязательный
Массив объектов состояния.
Показать дочерние атрибуты
статусы[]Статусы
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор сообщения WhatsApp, с которым связан данный статус.
статусОдин из "отправлено", "доставлено", "прочитано", "не удалось"·требуется
строка метки времени · обязательно
recipient_idstring·required
Номер телефона получателя.
group_idстрока
Идентификатор группы, если сообщение было отправлено группе.
разговорРазговор
Показать дочерние атрибуты
строка идентификатора
строка expiration_timestamp
происхождениеразговораПроисхождение
Показать дочерние атрибуты
типстрока
ценообразованиеЦены
Показать дочерние атрибуты
оплачиваемыйлогический
pricing_modelОдин из "CBP", "PMP"
строка категории
ошибокStatusError
Показать дочерние атрибуты
ошибки[]StatusError
Показать дочерние атрибуты
кодцелое число
строка заголовка
строка сообщения
error_dataErrorData
Показать дочерние атрибуты
строка подробностей
hrefstring
GroupValue
Показать дочерние атрибуты
messaging_productstring·required
Всегда пользуйтесь WhatsApp.
метаданныеМетаданные·обязательны
Показать дочерние атрибуты
display_phone_numberstring·required
Номер телефона компании, отображаемый на экране.
phone_number_idстрока·обязательный
Идентификатор номера служебного телефона.
массив групп · обязательный
Массив групповых объектов.
Показать дочерние атрибуты
группы[]Группы
Показать дочерние атрибуты
метка временицелое число·обязательно
Unix-метка времени группового события
group_idстрока·обязательный
Уникальный идентификатор для группы
Тип:Один из "group_create", "group_delete", "group_settings_update", "group_add_participants", "group_remove_participants"·обязательный
Тип группового мероприятия
request_idстрока·обязательный
Уникальный идентификатор запроса
строка темы
Группа по предмету/название
строка описания
Описание группы
added_participantsиз GroupParticipant
Список участников, добавленных в группу
Показать дочерние атрибуты
добавленные_участники[]ГруппаУчастник
Показать дочерние атрибуты
входнаястрока
Введите номер телефона или идентификатор WhatsApp
строка wa_id
WhatsApp ID участника
removed_participantsиз GroupParticipant
Список участников, исключенных из группы
Показать дочерние атрибуты
удаленные участники[]Группа участников
Показать дочерние атрибуты
входнаястрока
Введите номер телефона или идентификатор WhatsApp
строка wa_id
WhatsApp ID участника
profile_pictureGroupProfilePicture
Показать дочерние атрибуты
mime_typestring
MIME-тип изображения профиля
строка sha256
Хэш SHA256 изображения профиля
Поле:Один из "messages", "group_lifecycle_update", "group_settings_update", "group_participant_update"·обязательное поле
В этом поле указывается, к какому объекту относится веб-перехватчик:
Сообщения: веб-хук связан с сообщениями от потребителя или со статусом сообщения, отправленного компанией потребителю.
group_lifecycle_update: веб-хук связан с созданием и удалением групп.
group_settings_update: веб-хук связан с обновлением настроек группы.
group_participant_update: веб-хук связан с присоединением и выходом участников из групп.
Ответы
Конечная точка для приема данных веб-хуков для различных типов входящих сообщений WhatsApp.
200
Веб-перехватчик успешно получен
Выберите язык
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют