SEARCH AVAILABLE NUMBERS
Search for new numbers that are available for purchase
This operation allows finding numbers available for purchase. It allows looking for regular numbers or toll free ones. Other search parameters include: phone prefix, city, and zip code. The maximum number (count) of numbers to be returned must also be specified.
REQUEST PARAMETERS
Parameter | Data Type | Demo Value | Description |
---|---|---|---|
SearchAvailableNumbers | object | ||
Region | object | Region of number represented by city, state, prefix, etc... | |
Prefix | string | 1920659 | 4-7 digit prefix |
City | string | Seattle | Name of a city |
State | string | WA | State abbreviation |
Zipcode | string | 98154 | 5 digit zipcode |
Country | string | US | 2 digit country code |
Lata | string | 674 | Lata |
RateCenter | string | SEATTLE | |
Latitude | float | 47.61 | Latitude |
Longitude | float | -122.331 | Longitude |
TimeZone | string | America/Los_Angeles | |
TollFree | boolean | ||
Count | int | Keywords request by query |
RESPONSE PARAMETERS
Parameter | Data Type | Description |
---|---|---|
NumberQueryResult | List of Numbers returned from query | |
TotalResults | long | Results count |
Number | Info about Number like Region | |
Number | PhoneNumber | 11 digit E.164 number |
NationalFormat | string | Phone number formatted for local |
TollFree | boolean | Is toll free number |
Region | Region of number represented by city, state, prefix, etc... | |
Prefix | string | 4-7 digit prefix |
City | string | Name of a city |
State | string | State abbreviation |
Zipcode | string | 5 digit zipcode |
Country | string | 2 digit country code |
Lata | string | Lata |
RateCenter | string | |
Latitude | float | Latitude |
Longitude | float | Longitude |
TimeZone | string | |
Status | NumberStatus | [PENDING, ACTIVE, RELEASED, UNAVAILABLE] |
LeaseInfo | Info about Lease | |
LeaseBegin | date | Date lease began |
LeaseEnd | date | Date lease ends |
AutoRenew | boolean | Is lease set to renew each month |
NumberConfiguration | Configure Call and Text features | |
CallFeature | NumberFeature | [UNSUPPORTED, PENDING, DISABLED, ENABLED] |
TextFeature | NumberFeature | [UNSUPPORTED, PENDING, DISABLED, ENABLED] |
InboundCallConfigurationType | InboundType | [TRACKING, IVR] |
InboundCallConfiguration | ||
CallTrackingConfig | ||
Id | long | Unique ID of InboundConfig |
TransferNumber | List[PhoneNumber] | |
Screen | boolean | |
Record | boolean | |
IntroSoundId | long | |
WhisperSoundId | long | |
IvrInboundConfig | ||
Id | boolean | Unique ID of InboundConfig |
DialplanXml | string |
EXAMPLE
using RestSharp;
namespace [your-namespace]
{
public class [your-class]
{
public string SearchAvailableNumbers()
{
var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");
var request = new RestRequest("number/keyword", Method.GET);
request.AddParameter("Prefix", "1201");
request.AddParameter("City", "Seattle");
request.AddParameter("TollFree", "true");
request.AddParameter("Count", "1");
var response = client.Execute(request);
string content = response.Content;
return content;
}
}
}
The XML returned is:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="1">
<Number>
<Number>18559897846</Number>
<NationalFormat>18559897846</NationalFormat>
<TollFree>true</TollFree>
</Number>
</r:ResourceList>