> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Messages Ack

> For message delivery & read receipts.

## message.ack

Receive events when server or recipient gets the message, read or played it.

AckName field contains message status (ack has the same meaning, but show the value in int, but we keep it for backward compatability, they much to each other)

Possible message ack statuses:

* ackName: ERROR, ack: -1
* ackName: PENDING, ack: 0
* ackName: SERVER, ack: 1
* ackName: DEVICE, ack: 2
* ackName: READ, ack: 3
* ackName: PLAYED, ack: 4

The payload may have more fields, it depends on the engine you use, but here’s a minimum amount that all engines send:


## OpenAPI

````yaml v1/api-reference/whatsapp-webhooks/whatsapp-webhooks.json webhook messages-ack
openapi: 3.1.0
info:
  title: Hypersender WhatsApp Webhooks
  description: >-


    # Introduction

    The Hypersender WhatsApp API offers a webhook-based integration that
    delivers real-time, event-driven notifications. This allows developers to
    monitor their connected WhatsApp instances or respond to specific events,
    ranging from message interactions to contact and media management.

    - **Status Updates**: Provides updates on the connection status of the
    connected WhatsApp instance, indicating whether the connection is open,
    closed, or in the process of connecting. It also updates the presence of
    chats in real-time, offering information on activities such as typing or
    recording a voice message.

    - **Chats**: Tracks interactions and status changes for chats. This includes
    the creation of new chats, updates to existing ones, and various
    chat-specific actions like archiving.

    - **Contacts**: Observes changes to the contacts associated with the
    connected WhatsApp instance. Any addition, removal, or update to a contact
    triggers a notification through the designated route.

    - **Messages**: Central to WhatsApp's core functionality, our API
    extensively supports message monitoring. This includes notifications for
    incoming messages, updates to message status, and messages sent through the
    API.
  version: 1.0.0
servers: []
security: []
paths: {}

````