Model: Conversation

Back to overview

Model Fields

Field Description Type Optional Nullable Default
type

The receiver type

Allowed values: "me", "contact", "group", "distributionList"

String False False
id

The identity of the responder

String False False
position

The index of the message (for sorting purposes)

Integer False False
messageCount

Number of messages

Integer False False
unreadCount

Number of unread messages

Integer False False
latestMessage

The latest message's content

Map<Message> True False
receiver

The receiver

Map<Receiver> True False
avatar

The avatar of the receiver. Only set for the top 20-30 conversations.

Binary True False
notifications

Notification settings

Map<NotificationSettings> True False
isStarred

Whether the conversation is starred

Boolean True False False
isUnread

Whether the conversation was explicitly marked as unread.

Note that a non-zero unreadCount always takes precedence over this flag.

Boolean True False False