GET api/v1/reports/numberstatus?Destination={Destination}&ShortCode={ShortCode}&SoftwareVersion={SoftwareVersion}

This method checks a number provided against the 2sms stop log with the given shortcode.

Request Information

URI Parameters

Name	Description	Type	Additional information
Destination	The recipient number to check.	string	Required
ShortCode	The short code to check the number against.	string	Required

Body Parameters

None.

Response Information

Resource Description

The status of the number.

ResponseOfNumberStatusResponse

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfNumberStatusResponse	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": {
      "Records": [
        {
          "DateSubmitted": "2024-12-03T12:36:24.4270581+00:00",
          "Destination": "sample string 1",
          "OptedOut": true,
          "Reason": "sample string 2",
          "ShortCode": "sample string 3"
        },
        {
          "DateSubmitted": "2024-12-03T12:36:24.4270581+00:00",
          "Destination": "sample string 1",
          "OptedOut": true,
          "Reason": "sample string 2",
          "ShortCode": "sample string 3"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfNumberStatusResponse 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>
      <Records>
        <NumberStatusRecord>
          <DateSubmitted>2024-12-03T12:36:24.4270581+00:00</DateSubmitted>
          <Destination>sample string 1</Destination>
          <OptedOut>true</OptedOut>
          <Reason>sample string 2</Reason>
          <ShortCode>sample string 3</ShortCode>
        </NumberStatusRecord>
        <NumberStatusRecord>
          <DateSubmitted>2024-12-03T12:36:24.4270581+00:00</DateSubmitted>
          <Destination>sample string 1</Destination>
          <OptedOut>true</OptedOut>
          <Reason>sample string 2</Reason>
          <ShortCode>sample string 3</ShortCode>
        </NumberStatusRecord>
      </Records>
    </Detail>
  </ResponseData>
</ResponseOfNumberStatusResponse>