Отправленное сообщение с документом#
В данном разделе описывается формат входящего уведомления объекта messageData
для отправленного сообщения с изображением, видео, аудио или документом. Для получения описания общего формата входящих уведомлений обратитесь к разделу Отправленные сообщения.
Для получения входящих уведомлений данного вида требуется выполнение двух условий:
typeWebhook
= outgoingMessageReceived
|| outgoingAPIMessageReceived
messageData.typeMessage
= documentMessage
Настройка инстанса
Чтобы получать входящие уведомления об отправленных сообщениях, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройки
Получать уведомления о сообщениях, отправленных с телефона
иПолучать уведомления о сообщениях, отправленных через API
(дополнительноПолучать уведомления о статусах отправленных сообщений
для получения уведомлений о статусах отправленного сообщения) -
Через метод SetSettings включить настройки
outgoingMessageWebhook
иoutgoingAPIMessageWebhook
(дополнительноoutgoingWebhook
для получения уведомлений о статусах отправленного сообщения)
Уведомление#
Формат уведомления#
Поля объекта messageData
Параметр | Тип | Описание |
---|---|---|
typeMessage | string | Тип отправленного сообщения. Для сообщений данного типа поле принимает значение: imageMessage , videoMessage , documentMessage , audioMessage |
fileMessageData | object | Объект данных об отправленном файле |
Поля объекта fileMessageData
Параметр | Тип | Описание |
---|---|---|
downloadUrl | string | Ссылка для скачивания файла |
caption | string | Описание под картинкой или видео |
fileName | string | Название файла. Поле заполняется корректно только для typeMessage = documentMessage , в остальных случаях название файла генерируется автоматически |
jpegThumbnail | string | Предпросмотр изображения в base64 |
mimeType | string | Тип файла, согласно классификации Media Types |
isForwarded | boolean | Является ли сообщение пересланным, принимает значения true /false |
forwardingScore | integer | Количество пересылок сообщения |
videoNote | boolean | Поле для видео сообщений. Принимает значение true - для мгновенного видео сообщения и false для обычного видео сообщения |
Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям отправленных сообщений описанных в разделе Отправленные сообщения
Пример тела уведомления#
{
"typeWebhook": "outgoingMessageReceived",
"instanceData": {
"idInstance": 3100000000,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1588091580,
"idMessage": "2755232962562",
"senderData": {
"chatId": "10000000",
"sender": "10000000",
"chatName": "Ходабрыш Пробешёлов",
"senderName": "Ходабрыш Пробешёлов",
"senderContactName": "Ходабрыш Пробешёлов"
},
"messageData": {
"typeMessage": "documentMessage",
"fileMessageData": {
"downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/d34044f0-c76e-4be3-b412-1befcce9d538.pdf",
"caption": "",
"fileName": "Harry-Potter-and-the-Philosophers-Stone.pdf",
"jpegThumbnail": "",
"mimeType": "application/pdf",
"forwardingScore": 0,
"isForwarded": false
}
}
}
Пример тела уведомления отправленного сообщения с аудио#
{
"typeWebhook": "outgoingMessageReceived",
"instanceData": {
"idInstance": 3100000000,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1588091580,
"idMessage": "2755232962562",
"senderData": {
"chatId": "10000000",
"sender": "10000000",
"chatName": "Ходабрыш Пробешёлов",
"senderName": "Ходабрыш Пробешёлов",
"senderContactName": "Ходабрыш Пробешёлов"
},
"messageData": {
"typeMessage": "documentMessage",
"fileMessageData": {
"downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/f3f4a306-b6a1-4a2a-bb29-a15b06752118.mp3",
"caption": "",
"fileName": "sample-6s.mp3",
"jpegThumbnail": "",
"isAnimated": false,
"mimeType": "audio/mpeg",
"forwardingScore": 0,
"isForwarded": false
}
}
}
Пример тела уведомления отправленного сообщения с видео#
{
"typeWebhook": "outgoingMessageReceived",
"instanceData": {
"idInstance": 3100000000,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1588091580,
"idMessage": "2755232962562",
"senderData": {
"chatId": "10000000",
"sender": "10000000",
"chatName": "Ходабрыш Пробешёлов",
"senderName": "Ходабрыш Пробешёлов",
"senderContactName": "Ходабрыш Пробешёлов"
},
"messageData": {
"typeMessage": "videoMessage",
"fileMessageData": {
"downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/339bca7d-egg7-4add-89c4-9bac7023921f.mp4",
"caption": "",
"fileName": "339bca7d-egg7-4add-89c4-9bac7023921f.mp4",
"jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
"isAnimated": false,
"mimeType": "video/mp4",
"forwardingScore": 0,
"isForwarded": false,
"videoNote": false
}
}
Пример тела уведомления отправленного сообщения с изображением#
{
"typeWebhook": "outgoingMessageReceived",
"instanceData": {
"idInstance": 3100000000,
"wid": "79991234567@c.us",
"typeInstance": "v3"
},
"timestamp": 1588091580,
"idMessage": "2755232962562",
"senderData": {
"chatId": "10000000",
"sender": "10000000",
"chatName": "Ходабрыш Пробешёлов",
"senderName": "Ходабрыш Пробешёлов",
"senderContactName": "Ходабрыш Пробешёлов"
},
"messageData": {
"typeMessage": "imageMessage",
"fileMessageData": {
"downloadUrl": "https://sw-media-3100.storage.yandexcloud.net/3100000000/15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
"caption": "",
"fileName": "15697d2c-397c-4fd0-8e1a-8be95f753aae.webp",
"jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
"isAnimated": false,
"mimeType": "image/webp",
"forwardingScore": 0,
"isForwarded": false
}
}
}