GET api/OmsManageConfigurations/sms/available-numbers?siteId={siteId}&areaCode={areaCode}&countryCode={countryCode}

Request Information

URI Parameters

Name	Type	Additional Information
siteId	integer	Required
areaCode	integer	Required
countryCode	string	Default value is US

Body Parameters

None.

Response Information

Resource Description

SmsGetAvailableNumbersResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
AvailableNumbers	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "AvailableNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<SmsGetAvailableNumbersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <AvailableNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AvailableNumbers>
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</SmsGetAvailableNumbersResponse>