Attributes

org_id
string

Unique identifier for the organization.

chat_id
string

Unique identifier for the chat.

message_id
string

Unique identifier for the message.

ack
string

Acknowledgement status of the message.

id
object
author
string

The author of the message.

body
string

The message body. Represents caption for media messages.

broadcast
boolean

Indicates if the message is a broadcast message.

device_type
string

Type of device used to send the message.

duration
string

Duration of the message.

forwarding_score
string

Score of the times message has been forwarded.

from
string

The sender of the message.

from_me
boolean

Indicates if the message was sent by the organization phone.

has_media
boolean

Indicates if the message has media.

has_quoted_msg
boolean

Indicates if the message is a reply message and has a quoted message.

has_reaction
boolean

Indicates if the message has a reaction.

invite_v4
object

Invite for the chat.

is_ephemeral
boolean

Indicates if the message is ephemeral.

is_forwarded
boolean

Indicates if the message is forwarded.

is_gif
boolean

Indicates if the message is a GIF.

is_starred
boolean

Indicates if the message is starred.

is_status
boolean

Indicates if the message is a status message.

Array of links present in the message.

location
object

Location details of the message.

media_key
string

Key for the media.

mentioned_ids
string[]

Array of mentioned user IDs in message.

order_id
string

Order ID for the message. Applicable for business chats with order details.

raw_data
string

Raw data of the message.

to
string

The recipient chat of the message.

token
string

Token for the message.

message_type
string

Type of the message. Possible values - chat | image | video | audio | document | ptt

vcards
string[]

Array of vCards present in the message.

Each vCard is a string.

Example: ["BEGIN:VCARD\nVERSION:3.0\nFN:John Doe\nTEL:1234567890\nEND:VCARD"]

timestamp
string

Timestamp of the message.

org_phone
string

Phone number of the organization.

broadcast_id
string

Unique identifier for the broadcast message.

is_deleted
boolean

Indicates if the message is deleted.

media
object

Media details of the message.

performed_by
string

The user who performed the action. Only applicable for messages sent from periskope.

prev_body
string

The previous body of the message. Only applicable for edited messages.

quoted_message_id
string

Unique identifier for the quoted message. Quoted message is the message current message is being replied to.

sender_phone
string

Unique identifier for sender phone.

sent_message_id
string

Unique identifier for the sent message. Only applicable if message is sent from Periskope.

delivery_info
object

Delivery information of the message.

flag_status
boolean

Indicates if the message is flagged.

flag_metadata
object

Metadata about message flagging status.

updated_at
object

Timestamp when the message was last updated.

message_ticket_id
string

Unique identifier for the ticket raised on the message. Only applicable for tickets raised on messages in Periskope.

unique_id
string

Unique identifier for the message.

reactions
array

Array of reaction objects

poll_info
object

Information about the poll message.

poll_results
object

Results of the poll showing votes for each option.