Перейти к содержанию

Статус отправленного сообщения#

Postman Apidog

Входящее уведомление данного типа содержит статус ранее отправленного сообщения: отправлено, прочитано.

Настройка инстанса

Чтобы получать входящие уведомления о статусах отправленных сообщений, необходимо включить настройки одним из представленных вариантов:

  1. Через личный кабинет включить настройки Получать уведомления о сообщениях, отправленных с телефона, Получать уведомления о сообщениях, отправленных через API и Получать уведомления о статусах отправленных сообщений

  2. Через метод SetSettings включить настройки outgoingMessageWebhook, outgoingAPIMessageWebhook и outgoingWebhook

Уведомление#

Формат уведомления#

Параметр Тип Описание
typeWebhook string Тип входящего уведомления. Для уведомлений данного типа поле принимает значение outgoingMessageStatus
chatId string Идентификатор чата. Чат с сообщением по которому получили статус.
instanceData object Данные об инстансе
timestamp integer Время наступления события в UNIX-формате
idMessage string Идентификатор отправленного сообщения или файла. Идентификатор отправленного сообщения возвращается методами: SendMessage, SendFileByUrl
status string Статус отправленного сообщения или файла. Статус принимает значения:
delivered - сообщение доставлено до получателя
read - сообщение прочитано/просмотрено/прослушано
failed - произошла ошибка при отправке сообщения на сервер MAX (данный статус невозможно отключить в настройках SetSettings, необходимо обязательно реализовать обработку данного уведомления)
noAccount - на номере телефона получателя не зарегистрирован аккаунт MAX (данный статус невозможно отключить в настройках SetSettings, необходимо обязательно реализовать обработку данного уведомления)
notInGroup - отправитель не является участником группового чата, в который выполняется отправка сообщения
description string Описание ошибки (рекомендуется сделать информирование оператора об ошибках системы)
sendByApi boolean Флаг указывает отправлено сообщение из API или нет, принимает значения: true , false

Поля объекта instanceData

Параметр Тип Описание
idInstance integer Идентификатор инстанса. Значение типа uint64, 10 разрядов
wid string Идентификатор аккаунта
typeInstance string Тип мессенджера для инстанса
    Поле принимает значение v3 для мессенджера MAX
    Поле принимает значение whatsapp - для мессенджера WhatsApp

Пример тела уведомления со статусом delivered#

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "10000000",
  "instanceData": {
    "idInstance": 3100000000,
    "wid": "79991234567@c.us",
    "typeInstance": "v3"
  },
  "timestamp": 1755591519,
  "idMessage": "115054445839974415",
  "status": "delivered",
  "sendByApi": false
}

Пример тела уведомления со статусом read#

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "10000000",
  "instanceData": {
    "idInstance": 3100000000,
    "wid": "79991234567@c.us",
    "typeInstance": "v3"
  },
  "timestamp": 1755591519,
  "idMessage": "115054445839974415",
  "status": "read",
  "sendByApi": false
}