Входящее текстовое сообщение#
В данном разделе описывается формат входящего уведомления объекта messageData
для входящего текстового сообщения. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.
Для получения входящих уведомлений данного вида требуется выполнение двух условий:
typeWebhook
= incomingMessageReceived
messageData.typeMessage
= textMessage
Настройка инстанса
Чтобы получать входящие уведомления о входящих сообщениях, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления о входящих сообщениях и файлах
-
Через метод SetSettings включить настройку
incomingWebhook
Уведомление#
Формат уведомления#
Поля объекта messageData
Параметр | Тип | Описание |
---|---|---|
typeMessage | string | Тип принятого сообщения. Для сообщений данного типа поле принимает значение textMessage |
textMessageData | object | Объект данных о текстовом сообщении |
Поля объекта textMessageData
Параметр | Тип | Описание |
---|---|---|
textMessage | string | Текстовое сообщение |
Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описанных в разделе Входящие сообщения
Пример тела уведомления#
{
"typeWebhook": "incomingMessageReceived",
"instanceData": {
"idInstance": 1101111111,
"wid": "12345435546",
"typeInstance": "v3"
},
"timestamp": 1588091580,
"idMessage": "1234543554675687678979",
"senderData": {
"chatId": "12345678",
"sender": "12345678",
"chatName": "Иван",
"senderName": "Иван",
"senderContactName": "Иван Царевич"
},
"messageData": {
"typeMessage": "textMessage",
"textMessageData": {
"textMessage": "Отличный день!"
}
}
}