GET api/v1/reports/messages/standard?filter.RecentDays={filter.RecentDays}&filter.Status={filter.Status}&filter.Reference={filter.Reference}&filter.ReportDetailedErrorInfo={filter.ReportDetailedErrorInfo}&filter.SoftwareVersion={filter.SoftwareVersion}&filter.StartDate={filter.StartDate}&filter.EndDate={filter.EndDate}&filter.Range={filter.Range}&filter.Destination={filter.Destination}&paging.ReportID={paging.ReportID}&paging.Page={paging.Page}&paging.NoOfRecords={paging.NoOfRecords}

Retrieves a report on all the standard SMS messages for the account. Paging and filtering can be applied. There are three different ways to specify which values you want to include inside your report. These are 'Range', 'StartDate and EndDate' and 'RecentDays'. NOTE: at least one parameter needs to be used, otherwise the response will not return anything. Only one parameter can be used at the time to filter out the data when the report is returned. If more than one parameters are supplied, they will be prioritized in this order Range > RecentsDays > startDate and EndDate.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RecentDays

Return the last x number of days traffic. Max. 14

integer

None.

Status

Return only the messages that are the status provided.

StatusList

None.

Reference

Return only the messages that contain the reference provided.

string

None.

ReportDetailedErrorInfo

Return the detail error message from the networks.

boolean

None.

StartDate

The date for the records to start from.

date

None.

EndDate

The date for the records to finish.

date

None.

Range

Date ranges to search records for.

DateRange

None.

Destination

To search for a particular Short Code

string

None.

ReportID

The ID of the report.

string

None.

Page

The Page number for the report.

integer

Required

NoOfRecords

The number of records to return per page.

integer

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfReportStandardResponseData
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfReportStandardResponseData

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": {
      "Messages": [
        {
          "ID": "sample string 1",
          "Status": "sample string 2",
          "Error": "sample string 3",
          "DateSubmitted": "2017-11-17T15:48:04.4038082Z",
          "DateSent": "2017-11-17T15:48:04.4038082Z",
          "DateReceived": "2017-11-17T15:48:04.4038082Z",
          "Text": "sample string 7",
          "Destination": "sample string 8",
          "Reference": "sample string 9"
        },
        {
          "ID": "sample string 1",
          "Status": "sample string 2",
          "Error": "sample string 3",
          "DateSubmitted": "2017-11-17T15:48:04.4038082Z",
          "DateSent": "2017-11-17T15:48:04.4038082Z",
          "DateReceived": "2017-11-17T15:48:04.4038082Z",
          "Text": "sample string 7",
          "Destination": "sample string 8",
          "Reference": "sample string 9"
        }
      ],
      "ReportTitle": "sample string 1",
      "ReportID": "sample string 2",
      "ItemsPerPage": "sample string 3",
      "Page": "sample string 4",
      "TotalItems": "sample string 5"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfReportStandardResponseData 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>
      <Messages>
        <StandardReportMessages>
          <ID>sample string 1</ID>
          <Status>sample string 2</Status>
          <Error>sample string 3</Error>
          <DateSubmitted>2017-11-17T15:48:04.4038082Z</DateSubmitted>
          <DateSent>2017-11-17T15:48:04.4038082Z</DateSent>
          <DateReceived>2017-11-17T15:48:04.4038082Z</DateReceived>
          <Text>sample string 7</Text>
          <Destination>sample string 8</Destination>
          <Reference>sample string 9</Reference>
        </StandardReportMessages>
        <StandardReportMessages>
          <ID>sample string 1</ID>
          <Status>sample string 2</Status>
          <Error>sample string 3</Error>
          <DateSubmitted>2017-11-17T15:48:04.4038082Z</DateSubmitted>
          <DateSent>2017-11-17T15:48:04.4038082Z</DateSent>
          <DateReceived>2017-11-17T15:48:04.4038082Z</DateReceived>
          <Text>sample string 7</Text>
          <Destination>sample string 8</Destination>
          <Reference>sample string 9</Reference>
        </StandardReportMessages>
      </Messages>
      <ReportTitle>sample string 1</ReportTitle>
      <ReportID>sample string 2</ReportID>
      <ItemsPerPage>sample string 3</ItemsPerPage>
      <Page>sample string 4</Page>
      <TotalItems>sample string 5</TotalItems>
    </Detail>
  </ResponseData>
</ResponseOfReportStandardResponseData>