GET api/v1/reports/messages?filter.User={filter.User}&filter.Status={filter.Status}&filter.ReadStatus={filter.ReadStatus}&filter.ReadResponseStatus={filter.ReadResponseStatus}&filter.StartDate={filter.StartDate}&filter.EndDate={filter.EndDate}&filter.Range={filter.Range}&filter.Destination={filter.Destination}&filter.Reference={filter.Reference}&paging.Page={paging.Page}&paging.NoOfRecords={paging.NoOfRecords}&sort.Field={sort.Field}&sort.AscendingDescending={sort.AscendingDescending}

Retrieves all the details for the secure/long message for a given contact.

Request Information

URI Parameters

Name	Description	Type	Additional information
User	By user who sent the message.	globally unique identifier	None.
Status	By the status of the message.	StatusSecure	None.
ReadStatus	By whether the recipients have read the message.	ReadStatus	None.
ReadResponseStatus	By whether the response message has been read.	StatusResponse	None.
StartDate	The date for the records to start from. The format is the following:[YYYY-MM-DDTHH:MM:SSZ]	date	None.
EndDate	The date for the records to finish. The format is the following:[YYYY-MM-DDTHH:MM:SSZ]	date	None.
Range	Date ranges to search records for.	DateRange	None.
Destination	To search for a particular Short Code	string	None.
Reference	To search for a Reference	string	None.
Page	The Page number for the report.	integer	Required
NoOfRecords	The number of records to return per page.	integer	Required
Field	The field to sort the records by.	SortField	None.
AscendingDescending	Determines whether to sort the records in ascending or descending order.	boolean	None.

Body Parameters

None.

Response Information

Resource Description

A list messages sent via SMS+ encrypted messaging.

ResponseOfReport[]

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfReport[]	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "DateSent": "2025-01-21T16:19:57.6657329+00:00",
        "MessageID": "328dbb6a-d57a-41eb-9b3e-ca74a312c259",
        "NoofContacts": 3,
        "NoofResponses": 4,
        "NumberOfRead": 5,
        "ReadLimit": "sample string 6",
        "Reference": "sample string 7",
        "Sender": "sample string 8",
        "Status": "sample string 9",
        "UnreadResponses": true,
        "statusBarColor": "sample string 11"
      },
      {
        "DateSent": "2025-01-21T16:19:57.6657329+00:00",
        "MessageID": "328dbb6a-d57a-41eb-9b3e-ca74a312c259",
        "NoofContacts": 3,
        "NoofResponses": 4,
        "NumberOfRead": 5,
        "ReadLimit": "sample string 6",
        "Reference": "sample string 7",
        "Sender": "sample string 8",
        "Status": "sample string 9",
        "UnreadResponses": true,
        "statusBarColor": "sample string 11"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Report>
        <DateSent>2025-01-21T16:19:57.6657329+00:00</DateSent>
        <MessageID>328dbb6a-d57a-41eb-9b3e-ca74a312c259</MessageID>
        <NoofContacts>3</NoofContacts>
        <NoofResponses>4</NoofResponses>
        <NumberOfRead>5</NumberOfRead>
        <ReadLimit>sample string 6</ReadLimit>
        <Reference>sample string 7</Reference>
        <Sender>sample string 8</Sender>
        <Status>sample string 9</Status>
        <UnreadResponses>true</UnreadResponses>
        <statusBarColor>sample string 11</statusBarColor>
      </Report>
      <Report>
        <DateSent>2025-01-21T16:19:57.6657329+00:00</DateSent>
        <MessageID>328dbb6a-d57a-41eb-9b3e-ca74a312c259</MessageID>
        <NoofContacts>3</NoofContacts>
        <NoofResponses>4</NoofResponses>
        <NumberOfRead>5</NumberOfRead>
        <ReadLimit>sample string 6</ReadLimit>
        <Reference>sample string 7</Reference>
        <Sender>sample string 8</Sender>
        <Status>sample string 9</Status>
        <UnreadResponses>true</UnreadResponses>
        <statusBarColor>sample string 11</statusBarColor>
      </Report>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfReport>