QueryRegions

CallFire has a new API!

We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.

QueryRegions

Queries regions for use in subsequent searches and purchase requests

Use a know subset of info on a region to query for the full set of info on a region. Example, if you know the city you can query for phone number prefixes, rate-centers, etc... associated with that city.

Request Parameters

Parameter Demo Value Description Data Type
QueryRegions Regions request by query object
MaxResults Max number of results to return limited to 1000 (default: 1000) long
FirstResult Start of next result set (default: 0) long
Region Region of number represented by city, state, prefix, etc... object
Prefix 4-7 digit prefix string
City Name of a city string
State State abbreviation string
Zipcode 5 digit zipcode string
Country 2 digit country code string
Latitude Latitude float
Longitude Longitude float
TimeZone string

* indicates choice value, bolded parameters are required

Response Parameters

Parameter Description Data Type
RegionQueryResult List of Regions returned from query
TotalResults Results count long
Region Region of number represented by city, state, prefix, etc...
Prefix 4-7 digit prefix string
City Name of a city string
State State abbreviation string
Zipcode 5 digit zipcode string
Country 2 digit country code string
Latitude Latitude float
Longitude Longitude float
TimeZone string

 

Example Code

	<?php
/**
 * You'll need your login/password pair when you create the SOAP client.
 * Don't use the fake login/password provided here; it's just for show and won't work.
 */
$wsdl = "http://callfire.com/api/1.1/wsdl/callfire-service-http-soap12.wsdl";
$client = new SoapClient($wsdl, array(
    'soap_version' => SOAP_1_2,
    'login'        => 'YourLoginId',    
    'password'     => 'YourPassword'));


/**
 * QueryRegions
 */
$query = new stdclass();
$query->MaxResults = 2;   
$query->Region = new stdclass(); // required  
$query->Region->City = 'Seattle';

// Return list of Regions.
$response = $client->QueryRegions($query);
print_r($response);

// Sample $response:
// stdClass Object
// (
//     [TotalResults] => 621
//     [Region] => Array
//         (
//             [0] => stdClass Object
//                 (
//                     [Prefix] => 1206200
//                     [City] => SEATTLE
//                     [State] => WA
//                     [Zipcode] => 98154
//                     [Country] => US
//                     [Latitude] => 47.61
//                     [Longitude] => -122.331
//                     [TimeZone] => America/Los_Angeles
//                 )
//
//             [1] => stdClass Object
//                 (
//                     [Prefix] => 1206201
//                     [City] => SEATTLE
//                     [State] => WA
//                     [Zipcode] => 98154
//                     [Country] => US
//                     [Latitude] => 47.61
//                     [Longitude] => -122.331
//                     [TimeZone] => America/Los_Angeles
//                 )
//         )
// )

?>