GET api/v1/reports/standard/inbound

Retrieves a report on all the Inbound Inbound 2way messages for the account. filtering can be applied. There are three different ways to specify the date ranges 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 date parameter can be used at the time to filter out the data when the report is returned. If more than one parameter is supplied, they will be prioritized in this order Range > RecentsDays > startDate and EndDate. You can also filter on ShortCode and Inbound number

Request Information

URI Parameters

Name	Description	Type	Additional information
DaysToCover	Days to cover	integer	None.
InboundNumber	To search for a particular Inbound Number.	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.
Reference	To search for a Reference	string	None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Reports.SMS.InboundReportMessages

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Reports.SMS.InboundReportMessages	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": [
      {
        "Text": "sample string 1",
        "InboundNumber": "sample string 2",
        "DateReceived": "2024-11-21T08:43:37.0288947+00:00",
        "Charge": 4.1,
        "ShortCode": "sample string 5"
      },
      {
        "Text": "sample string 1",
        "InboundNumber": "sample string 2",
        "DateReceived": "2024-11-21T08:43:37.0288947+00:00",
        "Charge": 4.1,
        "ShortCode": "sample string 5"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfInboundReportMessages 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>
      <InboundReportMessages>
        <Text>sample string 1</Text>
        <InboundNumber>sample string 2</InboundNumber>
        <DateReceived>2024-11-21T08:43:37.0288947+00:00</DateReceived>
        <Charge>4.1</Charge>
        <ShortCode>sample string 5</ShortCode>
      </InboundReportMessages>
      <InboundReportMessages>
        <Text>sample string 1</Text>
        <InboundNumber>sample string 2</InboundNumber>
        <DateReceived>2024-11-21T08:43:37.0288947+00:00</DateReceived>
        <Charge>4.1</Charge>
        <ShortCode>sample string 5</ShortCode>
      </InboundReportMessages>
    </Detail>
  </ResponseData>
</ResponseOfListOfInboundReportMessages>