GET api/Status/GetStops/{SessionToken}

Gets a list of phone numbers associated with the user's company that have texted STOP since midnight the preceeding day

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SessionToken

The session token for the current user session

string

Required

Body Parameters

None.

Response Information

Resource Description

A status code and list of phone numbers

APIReturnOfRequestStatusAndIEnumerableOfNumberInfo
NameDescriptionTypeAdditional information
StatusEnum

RequestStatus

None.

Status

string

None.

Result

Collection of NumberInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusEnum": 0,
  "Status": "Success",
  "Result": [
    {
      "PhoneNumber": "sample string 1",
      "Date": "sample string 2",
      "Arguments": "sample string 3"
    },
    {
      "PhoneNumber": "sample string 1",
      "Date": "sample string 2",
      "Arguments": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<APIReturnOfRequestStatusArrayOfNumberInfouO2q6ph3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <Result>
    <NumberInfo>
      <Arguments>sample string 3</Arguments>
      <Date>sample string 2</Date>
      <PhoneNumber>sample string 1</PhoneNumber>
    </NumberInfo>
    <NumberInfo>
      <Arguments>sample string 3</Arguments>
      <Date>sample string 2</Date>
      <PhoneNumber>sample string 1</PhoneNumber>
    </NumberInfo>
  </Result>
  <StatusEnum>Success</StatusEnum>
</APIReturnOfRequestStatusArrayOfNumberInfouO2q6ph3>