The Message Object

{
  "message_id": "true_12036329726967XXXX@g.us_3EB01F4653XX9XX05E9859_9190043XXXXX@c.us",
  "org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
  "ack": "2",
  "author": "9190043XXXXX@c.us",
  "body": "Hello, world",
  "broadcast": null,
  "device_type": "android",
  "flag_status": false,
  "duration": null,
  "forwarding_score": "0",
  "from": "9190043XXXXX@c.us",
  "from_me": true,
  "has_media": true,
  "has_quoted_msg": false,
  "has_reaction": false,
  "id": {
    "id": "3EB01F4653XX9XX05E9859",
    "fromMe": true,
    "remote": "12036329726967XXXX@g.us",
    "_serialized": "true_12036329726967XXXX@g.us_3EB01F4653XX9XX05E9859_9190043XXXXX@c.us"
  },
  "invite_v4": null,
  "is_ephemeral": null, //disappearing messages
  "is_forwarded": false,
  "is_gif": false,
  "is_starred": false,
  "is_status": false,
  "links": "[]",
  "location": null,
  "media_key": null,
  "mentioned_ids": [],
  "order_id": null,
  "raw_data": null,
  "to": "12036329726967XXXX@g.us",
  "token": null,
  "message_type": "image",
  "vcards": [],
  "chat_id": "12036329726967XXXX@g.us",
  "timestamp": "2024-05-13 11:19:34+00",
  "org_phone": "9190043XXXXX@c.us",
  "broadcast_id": null,
  "is_deleted": null,
  "media": {
    "path": "/storage/v1/object/public/message-media/2997xx64-89bf-48d3-9a22-b314fxx017e5/12036329726967XXXX@g.us/true_12036329726967XXXX@g.us_3EB01F4653XX9XX05E9859_9190043XXXXX@c.us/dbd33c9e-bedc-4df7-8a4c-f9eadf957ac9",
    "size": 19940,
    "filename": "dbd33c9e-bedc-4df7-8a4c-f9eadf957ac9",
    "mimetype": "image/jpeg",
    "dimensions": {
      "ar": 1,
      "width": 512,
      "height": 512
    }
  },
  "performed_by": "harsh.gour@hashlabs.dev",
  "prev_body": null,
  "quoted_message_id": null,
  "sender_phone": "9190043XXXXX@c.us",
  "sent_message_id": "f7b10126-5d5e-432f-941c-94ced28debac",
  "delivery_info": {
    "read": {
       "919XXXXXXXXXXX@c.us": 1731984657443
    },
    "pending": [
      "9184XXXXXXXXXX@c.us",
      "919XXXXXXXXXXX@c.us"
    ],
    "delivered": {
      "919XXXXXXXXXXX@c.us": 1731214159000,
      "919XXXXXXXXXXX@c.us": 1731195010000,
      "919XXXXXXXXXXX@c.us": 1731175846000,
      "919XXXXXXXXXXX@c.us": 1731175848000,
      "919XXXXXXXXXXX@c.us": 1731175847000
    },
    "read_count": 0,
    "delivered_count": 5
  },
   "flag_metadata": {
    "status": false,
    "response_id": "3A1AXXXXXXXXXX",
    "response_type": "message",
    "response_email": "91XXXXXXXXX@c.us",
    "response_timestamp": "2024-11-26T15:16:32.179Z"
  },
  "poll_info": {
    "options": {
      "allowMultipleAnswers": true
    },
    "pollName": "pollQuestion",
    "pollOptions": [
      "option1",
      "option2",
      "option3"
    ]
  },
  "poll_results": {
    "option1": {
      "91903XXXXXX0@c.us": "2024-05-24T15:24:11.336Z"
    },
    "option2": {},
    "option3": {}
  },
  "interactive": null,
  "updated_at": "2024-05-13 11:19:36.114+00",
  "message_ticket_id": null,
  "unique_id": "3EB01F4653XX9XX05E9859"
}

Attributes

string

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

string

The unique identifier of the organization that owns the WhatsApp account.

string

The organization phone where the message was sent or received (in the format {phone_number}@c.us)

string

The delivery and read status acknowledgment of the message. To know more about ack statuses, check the Ack Status Guide

string

The WhatsApp ID of the message author (format: {phone_number}@c.us).

string

The text content of the message. For media messages, this represents the caption.

boolean | null

Indicates if the message was sent as a broadcast message.

string

The type of device used to send the message (e.g., “android”, “ios”, “web”).

boolean

Indicates whether the message has been flagged for attention or review.

number | null

The duration in seconds for audio or video messages. Null for other message types.

string

The number of times this message has been forwarded.

string

The WhatsApp ID of the message sender (format: {phone_number}@c.us).

boolean

Indicates if the message was sent from the organization’s WhatsApp account.

boolean

Indicates if the message contains media content (image, video, audio, or document).

boolean

Indicates if the message is a reply to another message.

boolean

Indicates if the message has received any reactions.

object

Detailed identification information for the message.

Show child attributes

string

A unique identifier for this specific message.

boolean

Indicates if the message was sent by the organization’s WhatsApp account.

string

The chat or group ID where the message was sent.

string

A complete serialized string containing all message identifiers.

object | null

Group invitation details if the message contains a group invite. Null otherwise.

boolean | null

Indicates if the message is configured to disappear after a set time.

boolean

Indicates if the message was forwarded from another chat.

boolean

Indicates if the message contains a GIF animation.

boolean

Indicates if the message has been starred/favorited.

boolean

Indicates if the message is a status update.

string

JSON string containing an array of URLs found in the message.

object | null

Location information if the message contains a shared location.

Show child attributes

number

The latitude coordinate of the shared location.

number

The longitude coordinate of the shared location.

string | null

Unique identifier for media content if present.

string[]

Array of WhatsApp IDs (format: {phone_number}@c.us) mentioned in the message.

string

The type of message content. Possible values: chat, image, video, audio, document, ptt.

string[]

An array of vCards (virtual contact cards).

string

The unique identifier of the chat/group where the message was sent.

string

A unique identifier for the broadcast session.

boolean | null

Is set to true if message is deleted. It is null otherwise.

object | null

Details about media content if present in the message.

Show child attributes

string

The public URL path to access the media file.

number

The size of the media file in bytes.

string

The unique filename of the media file.

string

The MIME type of the media content.

object

Dimensions for image and video content.

Show child attributes

number

The aspect ratio of the media.

number

The width of the media in pixels.

number

The height of the media in pixels.

string

The original content of the message before editing.

string

The ID of the message to which this message is replying to.

string

Phone from which the message was sent.

string

ID of the sent message.

object

Information about message delivery and read status.

Show child attributes

object

Map of phone numbers to timestamps when the message was read.

Show child attributes

number

Timestamp when the message was read by this recipient (format: {phone_number}@c.us).

string[]

Array of recipient WhatsApp IDs who haven’t received the message yet.

object

Map of phone numbers to timestamps when the message was delivered.

Show child attributes

number

Timestamp when the message was delivered to this recipient (format: {phone_number}@c.us).

number

Total number of recipients who have read the message.

number

Total number of recipients the message has been delivered to.

object

Details about message flagging status.

Show child attributes

boolean

Current flag status of the message.

string

Unique identifier for the flag response.

string

The type of flagged content (e.g., “message”).

string

WhatsApp ID of the user who flagged the message (format: {phone_number}@c.us).

string

ISO 8601 formatted timestamp when the message was flagged.

object | null

Information about poll messages.

Show child attributes

object

Poll configuration settings.

Show child attributes

boolean

Indicates if users can select multiple poll options.

string

The poll question or title.

string[]

Array of available poll options.

object

Results of the poll voting.

Show child attributes

object

Voting data for each poll option.

Show child attributes

string

ISO 8601 formatted timestamp when the user voted for this option (format: {phone_number}@c.us).

object | null

Details about interactive surfaces attached to the message (quick-reply buttons, single-select lists, CTA URL buttons). null for non-interactive messages.

Show child attributes

string

The interactive surface kind. One of button, list, cta_url, unknown.

object

Optional header block above the body.

Show child attributes

string

The kind of header. One of image, video, document, location, text, unknown.

string

The header title text, if provided.

string

The main text body of the interactive message. Supports WhatsApp markdown.

string

The small footer line shown beneath the body, above the CTAs.

string

The label of the CTA that opens the list bottom sheet. Present only when type is list.

string

List variant. One of SINGLE_SELECT or UNKNOWN.

array

Tap targets attached to the message, in render order.

Show child attributes

string

Stable identifier for the tap target, echoed back in response messages.

string

The visible button label.

string

The destination URL for cta_url buttons.

string

The dial target for call buttons.

string

The kind of tap target (e.g. quick_reply, cta_url, call, single_select). Open-ended — use for analytics, not for rendering logic.

array

Sections of rows for list surfaces, in render order.

Show child attributes

string

The header above a group of rows.

array

The selectable rows within this section.

Show child attributes

string

Stable identifier used to know which row was tapped.

string

The visible row title.

string

Secondary line shown under the row title.

string

Email address of the user who sent the message through Periskope.

string

ISO 8601 formatted timestamp when the message was sent.

string

ISO 8601 formatted timestamp when the message was last updated.

string

A unique identifier for the message, matching the id.id field.

{
  "message_id": "true_12036329726967XXXX@g.us_3EB01F4653XX9XX05E9859_9190043XXXXX@c.us",
  "org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
  "ack": "2",
  "author": "9190043XXXXX@c.us",
  "body": "Hello, world",
  "broadcast": null,
  "device_type": "android",
  "flag_status": false,
  "duration": null,
  "forwarding_score": "0",
  "from": "9190043XXXXX@c.us",
  "from_me": true,
  "has_media": true,
  "has_quoted_msg": false,
  "has_reaction": false,
  "id": {
    "id": "3EB01F4653XX9XX05E9859",
    "fromMe": true,
    "remote": "12036329726967XXXX@g.us",
    "_serialized": "true_12036329726967XXXX@g.us_3EB01F4653XX9XX05E9859_9190043XXXXX@c.us"
  },
  "invite_v4": null,
  "is_ephemeral": null, //disappearing messages
  "is_forwarded": false,
  "is_gif": false,
  "is_starred": false,
  "is_status": false,
  "links": "[]",
  "location": null,
  "media_key": null,
  "mentioned_ids": [],
  "order_id": null,
  "raw_data": null,
  "to": "12036329726967XXXX@g.us",
  "token": null,
  "message_type": "image",
  "vcards": [],
  "chat_id": "12036329726967XXXX@g.us",
  "timestamp": "2024-05-13 11:19:34+00",
  "org_phone": "9190043XXXXX@c.us",
  "broadcast_id": null,
  "is_deleted": null,
  "media": {
    "path": "/storage/v1/object/public/message-media/2997xx64-89bf-48d3-9a22-b314fxx017e5/12036329726967XXXX@g.us/true_12036329726967XXXX@g.us_3EB01F4653XX9XX05E9859_9190043XXXXX@c.us/dbd33c9e-bedc-4df7-8a4c-f9eadf957ac9",
    "size": 19940,
    "filename": "dbd33c9e-bedc-4df7-8a4c-f9eadf957ac9",
    "mimetype": "image/jpeg",
    "dimensions": {
      "ar": 1,
      "width": 512,
      "height": 512
    }
  },
  "performed_by": "harsh.gour@hashlabs.dev",
  "prev_body": null,
  "quoted_message_id": null,
  "sender_phone": "9190043XXXXX@c.us",
  "sent_message_id": "f7b10126-5d5e-432f-941c-94ced28debac",
  "delivery_info": {
    "read": {
       "919XXXXXXXXXXX@c.us": 1731984657443
    },
    "pending": [
      "9184XXXXXXXXXX@c.us",
      "919XXXXXXXXXXX@c.us"
    ],
    "delivered": {
      "919XXXXXXXXXXX@c.us": 1731214159000,
      "919XXXXXXXXXXX@c.us": 1731195010000,
      "919XXXXXXXXXXX@c.us": 1731175846000,
      "919XXXXXXXXXXX@c.us": 1731175848000,
      "919XXXXXXXXXXX@c.us": 1731175847000
    },
    "read_count": 0,
    "delivered_count": 5
  },
   "flag_metadata": {
    "status": false,
    "response_id": "3A1AXXXXXXXXXX",
    "response_type": "message",
    "response_email": "91XXXXXXXXX@c.us",
    "response_timestamp": "2024-11-26T15:16:32.179Z"
  },
  "poll_info": {
    "options": {
      "allowMultipleAnswers": true
    },
    "pollName": "pollQuestion",
    "pollOptions": [
      "option1",
      "option2",
      "option3"
    ]
  },
  "poll_results": {
    "option1": {
      "91903XXXXXX0@c.us": "2024-05-24T15:24:11.336Z"
    },
    "option2": {},
    "option3": {}
  },
  "interactive": null,
  "updated_at": "2024-05-13 11:19:36.114+00",
  "message_ticket_id": null,
  "unique_id": "3EB01F4653XX9XX05E9859"
}

API

Chat APIs

Group Settings APIs

Message APIs

Contact APIs

Ticket APIs

Custom Property APIs

Task APIs

Queue APIs

Phone APIs

Notes APIs

Reaction APIs

Knowledge Base APIs

Member APIs

AI APIs

Webhook APIs

Webhooks