Работа с редактируемыми и удалёнными сообщениями#

Бета-версия

Функциональность находится в стадии бета-тестирования. Функции могут быть изменены, а также могут работать нестабильно.

Рекомендации по работе с редактируемыми и удалёнными сообщениями:

Настройка инстанса
Работа с редактируемыми сообщениями
Работа с удалёнными сообщениями

1. Настройка инстанса#

Для работы с уведомлениями о редактировании и удалении сообщений требуется включить на инстансе настройки editedMessageWebhook и deletedMessageWebhook (по умолчанию настройки выключены).

Включить настройки можно через:

Личный кабинет, в настройках инстанса;

Метод SetSettings, указав параметры:

"editedMessageWebhook":"yes",
"deletedMessageWebhook":"yes"

Метод партнера CreateInstance, указав при создании инстанса:
```
"editedMessageWebhook":"yes",
"deletedMessageWebhook":"yes"  
```

2. Работа с редактируемыми сообщениями#

Метод EditMessage#

При вызове метода EditMessage в ответ Вы получите idMessage - идентификатор изменённого сообщения сообщения.

По нему можно получить уведомление о результате выполнения редактирования, а также отследить, какой именно пользователь сделал редактирование сообщения (если в системе находится несколько операторов).

Обработка уведомлений#

При редактировании сообщения формируется уведомление типа editedMessageWebhook.

Примеры уведомлений

Пример уведомления типа editedMessageWebhook для входящего сообщения:

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101000001,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1738566656,
    "idMessage": "3U28ABACVPDF65C8B28",
    "senderData": {
        "chatId": "71234567890@c.us",
        "chatName": "Василиса",
        "sender": "71234567890@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "editedMessage",
        "editedMessageData": {
            "textMessage": "Отредактированное сообщение",
            "stanzaId": "3PEAD8EDB7A9D438FF5E"
        }
    }
}

Пример уведомления типа editedMessageWebhook для отправленного сообщения:

{
    "typeWebhook": "outgoingMessageReceived", / "outgoingAPIMessageReceived",
    "instanceData": {
        "idInstance": 1101000001,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1738566656,
    "idMessage": "605B93BDD1ECA978028FE678C6F536A7",
    "senderData": {
        "chatId": "71234567890@c.us",
        "chatName": "Василиса",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "editedMessage",
        "editedMessageData": {
            "textMessage": "Отредактированное сообщение",
            "stanzaId": "85E55C3B4AEC6FA1281ADCFF9E078E32"
        }
    }
}

Поле textMessage содержит новый текст сообщения.
Поле stanzaId - содержит изначальный текст сообщения, которое было изменено.

Рекомендуем делать обработку только необходимых Вам уведомлений.

Сервис обработчика должен найти обязательное поле typeWebhook, и в зависимости от его типа обработать либо сбросить уведомление. Таким образом обрабатываться будут только выбранные типы событий, а неверные настройки инстанса или выходы новых релизов API не нарушат работу Вашей интеграции.

Работа через журналы#

При работе через методы журналирования определение редактированного сообщения можно делать по полю isEdited: true.

Примеры записей в журналах

Пример записи входящего отредактированного сообщения:

{
    "type": "incoming",
    "idMessage": "3ABB6C1B73334C9741F4",
    "timestamp": 1739539803,
    "typeMessage": "extendedTextMessage",
    "chatId": "70000000012@c.us",
    "textMessage": "Привет!",
        "extendedTextMessage": {
        "text": "Привет!",
        "description": "",
        "title": "",
        "previewType": "None",
        "jpegThumbnail": "",
        "forwardingScore": 0,
        "isForwarded": false
    },
    "senderId": "70000000012@c.us",
    "senderName": "Василиса Премудрая",
    "senderContactName": "Василиса",
    "deletedMessageId": "",
    "editedMessageId": "3AC57AE5BB0784C80047",
    "isEdited": true,
    "isDeleted": false
}

Пример записи отправленного отредактированного сообщения:

{
    "type": "outgoing",
    "idMessage": "BAE5143000000000",
    "timestamp": 1706761225,
    "typeMessage": "extendedTextMessage",
    "chatId": "70000000012@c.us",
    "textMessage": "Привет",
        "extendedTextMessage": {
        "text": "Привет",
        "description": "",
        "title": "",
        "previewType": "None",
        "jpegThumbnail": "",
        "forwardingScore": 0,
        "isForwarded": false
    },
    "statusMessage": "read",
    "sendByApi": true, // false,
    "deletedMessageId": "",
    "editedMessageId": "3AC57AE5BB0784C80047",
    "isEdited": true,
    "isDeleted": false
}

Для актуализации переписки в чате рекомендуем определять сообщения, которые были получены или отправлены за последние 15 минут (допустимое время редактирования сообщений), и производить их обновления каждые 10-15 секунд одним из методов:

GetChatHistory - по всей истории чата
GetMessage - по выбранному сообщению чата

Обратите внимание#

Уведомления о редактируемых сообщениях приходят по всем типам сообщений: входящие, отправленные с API и отправленные с телефона.

В зависимости от этого typeWebhook будет содержать
По редактируемым сообщениям, так же как и по отправляемым, формируются уведомления типа outgoingMessageStatus.
В журналах отредактированные сообщения будут иметь тип outgoing либо incoming в зависимости от того, кто отредактировал сообщение.

В журнале будет только запись с отредактированным сообщением и полем stanzaId, содержащим идентификатор оригинального сообщения.
Метод редактирования сообщений работает через очередь сообщений.

Поэтому если на инстансе выполнялась рассылка и образовалась очередь, то редактирование произойдет не мгновенно, а только после обработки предшествующих сообщений в очереди.
Если обработка редактируемого сообщения системой не произойдет в течение 15 минут с момента написания оригинального сообщения, то изменение сообщения не произойдет.

На запрос редактирования сообщения будет сформировано уведомление с ошибкой (статус failed).
В поле description будет указана причина ошибки.
Пример уведомления
```
{
    "typeWebhook": "outgoingMessageStatus",
    "chatId": "79001234567@c.us",
    "instanceData": {
        "idInstance": 1101000001,
        "wid": "79001234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1739426932,
    "idMessage": "BAE56687379D581D",
    "status": "failed",
    "description": "15 minute editing time gap has been expired",
    "sendByApi": true
}
```
При вызове метода с неверно указанным idMessage сформируется уведомление с ошибкой (статус failed).
В поле description будет указана причина ошибки.

3. Работа с удалёнными сообщениями#

Метод DeleteMessage#

При вызове метода DeleteMessage в ответ Вы получите статус код 200 и пустое тело.

Система формирует идентификатор события удаления сообщения.
Данный идентификатор будет указан в уведомлении по событию удаления сообщения.

Обработка уведомлений#

При удалении сообщения формируется уведомление типа deletedMessageWebhook.

Примеры уведомлений

Пример уведомления типа deletedMessageWebhook для входящего сообщения:

{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101000001,
        "wid": "71231234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1733146115,
    "idMessage": "10ECA1E0D26FAB972C24C56C8285ACAB",
    "senderData": {
        "chatId": "71234567890@c.us",
        "chatName": "Василиса",
        "sender": "71234567890@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "deletedMessage",
        "deletedMessageData": {
        "stanzaId": "84514217EF972039FC3F68A53C196306" // id сообщения которое удалили
        }
    }
}

Пример уведомления типа deletedMessageWebhook для отправленного сообщения:

{
    "typeWebhook": "outgoingMessageReceived", / "outgoingAPIMessageReceived",
    "instanceData": {
        "idInstance": 1101000001,
        "wid": "71231234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1733146115,
    "idMessage": "C9801E522F8BFE8091215CAD1FC25D87",
    "senderData": {
        "chatId": "71234567890@c.us",
        "chatName": "Василиса",
        "sender": "71231234567@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
    },
    "messageData": {
        "typeMessage": "deletedMessage",
        "deletedMessageData": {
        "stanzaId": "85E55C3B4AEC6FA1281ADCFF9E078E32" // id сообщения которое удалили
        }
    }
}

Поле stanzaId - содержит идентификатор сообщения, которое было удалено.

Рекомендуем делать обработку только необходимых Вам уведомлений.

Сервис обработчика должен найти обязательное поле typeWebhook, и в зависимости от его типа обработать либо сбросить уведомление. Таким образом обрабатываться будут только выбранные типы событий, а неверные настройки инстанса или выходы новых релизов API не нарушат работу Вашей интеграции.

Работа через журналы#

При работе через методы журналирования определение удалённого сообщения можно делать по полю isDeleted: true.

Примеры записей в журналах

Пример записи входящего удалённого сообщения:

{
    "type": "incoming",
    "idMessage": "3ABB6C1B73334C9741F4",
    "timestamp": 1739539803,
    "typeMessage": "textMessage",
    "chatId": "70000000012@c.us",
    "textMessage": "Привет!",
    "senderId": "70000000012@c.us",
    "senderName": "Василиса Премудрая",
    "senderContactName": "Василиса",
    "deletedMessageId": "3AC57AE5BB0784C80047",
    "editedMessageId": "",
    "isEdited": false,
    "isDeleted": true
}

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

{
    "type": "outgoing",
    "idMessage": "E4E0E381ACE74B5845437A8F0E365D75",
    "timestamp": 1739538875,
    "typeMessage": "textMessage",
    "chatId": "70000000012@c.us",
    "textMessage": "Привет!",
    "statusMessage": "read",
    "sendByApi": true, // false,
    "deletedMessageId": "7863F3285595F3A296FEF8C6C386871F",
    "editedMessageId": "",
    "isEdited": false,
    "isDeleted": true
}

Для актуализации переписки в чате рекомендуем производить их обновления каждые 10-15 секунд одним из методов:

GetChatHistory - по всей истории чата
GetMessage - по выбранному сообщению чата

Обратите внимание#

Уведомления об удалённых сообщениях приходят по всем типам сообщений: (входящие, отправленные с API и отправленные с телефона).

В зависимости от этого typeWebhook будет содержать:
По удалённым сообщениям, так же как и по отправляемым, формируются уведомления типа outgoingMessageStatus.
В журналах удалённые сообщения будут иметь тип outgoing либо incoming в зависимости от того кто удалил сообщение.

В журнале будет запись об удалении сообщения и полем stanzaId, содержащим идентификатор удалённого сообщения.
В журнале будут зафиксированы все события удаления сообщений:
- кто удалил сообщение - senderId,
- в каком чате было удалено сообщение - chatId,
- когда было удалено сообщение - timestamp.
Оригинальное сообщение из журнала не удаляется, оно меняет поле на isDeleted: true.