Входящее сообщение с аудио#
В данном разделе описывается формат входящего уведомления объекта messageData
для входящего сообщения с аудио. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.
Для получения входящих уведомлений данного вида требуется выполнение двух условий:
typeWebhook
= incomingMessageReceived
messageData.typeMessage
= audioMessage
Настройка инстанса
Чтобы получать входящие уведомления о сообщениях с изображением, видео, аудио, документом, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления о входящих сообщениях и файлах
-
Через метод SetSettings включить настройку
incomingWebhook
Уведомление#
Формат уведомления#
Поля объекта messageData
Параметр | Тип | Описание |
---|---|---|
typeMessage | string | Тип принятого сообщения. Для сообщений данного типа поле принимает значение: audioMessage |
fileMessageData | object | Объект данных о принятом файле |
Поля объекта fileMessageData
Параметр | Тип | Описание |
---|---|---|
downloadUrl | string | Ссылка для скачивания файла |
caption | string | Описание под картинкой или видео. Поле нужно для получения уведомления других типов. |
fileName | string | Название файла. Поле заполняется корректно только для typeMessage = documentMessage , в остальных случаях название файла генерируется автоматически |
jpegThumbnail | string | Предпросмотр изображения в base64 |
mimeType | string | Тип файла, согласно классификации Media Types |
forwardingScore | integer | Количество пересылок сообщения |
isForwarded | boolean | Является ли сообщение пересланным, принимает значения true /false |
Пример тела уведомления входящего сообщения с аудио#
{
"typeWebhook": "incomingMessageReceived",
"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
}
}
}