Attributes
A unique identifier for the message, containing information about the chat, sender, and message details.
The unique identifier of the organization that owns the WhatsApp account.
The organization phone where the message was sent or received (in the format {phone_number}@c.us)
The delivery and read status acknowledgment of the message.
To know more about ack statuses, check the Ack Status Guide The WhatsApp ID of the message author (format: {phone_number}@c.us).
The text content of the message. For media messages, this represents the caption.
Indicates if the message was sent as a broadcast message.
The type of device used to send the message (e.g., “android”, “ios”, “web”).
Indicates whether the message has been flagged for attention or review.
The duration in seconds for audio or video messages. Null for other message types.
The number of times this message has been forwarded.
The WhatsApp ID of the message sender (format: {phone_number}@c.us).
Indicates if the message was sent from the organization’s WhatsApp account.
Indicates if the message contains media content (image, video, audio, or document).
Indicates if the message is a reply to another message.
Indicates if the message has received any reactions.
Detailed identification information for the message.
A unique identifier for this specific message.
Indicates if the message was sent by the organization’s WhatsApp account.
The chat or group ID where the message was sent.
A complete serialized string containing all message identifiers.
Group invitation details if the message contains a group invite. Null otherwise.
Indicates if the message is configured to disappear after a set time.
Indicates if the message was forwarded from another chat.
Indicates if the message contains a GIF animation.
Indicates if the message has been starred/favorited.
Indicates if the message is a status update.
JSON string containing an array of URLs found in the message.
Location information if the message contains a shared location.
The latitude coordinate of the shared location.
The longitude coordinate of the shared location.
Unique identifier for media content if present.
Array of WhatsApp IDs (format: {phone_number}@c.us) mentioned in the message.
The type of message content. Possible values: chat, image, video, audio, document, ptt.
An array of vCards (virtual contact cards).
The unique identifier of the chat/group where the message was sent.
A unique identifier for the broadcast session.
Is set to true if message is deleted. It is null otherwise.
Details about media content if present in the message.
The public URL path to access the media file.
The size of the media file in bytes.
The unique filename of the media file.
The MIME type of the media content.
Dimensions for image and video content.
The aspect ratio of the media.
The width of the media in pixels.
The height of the media in pixels.
The original content of the message before editing.
The ID of the message to which this message is replying to.
Phone from which the message was sent.
Information about message delivery and read status.
Map of phone numbers to timestamps when the message was read.
Timestamp when the message was read by this recipient (format: {phone_number}@c.us).
Array of recipient WhatsApp IDs who haven’t received the message yet.
Map of phone numbers to timestamps when the message was delivered.
Timestamp when the message was delivered to this recipient (format: {phone_number}@c.us).
Total number of recipients who have read the message.
Total number of recipients the message has been delivered to.
Details about message flagging status.
Current flag status of the message.
Unique identifier for the flag response.
The type of flagged content (e.g., “message”).
WhatsApp ID of the user who flagged the message (format: {phone_number}@c.us).
ISO 8601 formatted timestamp when the message was flagged.
Information about poll messages.
Poll configuration settings.
Indicates if users can select multiple poll options.
The poll question or title.
Array of available poll options.
Results of the poll voting.
Voting data for each poll option.
ISO 8601 formatted timestamp when the user voted for this option (format: {phone_number}@c.us).
Email address of the user who sent the message through Periskope.
ISO 8601 formatted timestamp when the message was sent.
ISO 8601 formatted timestamp when the message was last updated.
A unique identifier for the message, matching the id.id field.
{
"message_id": "[email protected][email protected]",
"org_id": "2997xx64-89bf-48d3-9a22-b314fxx017e5",
"ack": "2",
"author": "[email protected]",
"body": "Hello, world",
"broadcast": null,
"device_type": "android",
"flag_status": false,
"duration": null,
"forwarding_score": "0",
"from": "[email protected]",
"from_me": true,
"has_media": true,
"has_quoted_msg": false,
"has_reaction": false,
"id": {
"id": "3EB01F4653XX9XX05E9859",
"fromMe": true,
"remote": "[email protected]",
"_serialized": "[email protected][email protected]"
},
"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": "[email protected]",
"token": null,
"message_type": "image",
"vcards": [],
"chat_id": "[email protected]",
"timestamp": "2024-05-13 11:19:34+00",
"org_phone": "[email protected]",
"broadcast_id": null,
"is_deleted": null,
"media": {
"path": "/storage/v1/object/public/message-media/2997xx64-89bf-48d3-9a22-b314fxx017e5/[email protected]/[email protected][email protected]/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": "[email protected]",
"prev_body": null,
"quoted_message_id": null,
"sender_phone": "[email protected]",
"sent_message_id": "f7b10126-5d5e-432f-941c-94ced28debac",
"delivery_info": {
"read": {
"[email protected]": 1731984657443
},
"pending": [
"[email protected]",
"[email protected]"
],
"delivered": {
"[email protected]": 1731214159000,
"[email protected]": 1731195010000,
"[email protected]": 1731175846000,
"[email protected]": 1731175848000,
"[email protected]": 1731175847000
},
"read_count": 0,
"delivered_count": 5
},
"flag_metadata": {
"status": false,
"response_id": "3A1AXXXXXXXXXX",
"response_type": "message",
"response_email": "[email protected]",
"response_timestamp": "2024-11-26T15:16:32.179Z"
},
"poll_info": {
"options": {
"allowMultipleAnswers": true
},
"pollName": "pollQuestion",
"pollOptions": [
"option1",
"option2",
"option3"
]
},
"poll_results": {
"option1": {
"[email protected]": "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"
}
