Message: response / receivers (app -> client)

Back to overview

Return the list of receivers (contacts, groups, etc.).

This message MUST be sent by the app in case the list of receivers has been requested by the client.

Acknowledgement

This message acknowledges:

Message Condition Error Codes
request/receivers (client -> app)

(None)
Name Description
internalError

An internal error occurred

Args

None

Data

Field Description Type Optional Nullable
contact

List of contact receivers

 Array<Contact> False False
group

List of group receivers

 Array<Group> False False
distributionList

List of distribution list receivers

 Array<DistributionList> False False

Models

Contact

Field Description Type Optional Nullable Default
id

The Threema identity (8 characters)

 String False False
displayName

The contact display name

This is generated by the app from the first and last name, depending on the display logic (either "firstname lastname" or "lastname firstname").

 String False False
color

The contact color in hex notation (e.g. "#1122FF")

 String False False
firstName

The contact first name (max 256 bytes)

 String True False
lastName

The contact last name (max 256 bytes)

 String True False
publicNickname

The contact public nickname (without preceding ~, max 32 bytes)

 String True False
verificationLevel

The verification level

  • 1: Unverified (red)
  • 2: Server verified (yellow)
  • 3: Fully verified (green)

Allowed values: 1, 2, 3

Integer False False
state

The identity state

Allowed values: "ACTIVE", "INACTIVE", "INVALID"

String False False
featureMask

The feature mask is a bitmask indicating support for certain features.

Bit values:

  • 0x01: Audio messages
  • 0x02: Group chat
  • 0x04: Ballots
  • 0x08: File transfer
  • 0x10: VoIP calls

Example: A client with feature mask 0x07 supports audio messages, group chat and ballots, but no file transfers and no VoIP calls.

 Integer False False
isWork

Whether this is a contact from the same Threema Work package.
Only relevant for Threema Work users.

 Boolean True False False
identityType

The identity type

  • 0: Regular Threema user
  • 1: Threema Work user

Allowed values: 0, 1

Integer False False
publicKey

The contact public key

 Binary False False
isBlocked

Whether this contact is blocked.

 Boolean True False False
locked

Whether the chat with this contact is locked. This is used for private chats.

 Boolean False False
visible

Whether the chat with this contact is visible. This is used for private chats.

 Boolean False False
hidden

The contact is hidden (e.g. because it is part of a group, but was never added to the address book or contacted)

 Boolean False False
access

The access object

 Map<ContactReceiverAccess> False False

Group

Field Description Type Optional Nullable Default
id

The group identity

 String False False
name

The group name (max 256 bytes)

 String True False
displayName

The group display name

 String False False
color

The group color in hex notation (e.g. "#1122FF")

 String False False
createdAt

The group creation date as a unix time stamp in seconds

 Integer False False
disabled

This is set to true if the user is not a member of this group anymore

 Boolean True False False
locked

This is set to true if the chat is marked as a secret chat

 Boolean True False False
visible

This is set to false if the chat is marked as a secret chat and if secret chats are hidden in the app

 Boolean True False True
members

The list of group member identities

 Array<String> False False
administrator

The identity of the group admin

 String False False
access

The access object

 Map<GroupReceiverAccess> False False

DistributionList

Field Description Type Optional Nullable Default
id

The distribution list id

 String False False
displayName

The distribution list display name

 String False False
color

The distribution list color in hex notation (e.g. "#1122FF")

 String False False
locked

Set to true if the chat is marked as a secret chat

 Boolean True False False
visible

Set to false if the chat is marked as a secret chat and if secret chats are hidden in the app

 Boolean True False True
members

The list of group member identities

 Array<String> False False
access

The access object

 Map<DistributionListReceiverAccess> False False

ContactReceiverAccess

Field Description Type Optional Nullable Default
canDelete

Whether this contact can be deleted

 Boolean False False
canChangeAvatar

Whether the avatar of this group can be changed

 Boolean False False
canChangeFirstName

Whether the first name of this contact can be changed

 Boolean False False
canChangeLastName

Whether the last name of this contact can be changed

 Boolean False False

GroupReceiverAccess

Field Description Type Optional Nullable Default
canDelete

Whether this group can be deleted

 Boolean False False
canChangeAvatar

Whether the group avatar can be changed

 Boolean False False
canChangeName

Whether the group name can be changed

 Boolean False False
canChangeMembers

Whether the group members can be changed

 Boolean False False
canLeave

Whether this group can be left

 Boolean False False
canSync

Whether the group can be re-synced

 Boolean False False

DistributionListReceiverAccess

Field Description Type Optional Nullable Default
canDelete

Whether this distribution list can be deleted

 Boolean False False
canChangeMembers

Whether the distribution list members can be changed

 Boolean False False