Incoming event "messageStatus"

Example of messageStatus object (sent message status)

This article contains examples of message status objects that can be retrieved via webhooks and Pusher events.

Message status: sent

This status indicates that the message has been successfully sent to the recipient but has not yet been delivered. Available for messengers: grWhatsApp, caWhatsApp, WhatsApp, vkNotify

{
  "data": [
    {
      "id": "BAE535F3C30E25D1",
      "type": "sent",
      "time": 1727765002,
      "chat": {
        "id": "70000000001@c.us",
        "hash": null,
        "type": "private",
        "phone": "70000000001",
        "username": null,
        "email": null
      },
      "fromApp": {
        "id": "app_25095_1",
        "tracking": null,
        "sender": "employee"
      },
      "error": null
    }
  ],
  "meta": {
    "type": "messageStatus",
    "licenseId": 1,
    "messengerType": "grWhatsApp"
  }
}

Message status: delivered 

The message has been successfully delivered to the recipient, but has not yet been viewed. 

Available for messengers: grWhatsApp, caWhatsApp, WhatsApp, vkNotify, facebook, telegram, viberBot

{
  "data": [
    {
      "id": "111081",
      "type": "delivered",
      "time": 1727765171,
      "chat": {
        "id": "private-917861412h8516845882144834580",
        "hash": "h8516845882144834580",
        "type": "private",
        "phone": "70000000001",
        "username": "username",
        "email": null
      },
      "fromApp": {
        "id": "app_25095_1",
        "tracking": null,
        "sender": "employee"
      },
      "error": null
    }
  ],
  "meta": {
    "type": "messageStatus",
    "licenseId": 1,
    "messengerType": "telegram"
  }
}

Message status: viewed

The message has been delivered and read by the recipient. 

Available for messengers: grWhatsApp, caWhatsApp, WhatsApp, vkNotify, facebook, telegram, viberBot, instagram, email

{
  "data": [
    {
      "id": "111081",
      "type": "viewed",
      "time": 1727765173,
      "chat": {
        "id": "private-917861412h8516845882144834580",
        "hash": "h8516845882144834580",
        "type": "private",
        "phone": "70000000001",
        "username": "username",
        "email": null
      },
      "fromApp": {
        "id": "app_25095_1",
        "tracking": null,
        "sender": "employee"
      },
      "error": null
    }
  ],
  "meta": {
    "type": "messageStatus",
    "licenseId": 1,
    "messengerType": "telegram"
  }
}

Message status: failed

The message was not delivered due to an error. The 'error' field contains the error code and text, if any.

Available for messengers: grWhatsApp, caWhatsApp, WhatsApp, WhatsApp, vkNotify, email

{
  "data": [
    {
      "id": "0606f306-a5c8-4fc1-9e4d-62dadce3b168",
      "type": "failed",
      "time": 1727765702,
      "chat": {
        "id": "70000000001",
        "hash": null,
        "type": "private",
        "phone": "70000000001",
        "username": null,
        "email": null
      },
      "fromApp": {
        "id": "app_25095_1",
        "tracking": null,
        "sender": "employee"
      },
      "error": {
        "code": 470,
        "message": "Message failed to send because more than 24 hours have passed since the customer last replied to this number.",
        "messageLang": {
          "en": "Message failed to send because more than 24 hours have passed since the customer last replied to this number.",
          "ru": "Сообщение не удалось отправить, так как прошло более 24 часов с момента последнего ответа клиента на этот номер."
        }
      }
    }
  ],
  "meta": {
    "type": "messageStatus",
    "licenseId": 1,
    "messengerType": "WhatsApp"
  }
}