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",
    "participant": {
      "user": "9190043XXXXX",
      "server": "c.us",
      "_serialized": "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": {}
  },
  "updated_at": "2024-05-13 11:19:36.114+00",
  "message_ticket_id": null,
  "unique_id": "3EB01F4653XX9XX05E9859",
  "reactions": [
      {
          "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
          "message_id": "true_919537851844@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C",
          "ack": null,
          "id": {
              "id": "3EB0A92AE3DE31D97BAEC6",
              "remote": "919537851844@c.us",
              "from_me": true,
              "serialized": "true_919537851844@c.us_3EB0A92AE3DE31D97BAEC6"
          },
          "orphan": null,
          "reaction": "😄",
          "read": true,
          "reaction_id": "true_919537851844@c.us_3EB0A92AE3DE31D97BAEC6",
          "timestamp": "2025-01-28T05:11:57.008+00:00",
          "msg_id": {
              "id": "3EB0C62861626B2D8BD4A386E48976EC85CB009C",
              "remote": "919537851844@c.us",
              "from_me": true,
              "serialized": "true_919537851844@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C"
          },
          "orphan_reason": null,
          "sender_id": "918527184400@c.us",
          "org_phone": "918527184400@c.us",
          "chat_id": "919537851844@c.us",
          "unique_id": "3EB0C62861626B2D8BD4A386E48976EC85CB009C"
      }
  ]
}

Attributes

message_id

string

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

org_id

string

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

ack

string

The delivery and read status acknowledgment of the message.

author

string

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

body

string

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

broadcast

boolean | null

Indicates if the message was sent as a broadcast message.

device_type

string

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

flag_status

boolean

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

duration

number | null

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

forwarding_score

string

The number of times this message has been forwarded.

from

string

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

from_me

boolean

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

has_media

boolean

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

has_quoted_msg

boolean

Indicates if the message is a reply to another message.

has_reaction

boolean

Indicates if the message has received any reactions.

object

Detailed identification information for the message.

invite_v4

object | null

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

is_ephemeral

boolean | null

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

is_forwarded

boolean

Indicates if the message was forwarded from another chat.

is_gif

boolean

Indicates if the message contains a GIF animation.

is_starred

boolean

Indicates if the message has been starred/favorited.

is_status

boolean

Indicates if the message is a status update.

links

string

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

location

object | null

Location information if the message contains a shared location.

media_key

string | null

Unique identifier for media content if present.

mentioned_ids

string[]

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

message_type

string

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

vcards

string[]

An array of vCards (virtual contact cards).

chat_id

string

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

broadcast_id

string

A unique identifier for the broadcast session.

is_deleted

boolean | null

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

media

object | null

Details about media content if present in the message.

prev_body

string

The original content of the message before editing.

quoted_message_id

string

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

sender_phone

string

Phone from which the message was sent.

sent_message_id

string

ID of the sent message.

delivery_info

object

Information about message delivery and read status.

flag_metadata

object

Details about message flagging status.

poll_info

object | null

Information about poll messages.

poll_results

object

Results of the poll voting.

performed_by

string

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

timestamp

string

ISO 8601 formatted timestamp when the message was sent.

updated_at

string

ISO 8601 formatted timestamp when the message was last updated.

unique_id

string

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

reactions

array

Array of reaction objects containing information about message reactions.

{
  "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",
    "participant": {
      "user": "9190043XXXXX",
      "server": "c.us",
      "_serialized": "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": {}
  },
  "updated_at": "2024-05-13 11:19:36.114+00",
  "message_ticket_id": null,
  "unique_id": "3EB01F4653XX9XX05E9859",
  "reactions": [
      {
          "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
          "message_id": "true_919537851844@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C",
          "ack": null,
          "id": {
              "id": "3EB0A92AE3DE31D97BAEC6",
              "remote": "919537851844@c.us",
              "from_me": true,
              "serialized": "true_919537851844@c.us_3EB0A92AE3DE31D97BAEC6"
          },
          "orphan": null,
          "reaction": "😄",
          "read": true,
          "reaction_id": "true_919537851844@c.us_3EB0A92AE3DE31D97BAEC6",
          "timestamp": "2025-01-28T05:11:57.008+00:00",
          "msg_id": {
              "id": "3EB0C62861626B2D8BD4A386E48976EC85CB009C",
              "remote": "919537851844@c.us",
              "from_me": true,
              "serialized": "true_919537851844@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C"
          },
          "orphan_reason": null,
          "sender_id": "918527184400@c.us",
          "org_phone": "918527184400@c.us",
          "chat_id": "919537851844@c.us",
          "unique_id": "3EB0C62861626B2D8BD4A386E48976EC85CB009C"
      }
  ]
}

Was this page helpful?

The Reaction Object The Contact 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",
    "participant": {
      "user": "9190043XXXXX",
      "server": "c.us",
      "_serialized": "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": {}
  },
  "updated_at": "2024-05-13 11:19:36.114+00",
  "message_ticket_id": null,
  "unique_id": "3EB01F4653XX9XX05E9859",
  "reactions": [
      {
          "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
          "message_id": "true_919537851844@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C",
          "ack": null,
          "id": {
              "id": "3EB0A92AE3DE31D97BAEC6",
              "remote": "919537851844@c.us",
              "from_me": true,
              "serialized": "true_919537851844@c.us_3EB0A92AE3DE31D97BAEC6"
          },
          "orphan": null,
          "reaction": "😄",
          "read": true,
          "reaction_id": "true_919537851844@c.us_3EB0A92AE3DE31D97BAEC6",
          "timestamp": "2025-01-28T05:11:57.008+00:00",
          "msg_id": {
              "id": "3EB0C62861626B2D8BD4A386E48976EC85CB009C",
              "remote": "919537851844@c.us",
              "from_me": true,
              "serialized": "true_919537851844@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C"
          },
          "orphan_reason": null,
          "sender_id": "918527184400@c.us",
          "org_phone": "918527184400@c.us",
          "chat_id": "919537851844@c.us",
          "unique_id": "3EB0C62861626B2D8BD4A386E48976EC85CB009C"
      }
  ]
}

API

Chat APIs

Group Settings APIs

Message APIs

Contact APIs

Ticket APIs

Queue APIs

Phone APIs

Webhooks