Входящее сообщение со стикером#
В данном разделе описывается формат входящего уведомления объекта messageData
для входящего сообщения со стикером. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.
Для получения входящих уведомлений данного вида требуется выполнение двух условий:
typeWebhook
= incomingMessageReceived
messageData.typeMessage
= stickerMessage
Настройка инстанса
Чтобы получать входящие уведомления о сообщениях со стикером, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления о входящих сообщениях и файлах
-
Через метод SetSettings включить настройку
incomingWebhook
Уведомление#
Формат уведомления#
Поля объекта messageData
Параметр | Тип | Описание |
---|---|---|
typeMessage | string | Тип принятого сообщения. Для сообщений данного типа поле принимает значение: stickerMessage |
fileMessageData | object | Объект данных о принятом стикере |
quotedMessage | object | Объект данных о цитируемом сообщении |
Поля объекта fileMessageData
Параметр | Тип | Описание |
---|---|---|
downloadUrl | string | Ссылка на стикер |
caption | string | Описание под картинкой или видео |
fileName | string | Название файла |
jpegThumbnail | string | Предпросмотр изображения в base64 |
isAnimated | boolean | Является ли стикер анимированным |
mimeType | string | Тип файла, согласно классификации Media Types |
isForwarded | boolean | Является ли сообщение пересланным, принимает значения true/false |
forwardingScore | integer | Количество пересылок сообщения |
Поля объекта quotedMessage
Параметр | Тип | Описание |
---|---|---|
stanzaId | string | id цитируемого сообщения |
participant | string | id отправителя цитируемого сообщения |
typeMessage | string | Тип цитируемого сообщения |
Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описанных в разделе Входящие сообщения
Пример тела уведомления#
{
"typeWebhook": "incomingMessageReceived",
"instanceData": {
"idInstance": 1234,
"wid": "11001234567@c.us",
"typeInstance": "whatsapp"
},
"timestamp": 1588091580,
"idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
"senderData": {
"chatId": "79001234568@c.us",
"chatName": "Иван",
"sender": "79001234568@c.us",
"senderName": "Иван",
"senderContactName": "Иван Васильевич"
},
"messageData": {
"typeMessage": "stickerMessage",
"fileMessageData": {
"downloadUrl": "https://sw-media.storage.greenapi.net/9901742665/607dde0a-01dc-4dd9-8afb-707cbf610943.webp",
"caption": "",
"fileName": "201ee6e7-b6f9-48fe-bc5a-1ce4341cce88.webp",
"jpegThumbnail": "",
"isAnimated": true,
"mimeType": "image/webp",
"forwardingScore": 1,
"isForwarded": true
},
"quotedMessage": {
"stanzaId": "A16014FAC9F5382E7B9CEEFEF1FFEB6F",
"participant": "79001234568@c.us"
}
}
}