Входящее текстовое сообщение, сообщение с 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	Заголовок ссылки, может быть пустым
`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": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1588091580,
    "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
    "senderData": {
        "chatId": "79001234567@c.us",
        "sender": "79001234567@c.us",
            "chatName": "Иван",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "extendedTextMessage",
        "extendedTextMessageData": {
            "text": "https://green-api.com/docs/video",
            "description": "GREEN-API docs shows how you can develop the WhatsApp Bot",
            "title": "How to develop WhatsApp Bot",
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYG==",
                  "forwardingScore": 4,
            "isForwarded": true
        }
    }
}

Пример тела уведомления с сообщением из группового чата#

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1732268220,
    "idMessage": "2D9D6721A977D369246509EBE0CE44CA",
    "senderData": {
      "chatId": "120363369140947676@g.us",
      "chatName": "Группа",
      "sender": "79001234567@c.us",
      "senderName": "Иван",
      "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "extendedTextMessage",
        "extendedTextMessageData": {
            "text": "https://green-api.com/docs/video",
            "description": "GREEN-API docs shows how you can develop the WhatsApp Bot",
            "title": "How to develop WhatsApp Bot",
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYG==",
                  "forwardingScore": 4,
            "isForwarded": true
        }
    }
}

Пример тела уведомления входящего сообщения со ссылкой или текстом и цитатой контакта#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "quotedMessage",
    "extendedTextMessageData": {
      "text": "https://yandex.ru/former&utm_source=home&utm_content=main_informer&utm_term=main_number",
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79876543210@c.us",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79876543210@c.us",
      "typeMessage": "contactMessage",
      "contact": {
        "displayName": "Green-Api",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Green-Api\nitem1.TEL;waid=79876543210\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
      }
    }
  }
}

Пример тела уведомления входящего сообщения со ссылкой и цитатой изображения#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "quotedMessage",
    "extendedTextMessageData": {
      "text": "https://yandex.ru/pogoda/?utm_medium=source=home&utm_content=main_informer&utm_term=main_number",
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79876543210@c.us",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "46618B98B3B9DF50F123456789123456",
      "participant": "79876543210@c.us",
      "typeMessage": "imageMessage",
      "downloadUrl": "",
      "caption": "",
      "jpegThumbnail": ""
    }
  }
}

Пример тела уведомления входящего рекламного сообщения#

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1588091580,
    "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
    "senderData": {
        "chatId": "79001234567@c.us",
        "chatName": "Иван",
        "sender": "79001234567@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "extendedTextMessage",
        "extendedTextMessageData": {
            "text": "https://fb.me/gUdvBdhtH",
            "description": "Новый инстанс для вашего бизнеса!",
            "title": "GREEN-API",
            "containsAutoReply": false,
            "mediaType": "IMAGE",
            "showAdAttribution": false,
            "sourceId": "122210486228016873",
            "sourceType": "post",
            "sourceUrl": "https://fb.me/gUdvBdhtH",
            "conversionSource": "FB_Ads",
            "entryPointConversionApp": "instagram",
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/7QCEUGhvdG9zaG9wIDMuMAA4qIJUeuMEjYwGc9BtFMXTYvgsnm4ADy6HLLZDqn1Ye5RMev+ae1hED2B9dQIARwjvDIwYCg4/r/9k=",
            "thumbnailUrl": "https://scontent.xx.fbcdn.net/v/t39.30808-6/436945887_122115998378256688_307643393252141869_n.jpg?stp=dst-jpg_s851x315&_nc_cat=111&ccb=1-7&_nc_sid=5f2048&_nc_ohc=x61r6W-VrJIAb69T4Dl&_nc_ad=z-m&_nc_cid=0&_nc_ht=scontent.xx&oh=00_AfDLFkjNOBYEntBu6SYaUOxDuxbvarjKha9Ez5RQUXjsfg&oe=662D7680",
            "previewType": ""
            }
    }
}