GET api/v1/reports/messages/BatchResend?RetrieveRecentGuids={RetrieveRecentGuids}&Number={Number}&Reference={Reference}&DateID={DateID}&StartDate={StartDate}&EndDate={EndDate}&Range={Range}&Destination={Destination}&softwareVersion={softwareVersion}

The original reference of the batch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RetrieveRecentGuids

Batch retrieveRecentGuids

boolean

None.

Number

Batch number

integer

None.

Reference

Batch reference

string

None.

DateID

Batch DateID

string

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.

TwoSms.CustomerPortalRole.API.Reports.DateRange

None.

Destination

To search for a particular Short Code

string

None.

softwareVersion

string

None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Reports.SMS.BatchMessageList
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Reports.SMS.BatchMessageList

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": {
      "BatchMessages": [
        {
          "DateId": "sample string 1",
          "Date": "2021-04-15T07:45:16.7067511+00:00",
          "Reference": "sample string 3",
          "Message": "sample string 4"
        },
        {
          "DateId": "sample string 1",
          "Date": "2021-04-15T07:45:16.7067511+00:00",
          "Reference": "sample string 3",
          "Message": "sample string 4"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfBatchMessageList 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>
      <BatchMessages>
        <BatchMessage>
          <DateId>sample string 1</DateId>
          <Date>2021-04-15T07:45:16.7067511+00:00</Date>
          <Reference>sample string 3</Reference>
          <Message>sample string 4</Message>
        </BatchMessage>
        <BatchMessage>
          <DateId>sample string 1</DateId>
          <Date>2021-04-15T07:45:16.7067511+00:00</Date>
          <Reference>sample string 3</Reference>
          <Message>sample string 4</Message>
        </BatchMessage>
      </BatchMessages>
    </Detail>
  </ResponseData>
</ResponseOfBatchMessageList>