Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
message

Message Status

This endpoint retrieves the delivery status of a message based on the unique_id of the message

get/message/{unique_id}/status

Path parameters

unique_idstring required
Example:3EB0A0A8F90A01259C81A3

A unique identifier returned by /message/send or /message/broadcast APIs at send time

Headers

x-phonestring
Example:918527184400

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Response

200 OK

queue_idstring

A unique identifier for your message queue

unique_idstring

Provisional message identifier, useful for tracking via /message/{unique_id}/status

message_idstring

A unique identifier for the message, containing information about the chat, sender, and message details.

chat_idstring

The unique identifier of the WhatsApp chat (format: {phone_number}@c.us for individual chats or {group_id}@g.us for groups).

performed_bystring

Identifier of who initiated the message (e.g. api, user)

statusstring

Current delivery status of the message

status_descriptionstring

The description of the current status of the message

ackinteger

The WhatsApp acknowledgement status of the message

attemptsinteger

Number of attempts made to send the message

delivered_countinteger

Number of recipients who received the message

read_countinteger

Number of recipients who read the message

Example response

{
  "queue_id": "5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400",
  "unique_id": "3EB0A0A8F90A01259C81A3",
  "message_id": "true_8824248940@c.us_3EB0A0A8F90A01259C81A3",
  "chat_id": "8824248940@c.us",
  "performed_by": "api",
  "status": "read",
  "status_description": "Read by recipient.",
  "ack": 4,
  "message": {
    "body": "test 93",
    "type": "chat",
    "quoted_message_id": "3EB0885..."
  },
  "attempts": 1,
  "delivered_count": 1,
  "read_count": 1
}