This use case queries Messages of the Identity.

Parameters

All parameters are optional. If no parameter is given, all Messages are returned.

  • createdBy is the enmeshed Address of the Identity that created the Messsage.
  • createdByDevice is the id of the Device that created the File.
  • createdAt is the ISODateTime the Message was created at.
  • attachments are the File ids of the respective attachments.
  • recipients.address are the enmeshed Addresses of the Identities the Message was sent to.
  • recipients.relationshipId are the Relationship ids of the respective recipient.
  • participant is either the enmeshed Address of the sender or enmeshed Addresses of the Identities the Message was sent to.
  • content.@type the type of structure of the Message’s content
  • content.body the body of the Mail, if the Message is of type Mail
  • content.subject the subject of the Mail, if the Message is of type Mail

On Success

  • Returns all Messages that match the query.

On Failure

  • The parameters are malformed.

How to execute this use case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use case. This use case can be executed with the REST API of the Connector which you can Access the Connector.
Corresponding interactive API docs excerpt: