GET api/v1/reports/messages/pendingandrecurring?filter.Range={filter.Range}&filter.RecentDays={filter.RecentDays}&filter.Referenece={filter.Referenece}&filter.ReportType={filter.ReportType}&filter.SoftwareVersion={filter.SoftwareVersion}&filter.StartDate={filter.StartDate}&filter.EndDate={filter.EndDate}&filter.Destination={filter.Destination}&paging.ReportID={paging.ReportID}&paging.Page={paging.Page}&paging.NoOfRecords={paging.NoOfRecords}

Retrieves all messages that are scheduled or all recurring messages setup on the account. Paging and filtering can be applied.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Range

Date ranges to search records for.

FutureDateRange

None.

RecentDays

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

integer

None.

Referenece

Return all messages that have a given reference.

string

None.

ReportType

The type of the messages to be returned.

ReportType

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

ResponseOfReportPendingAndRecurringResponseData
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfReportPendingAndRecurringResponseData

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": {
      "PendingMessages": [
        {
          "ID": "sample string 1",
          "Status": "sample string 2",
          "DateSubmitted": "2017-09-24T12:20:43.1272171Z",
          "DateSent": "2017-09-24T12:20:43.1272171Z",
          "Text": "sample string 5",
          "Destination": "sample string 6"
        },
        {
          "ID": "sample string 1",
          "Status": "sample string 2",
          "DateSubmitted": "2017-09-24T12:20:43.1272171Z",
          "DateSent": "2017-09-24T12:20:43.1272171Z",
          "Text": "sample string 5",
          "Destination": "sample string 6"
        }
      ],
      "RecurringMessages": [
        {
          "ID": "sample string 1",
          "Text": "sample string 2",
          "Destination": "sample string 3",
          "DaysToSend": "sample string 4",
          "TimeToSend": "2017-09-24T12:20:43.1272171Z",
          "GUID": "sample string 6",
          "RecurrencesRemaining": 7
        },
        {
          "ID": "sample string 1",
          "Text": "sample string 2",
          "Destination": "sample string 3",
          "DaysToSend": "sample string 4",
          "TimeToSend": "2017-09-24T12:20:43.1272171Z",
          "GUID": "sample string 6",
          "RecurrencesRemaining": 7
        }
      ],
      "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:
<ResponseOfReportPendingAndRecurringResponseData 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>
      <PendingMessages>
        <PendingReportMessage>
          <ID>sample string 1</ID>
          <Status>sample string 2</Status>
          <DateSubmitted>2017-09-24T12:20:43.1272171Z</DateSubmitted>
          <DateSent>2017-09-24T12:20:43.1272171Z</DateSent>
          <Text>sample string 5</Text>
          <Destination>sample string 6</Destination>
        </PendingReportMessage>
        <PendingReportMessage>
          <ID>sample string 1</ID>
          <Status>sample string 2</Status>
          <DateSubmitted>2017-09-24T12:20:43.1272171Z</DateSubmitted>
          <DateSent>2017-09-24T12:20:43.1272171Z</DateSent>
          <Text>sample string 5</Text>
          <Destination>sample string 6</Destination>
        </PendingReportMessage>
      </PendingMessages>
      <RecurringMessages>
        <RecurringReportMessage>
          <ID>sample string 1</ID>
          <Text>sample string 2</Text>
          <Destination>sample string 3</Destination>
          <DaysToSend>sample string 4</DaysToSend>
          <TimeToSend>2017-09-24T12:20:43.1272171Z</TimeToSend>
          <GUID>sample string 6</GUID>
          <RecurrencesRemaining>7</RecurrencesRemaining>
        </RecurringReportMessage>
        <RecurringReportMessage>
          <ID>sample string 1</ID>
          <Text>sample string 2</Text>
          <Destination>sample string 3</Destination>
          <DaysToSend>sample string 4</DaysToSend>
          <TimeToSend>2017-09-24T12:20:43.1272171Z</TimeToSend>
          <GUID>sample string 6</GUID>
          <RecurrencesRemaining>7</RecurrencesRemaining>
        </RecurringReportMessage>
      </RecurringMessages>
      <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>
</ResponseOfReportPendingAndRecurringResponseData>