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

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

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

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

  • outgoingMessageWebhook
  • outgoingWebhook

Подробнее о статусах отправленных сообщений в WhatApp читайте в нашей статье

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

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

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

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

Параметр Тип Описание
idInstance integer Идентификатор аккаунта
wid string Идентификатор аккаунта в формате WhatsApp
typeInstance string Тип мессенджера для аккаунта

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

{
    "typeWebhook": "outgoingMessageStatus",
    "chatId": "11001234567890@c.us",
    "instanceData": {
        "idInstance": 1234,
        "wid": "11001234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1586700802,
    "idMessage": "3EB0608D6A2901063D63",
    "status": "noAccount",
    "description":"SWE004: the number of participants in the group has been exceeded - 706", // 706 - количество участников в группе
    "sendByApi": true
}