Phones

Available 10DLC Numbers

GET
/v1/Phones/Available10DLC

Gets the list of 10DLC phone numbers that are available for order.

Authorization

AuthorizationBasic <token>

Basic Authorization header using the BASIC scheme. Use a pair companySid:token to access the API.

In: header

Query Parameters

AreaCode?string

Filter by phone number area code (NPA). If specified, no other filters must be specified except ExchangeCode can be specified.

Match^[0-9]{3}$
Length3 <= length <= 3
ExchangeCode?string

Filter by phone number exchange code (central office code, or NXX). Can only be specified if AreaCode is specified.

Match^[0-9]{3}$
Length3 <= length <= 3
Region.Country?string

Specifies the country to search numbers (US or CA). If omitted, US is assumed. Note that to search by State AND City in Canada, you must specify CA explicitly. To search by State only, it is not necessary (but still preferable) since Canadian provinces abbreviations don't intersect with US states abbreviations.

Example"US"

Value in

  • "US"
  • "CA"
Region.State?string

Two-letter abbreviation of a state in USA or a province in Canada.

Length2 <= length <= 2
Example"CA"
Region.City?string

City name. Note that the full city name should be specified here, otherwise the search will return nothing (i.e. partial name search is not supported).

Example"Los Angeles"
Quantity?integer

Number of returned phone numbers, default is 10. Must be greater than 0 and less or equal to 100.

Formatint32
Range1 <= value <= 100

Response Body

curl -X GET "https://example.com/v1/Phones/Available10DLC?Region.Country=US&Region.State=CA&Region.City=Los+Angeles"
{  "phones": [    {      "number": "+10123456789",      "city": "Los Angeles",      "state": "CA",      "features": "SMS, MMS"    }  ]}
"string"

List Own Numbers GET

Gets a list of all phone numbers owned by you. For each number, its status is returned along with the identifier of the Messaging Config that the number is attached to. This method supports pagination.

Available Toll-Free Numbers GET

Gets the list of Toll-Free phone numbers that are available for order.