Get Message Summaries

post

https://sandbox.datamotion.com/SecureMessagingApi/Message/GetMessageSummaries

This method is used to retrieve message summaries of all messages within a specified folder. A session key must be submitted via the X-Session-Key header. Include the LastMessageIdReceived request body parameter to specify the last message ID received to receive summaries only for messages created since the ID reference. A successful transaction will receive a 200 status code.

Body Params

Get message summaries request data

FolderId

int32

required

The ID of the Inbox folder to search (primary Inbox folder ID = 1)

LastMessageIdReceived

int32

Used to specify the last message ID received to receive summaries only for messages created since the ID reference.

SortBy

string

Used to determine the field to sort returned messages by. (Valid values "MID", "CreateTime", "ExpireTime", "FirstRecipientEmail", "Subject", "FromEmail", "MsgSize", "Priority")

SortDirection

string

Used to specify the sort direction to apply SortBy field on. (Valid values "ASC", "DESC")

PageSize

int32

Used to specify the Page Size of the returned message list. (Valid values 10 - 100)

PageNum

int32

Used to specify the the Page Number of the returned message list.

Filter

string

Used to filter the results by one or many search terms delimited by a '|'

Headers

X-Session-Key

string

Responses

400

The GetMessageSummariesRequestData model is required in the request body.

401

The X-Session-Key header is missing. || Bad session key. || Session key expired. || FolderId [FolderId] not found. || An error has occurred at [DateTime] please check the server logs for details.

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok