Перейти к содержанию

Входящее текстовое сообщение, сообщение с URL или рекламное сообщение#

В данном разделе описывается формат входящего уведомления объекта messageData для входящего текстового сообщения или сообщения с URL. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.

Для получения входящих уведомлений данного вида требуется выполнение двух условий:

typeWebhook = incomingMessageReceived

messageData.typeMessage = extendedTextMessage

Настройка инстанса

Чтобы получать входящие уведомления о входящих сообщениях с URL или рекламных сообщениях, необходимо включить настройки одним из представленных вариантов:

  1. Через личный кабинет включить настройку Получать уведомления о входящих сообщениях и файлах

  2. Через метод SetSettings включить настройку incomingWebhook

Уведомление#

Формат уведомления#

Поля объекта messageData

Параметр Тип Описание
typeMessage string Тип принятого сообщения. Для сообщений данного типа поле принимает значение extendedTextMessage
extendedTextMessageData object Объект данных о принятом текстовом сообщении или URL ссылки
quotedMessage object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой

Поля объекта extendedTextMessageData

Параметр Тип Описание
text string Текст ссылки или обычный текст
description string Описание ссылки, может быть пустым
title string Заголовок ссылки, может быть пустым
containsAutoReply boolean Содержит ли сообщение автоответ (только для рекламных сообщений)
mediaType string Тип медиа сообщения, например "IMAGE" (только для рекламных сообщений)
showAdAttribution boolean Показывать ли атрибуты рекламы в сообщении (только для рекламных сообщений)
sourceId string Id рекламы (только для рекламных сообщений)
sourceType string Тип источника, например "ad" (только для рекламных сообщений)
sourceUrl string Ссылка на рекламу (только для рекламных сообщений)
conversionSource string Локализация сообщения (только для рекламных сообщений)
entryPointConversionApp string Источник сообщения (только для рекламных сообщений)
jpegThumbnail string Превью изображения в base64 кодировке, может отсутствовать
thumbnailUrl string Ссылка на превью изображения (только для рекламных сообщений)
isForwarded boolean Является ли сообщение пересланным, принимает значения true/false
forwardingScore integer Количество пересылок сообщения
previewType string Тип превью (только для рекламных сообщений) Значение previewType:None устаревшее

Поля объекта quotedMessage

Параметр Тип Описание
stanzaId string id цитируемого сообщения
participant string id отправителя цитируемого сообщения
typeMessage string Тип цитируемого сообщения

Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описанных в разделе Входящие сообщения

Пример тела уведомления#

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "12345435546",
        "typeInstance": "v3"
    },
    "timestamp": 1588091580,
    "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
    "senderData": {
        "chatId": "12345678",
        "sender": "87654321",
            "chatName": "",
        "senderName": "",
        "senderContactName": ""
    },
    "messageData": {
        "typeMessage": "extendedTextMessage",
        "extendedTextMessageData": {
            "text": "https://green-api.com/docs/video",
            "description": "Как легко и просто",
            "title": "Радуйся",
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYG==",
                "forwardingScore": 0,
                "isForwarded": false
        }
    }
}