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

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

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

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

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

  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 - произошла ошибка при отправке сообщения на сервер Telegram (данный статус невозможно отключить в настройках SetSettings, необходимо обязательно реализовать обработку данного уведомления)
noAccount - на номере телефона получателя не зарегистрирован аккаунт Telegram или номер скрыт настройками приватности (данный статус невозможно отключить в настройках SetSettings, необходимо обязательно реализовать обработку данного уведомления)
description string Описание ошибки (рекомендуется сделать информирование оператора об ошибках системы). Описание принимает значения:
media caption too long - превышена длина описания медиа сообщения
chatId unresolvable on this session - ранее не было переписки с указанным идентификатором чата, поэтому получатель не определён. Получите актуальный chatId методом CheckAccount и повторите отправку

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

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

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

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "10000000",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1755591519,
  "idMessage": "115054445839974415",
  "status": "delivered",
}

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

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "10000000",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1755591519,
  "idMessage": "115054445839974415",
  "status": "read",
}

Пример тела уведомления о превышении длины описания медиа сообщения#

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "10000000",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1755591519,
  "status": "failed",
  "description": "media caption too long"
}

Пример тела уведомления, когда получатель не определён#

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "10000000",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1755591519,
  "status": "failed",
  "description": "chatId unresolvable on this session"
}

Пример тела уведомления при отсутствии аккаунта Telegram на номере или скрытом номере#

{
  "typeWebhook": "outgoingMessageStatus",
  "chatId": "77777777777@c.us",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1755591519,
  "status": "noAccount"
}