POST api/SiteGroup/SMSStoppedPhoneNumbers
Request Information
URI Parameters
None.
Body Parameters
SMSStoppedPhoneNumbersReques| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeOOSFlag | boolean |
None. |
|
| SiteGroupNum | integer |
None. |
|
| Phone | string |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"IncludeOOSFlag": true,
"SiteGroupNum": 1,
"Phone": "sample string 1",
"SessionNum": 2,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 3",
"StagesURL": "sample string 4"
}
application/xml, text/xml
Sample:
<SMSStoppedPhoneNumbersReques xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 4</StagesURL> <ApplicationCode>sample string 3</ApplicationCode> <SessionNum>2</SessionNum> <SessionPassword>QEA=</SessionPassword> <IncludeOOSFlag>true</IncludeOOSFlag> <Phone>sample string 1</Phone> <SiteGroupNum>1</SiteGroupNum> </SMSStoppedPhoneNumbersReques>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MySMSStoppedPhoneNumbersQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultSet | Collection of MySMSStoppedPhoneNumbersResult |
None. |
|
| ErrorTypeNum | integer |
None. |
|
| UserErrorMessage | string |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResultSet": [
{
"Phone": "sample string 1",
"SiteName": "sample string 2",
"XmitList": "sample string 3",
"SiteGroupNamePlusNum": "sample string 4",
"ContactName": "sample string 5",
"SiteGroupNum": 1,
"SiteNum": 1,
"DevNum": 1,
"FunctionName": "sample string 6",
"OOSStatus": "sample string 7",
"StatusDate": "2025-12-14T17:41:18.7138215-05:00"
},
{
"Phone": "sample string 1",
"SiteName": "sample string 2",
"XmitList": "sample string 3",
"SiteGroupNamePlusNum": "sample string 4",
"ContactName": "sample string 5",
"SiteGroupNum": 1,
"SiteNum": 1,
"DevNum": 1,
"FunctionName": "sample string 6",
"OOSStatus": "sample string 7",
"StatusDate": "2025-12-14T17:41:18.7138215-05:00"
}
],
"ErrorTypeNum": 1,
"UserErrorMessage": "sample string 2",
"Success": true
}
application/xml, text/xml
Sample:
<MySMSStoppedPhoneNumbersQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI">
<ErrorTypeNum>1</ErrorTypeNum>
<ResultSet>
<MySMSStoppedPhoneNumbersResult>
<ContactName>sample string 5</ContactName>
<DevNum>1</DevNum>
<FunctionName>sample string 6</FunctionName>
<OOSStatus>sample string 7</OOSStatus>
<Phone>sample string 1</Phone>
<SiteGroupNamePlusNum>sample string 4</SiteGroupNamePlusNum>
<SiteGroupNum>1</SiteGroupNum>
<SiteName>sample string 2</SiteName>
<SiteNum>1</SiteNum>
<StatusDate>2025-12-14T17:41:18.7138215-05:00</StatusDate>
<XmitList>sample string 3</XmitList>
</MySMSStoppedPhoneNumbersResult>
<MySMSStoppedPhoneNumbersResult>
<ContactName>sample string 5</ContactName>
<DevNum>1</DevNum>
<FunctionName>sample string 6</FunctionName>
<OOSStatus>sample string 7</OOSStatus>
<Phone>sample string 1</Phone>
<SiteGroupNamePlusNum>sample string 4</SiteGroupNamePlusNum>
<SiteGroupNum>1</SiteGroupNum>
<SiteName>sample string 2</SiteName>
<SiteNum>1</SiteNum>
<StatusDate>2025-12-14T17:41:18.7138215-05:00</StatusDate>
<XmitList>sample string 3</XmitList>
</MySMSStoppedPhoneNumbersResult>
</ResultSet>
<Success>true</Success>
<UserErrorMessage>sample string 2</UserErrorMessage>
</MySMSStoppedPhoneNumbersQueryResult>