string
WhatsApp message id, in the form <from_me><chat_id><hash>. Accepted wherever a message_id path parameter is expected.
string
Provisional id assigned when the message was queued via the API — the same value returned by POST /message/send. Also accepted wherever a message_id path parameter is expected. null for messages that did not originate from the API.
string
Id of the organization the message belongs to
string
Org phone (WhatsApp account) the message was sent or received on, suffixed with @c.us
string
Chat the message belongs to — <countrycode><number>@c.us for 1-1 chats, <group-id>@g.us for group chats
string
Text content of the message, or the caption for media messages. null when the message has no text.
string
Content type of the message: ‘chat’ for text, or e.g. ‘image’, ‘video’, ‘document’, ‘audio’, ‘ptt’, ‘poll_creation’, ‘location’, ‘vcard’
string
When the message was sent, as an ISO 8601 timestamp
boolean
Whether the message was sent by the org phone (true) or received from the contact (false)
string
Delivery acknowledgement level as a string: ‘-1’ failed, ‘0’ pending, ‘1’ sent, ‘2’/‘3’ delivered, ‘4’ read, ‘5’ played. null when unknown.
string
Who triggered the message from Periskope: a member’s email, or ‘api’ when sent via the API. null for messages sent from the phone itself.
string
chat_id of the actual sender — in group chats this is the participant who sent the message
string
message_id of the message this one replies to (set via reply_to when sending). null when not a reply.
string
Id of the broadcast that produced this message, when it was sent via POST /message/broadcast. null otherwise.
boolean
Whether the message has been deleted for everyone. null when never deleted.
object
Media attached to the message. null for text-only messages.
string[]
chat_ids of the participants mentioned in the message
string
Previous text content, kept when the message was edited. null when never edited.
string
Internal queue job id (queue_id) that produced this message when it was sent through the message queue. null otherwise.
object
Per-recipient delivery and read receipts. null when no receipts have been recorded.
object
The poll definition ({pollName, pollOptions, options}) for poll_creation messages. null otherwise.
object
Votes cast on the poll, as a map of option name to voters. null for non-poll messages.
boolean
Whether the message is currently flagged for follow-up in Periskope. null when never flagged.
string
When the message record was last updated, as an ISO 8601 timestamp
object[]
Reactions placed on the message. Present on GET /message/{message_id}; an empty array when there are none.