messages
Этот обратный вызов выполняется, когда вашей Странице отправляют сообщение. Сообщения всегда отправляются по очереди. Можно получать текстовые сообщения и сообщения с вложениями.
Основные поддерживаемые типы вложений: image
, audio
, video
, file
, reel
и ig_reel
. Также можно получать вложения типа fallback
. Обычно такие вложения отправляются, когда пользователь делится со страницей URL-адресом: при этом создается вложение по принципам отправки ссылок. Если отправлено вложение неподдерживаемого типа, вы можете получить fallback
с пустым значением.
Чтобы подписаться на этот обратный вызов, выберите поле message
при настройке Webhooks.
{ "sender":{ "id":"<PSID>" }, "recipient":{ "id":"<PAGE_ID>" }, "timestamp":1458692752478, "message":{ "mid":"mid.1457764197618:41d102a3e1ae206a38", "text":"hello, world!", "quick_reply": { "payload": "<DEVELOPER_DEFINED_PAYLOAD>" } } }
{ "sender":{ "id":"<PSID>" }, "recipient":{ "id":"<PAGE_ID>" }, "timestamp":1458692752478, "message":{ "mid":"m_1457764197618:41d102a3e1ae206a38", "text":"hello, world!", "reply_to": { "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU" } } }
{
"id": "682498302938465",
"time": 1518479195594,
"messaging": [
{
"sender": {
"id": "
Webhooks для сообщений с шаблоном товара доступны только в Graph API начиная с версии 8.0.
Этот объект Webhooks действует, когда пользователь делится со Страницей товаром из другой переписки или диалога публикации. Он доступен только для товаров, которые принадлежат Странице. Чтобы приложение могло получать информацию о товаре в вызовах Webhooks, для него должно быть одобрено разрешение catalog_management
.
{
"id": "682498302938465",
"time": 1518479195594,
"messaging": [
{
"sender": {
"id": "
Пример подходит для messages
в Graph API начиная с версии 6.0.
{ "object": "page", "entry": [ { "id": "<PAGE_ID>", "time": 1583173667623, "messaging": [ { "sender": { "id": "<PSID>" }, "recipient": { "id": "<PAGE_ID>" }, "timestamp": 1583173666767, "message": { "mid": "m_toDnmD...", "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg", "attachments": [ { "type": "fallback", "payload": { "url": "<ATTACHMENT_URL >", "title": "TAHITI - Heaven on Earth" } } ] } } ] } ] }
Webhooks для сообщения со страницы сведений о товаре в Магазине доступны только в Graph API начиная с версии 8.0.
{ "sender":{ "id":"<PSID>" }, "recipient":{ "id":"<PAGE_ID>" }, "timestamp":1458692752478, "message":{ "mid":"mid.1457764197618:41d102a3e1ae206a38", "text":"hello, world!", "referral": { "product": { "id":"<PRODUCT_ID>" } } } }
Этот Webhooks относится к сценарию, когда пользователь нажимает рекламу с переходом в Messenger и отправляет сообщение странице Facebook. Помимо сведений о сообщении, приложение получит информацию о реферале рекламы.
Для использования сообщений с информацией о реферале рекламы у приложения должны быть подписки страницы на поля messages
и messaging_referrals
.
{ "sender":{ "id":"<PSID>" }, "recipient":{ "id":"<PAGE_ID>" }, "timestamp":1458692752478, "message":{ "mid":"mid.1457764197618:41d102a3e1ae206a38", "text":"hello, world!", "referral": { "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>", "ad_id": "<ID_OF_THE_AD>", "source": "ADS", "type": "OPEN_THREAD", "ads_context_data": { "ad_title": "<TITLE_OF_THE_AD>", "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>", "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>", "post_id": "<ID_OF_THE_POST>", "product_id": "<PRODUCT_ID>" } } } }
{ "object": "page", "entry": [ { "id": "<PAGE_ID>", "time": 1697643211842, "messaging": [ { "sender": { "id": "<PSID>" }, "recipient": { "id": "<PAGE_ID>" }, "timestamp": 1697643027400, "message": { "mid": "m_3vs...", "text": "find flights from SFO to LAX next Thursday", "commands": [ { "name": "flights" } ] } } ] } ] }
sender
Свойство | Тип | Описание |
---|---|---|
| строка | PSID пользователя, который запустил событие Webhook. |
| Строка | user_ref пользователя, который запустил событие Webhook. Доступно только для события Webhook плагина чата. |
recipient
Свойство | Тип | Описание |
---|---|---|
| строка | ID вашей Страницы. |
message
Начиная с версии 6.0 параметр sticker_id
переносится из message
в message.attachments.payload
.
Свойство | Тип | Описание |
---|---|---|
| Строка | ID сообщения. |
| Строка | Текст сообщения. |
| Объект | Дополнительные пользовательские данные, предоставленные приложением-отправителем. |
| Объект | Ссылка на ID сообщения (mid), ответом на которое является текущее сообщение. |
| Массив < | Массив, содержащий данные вложения. |
| Объект | Ссылка на сообщение со страницы сведений о товаре в Магазине. |
message.quick_reply
Полезная нагрузка quick_reply
отправляется в текстовом сообщении, только когда пользователь нажимает кнопку Быстрый ответ.
Свойство | Тип | Описание |
---|---|---|
| Строка | Пользовательские данные, предоставленные приложением. |
message.reply_to
Свойство | Тип | Описание |
---|---|---|
| Строка | Ссылка на ID сообщения, ответом на которое является текущее сообщение. |
message.attachments
Свойство | Тип | Описание |
---|---|---|
| Строка |
|
| Строка |
message.attachments.payload
Свойство | Тип | Описание |
---|---|---|
| Строка | URL типа вложения. Для вложений типа |
| Строка | Заголовок вложения. Для вложений типа |
| Число | Постоянный ID стикера. Например, |
| Число | ID видео, связанного с прикрепляемым видео Reels. Для вложений типа |
message.attachments.payload.product.elements
Свойство | Тип | Описание |
---|---|---|
| Строка | ID товара из каталога товаров Facebook. |
| Строка | Внешний ID, связанный с товаром (например, SKU или ID контента) |
| Строка | URL изображения товара. |
| Строка | Название товара |
| Строка | Подзаголовок товара. |
message.referral
Полезная нагрузка referral
добавляется, только когда пользователь отправляет сообщение со страницы сведений о товаре в Магазине.
Свойство | Тип | Описание |
---|---|---|
| Объект | Информация о товаре. |
| Строка | Источник этого реферала. Поддерживаемые значения: |
| Строка | Тип реферала. В настоящий момент поддерживается |
| Строка | Свойство |
| Строка | ID объявления из Ads Manager. |
| Объект | Данные контекста объявления из Ads Manager. |
message.referral.product
Свойство | Тип | Описание |
---|---|---|
| Строка | ID товара. |
message.referral.ads_context_data
Свойство | Тип | Описание |
---|---|---|
| Строка | Заголовок объявления в Ads Manager. |
| Строка | [Необязательно] URL изображения из объявления. |
| Строка | [Необязательно] URL миниатюры видео из объявления. |
| Строка | ID публикации с объявлением в Ads Manager. |
| Строка | [Необязательно] ID товара из объявления. |
message.commands
Свойство | Тип | Описание |
---|---|---|
| Строка | Имя команды. |