Входящее сообщение со стикером#

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = stickerMessage

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

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

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

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

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

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

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

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

Параметр	Тип	Описание
`downloadUrl`	string	Ссылка для скачивания стикера
`fileName`	string	Название файла. Для стандартных стикеров принимает значение `"AnimatedSticker.gs"`
`jpegThumbnail`	string	Предпросмотр стикера в base64
`mimeType`	string	Тип файла: `"application/x-tgsticker"` - для стандартных стикеров, - `"image/webp"` для кастомных
`forwardingScore`	integer	Количество пересылок сообщения
`isForwarded`	boolean	Флаг пересланного сообщения, `true`/`false`

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

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

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

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

  {
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 4100000000,
        "wid": "79876543210@c.us",
        "typeInstance": "tgm"
    },
    "timestamp": 1763115112,
    "idMessage": "1763115112345",
    "senderData": {
        "chatId": "10000000",
        "sender": "10000000",
        "chatName": "Василиса Премудрая",
        "senderName": "Василиса Премудрая",
        "senderContactName": "Василиса Премудрая",
        "senderPhoneNumber": 79876543210
    },
    "messageData": {
        "typeMessage": "stickerMessage",
        "stickerMessageData": {
            "downloadUrl": "https://4100.api.green-api.com/download/4100/1763115112345.webp",
            "fileName": "AnimatedSticker.tgs",
            "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
            "isAnimated": true,
            "mimeType": "application/x-tgsticker",
            "forwardingScore": 0,
            "isForwarded": false
        }
    }
}

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

  {
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 4100000000,
        "wid": "79876543210@c.us",
        "typeInstance": "tgm"
    },
    "timestamp": 1763115112,
    "idMessage": "1763115112345",
    "senderData": {
        "chatId": "-10000000000000",
        "sender": "10000000",
        "chatName": "Тридесятое царство",
        "senderName": "Василиса",
        "senderContactName": "",
        "senderPhoneNumber": 0
    },
    "messageData": {
        "typeMessage": "stickerMessage",
        "stickerMessageData": {
            "downloadUrl": "https://4100.api.green-api.com/download/4100/1763115112345.webp",
            "fileName": "1763115112345.webp",
            "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
            "isAnimated": false,
            "mimeType": "image/webp",
            "forwardingScore": 0,
            "isForwarded": false
        }
    }
}