Message object

id

Unique identifier of the message for Unipile.

Can be used to prevent duplicate entries.

chat_id

Unique identifier of the parent chat for Unipile.

Can be used to retrieve the parent chat.

provider_id

Unique identifier of the message for the provider.

Can be use to reference the message in the native web app of the provider.

chat_provider_id

Unique identifier of the parent chat for the provider.

Can be use to reference the chat in the native web app of the provider. For exemple, if you need a link "Open chat in LinkedIn".

account_id

Unique identifier of the parent account.

text

Textual body of the message.

Unipile does not support formatted text yet and will return plain text.

attachments

List of attachments.

sender_id

Unique identifier of the sender for the provider.

The format is specific to each provider, it can be a phone number, an email, a username or an ID.

Can be used to match attendees if any. In cases you don't have the attendee, you can still display this sender_id to identify the sender.

timestamp

Provider's server acknowledge datetime.

Can be used as message sent date.

is_sender

Boolean telling if the message sender is the account's user or someone else.

Can be used to design a message bubble.

seen

Per provider support

If is_sender is true, Boolean telling if the message has been seen / read by at least one recipient.

If is_sender is false, Boolean telling if the message has been seen / read by the connected user, which can be the case if the message is get after being seen on another app or device.

seen_by

Per provider support

List of message read receipts.

The key is the provider's user id, and the value can be a boolean telling if the message has been seen / read by this user, or a timestamp telling when it was seen / read.

delivered

Per provider support

Boolean telling if the message has been delivered to the recipient. Note that, depending on the provider, it does not guarantee that it's delivered to the recipient, but only to the provider's server.

hidden

Boolean telling if the message should be hidden in the conversation view.

For exemple, messages of type "John reacted 👍 to your message" are hidden, but visible as last message in chat lists.

deleted

Boolean telling if the message has been deleted.

Can be used to replace the content of a message by a generic "Message deleted"

edited

Per provider support

Boolean telling if the message has been edited.

is_event

Boolean telling the message is not an actual user message, but an event, specified by event_type.

event_type

If is_event is true, the type of event. Unipile support the following events :

• A user reacted to a message
• The group was created
• The group has changed title
• A new participant was added to the group
• A participant was removed from the group
• A participant left the group
• Missed voice call
• Missed audio call

Some providers shows other kinds of events. Unipile does not support them yet and will set event_type as unknown.

reactions

A list of reactions to the message.

quoted

Quoted message details if any.

Note that some providers (ex:WhatsApp) use the term "reply" in their UI, but Unipile prefer to use the term "quote" to distinguish it from threaded replies.