Входящее текстовое сообщение с URL#
В данном разделе описывается формат входящего уведомления объекта messageData
для входящего текстового сообщения или сообщения с URL. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.
Для получения входящих уведомлений данного вида требуется выполнение двух условий:
typeWebhook
= incomingMessageReceived
messageData.typeMessage
= extendedTextMessage
Настройка инстанса
Чтобы получать входящие уведомления о входящих сообщениях с URL или рекламных сообщениях, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления о входящих сообщениях и файлах
-
Через метод SetSettings включить настройку
incomingWebhook
Уведомление#
Формат уведомления#
Поля объекта messageData
Параметр | Тип | Описание |
---|---|---|
typeMessage | string | Тип полученного сообщения. Для сообщений данного типа поле принимает значение extendedTextMessage |
extendedTextMessageData | object | Объект данных о принятом текстовом сообщении или URL ссылки |
quotedMessage | object | Объект данных о цитируемом сообщении. Присутствует, только если само сообщение является цитатой |
Поля объекта extendedTextMessageData
Параметр | Тип | Описание |
---|---|---|
text | string | Текст ссылки или обычный текст |
description | string | Описание ссылки, может быть пустым |
title | string | Заголовок ссылки, может быть пустым |
jpegThumbnail | string | Превью изображения в base64 кодировке, может отсутствовать |
isForwarded | boolean | Является ли сообщение пересланным, принимает значения true /false |
forwardingScore | integer | Количество пересылок сообщения |
Поля объекта quotedMessage
Параметр | Тип | Описание |
---|---|---|
stanzaId | string | id цитируемого сообщения |
participant | string | id отправителя цитируемого собщения |
Пример тела уведомления#
{
"typeWebhook": "incomingMessageReceived",
"instanceData": {
"idInstance": 3100000000,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1588091580,
"idMessage": "115206687571465794",
"senderData": {
"chatId": "10000000",
"sender": "10000000",
"chatName": "Ходабрыш Пробешёлов",
"senderName": "Ходабрыш Пробешёлов",
"senderContactName": "Ходабрыш Пробешёлов"
},
"messageData": {
"typeMessage": "extendedTextMessage",
"extendedTextMessageData": {
"text": "Я использую GREEN-API для отправки этого сообщения! Документация на сайте https://green-api.com/",
"description": "Сервис GREEN-API — интеграция с MAX на любом языке программирования: PHP, JavaScript, 1С, Python, Java, C#, VBA.",
"title": "Доступный MAX API для отправки сообщений | Сервис GREEN-API",
"forwardingScore": 0,
"isForwarded": false
}
}
}