getVoxnumberRegions¶

Request Method: GET

Description: Retrieves all Region for a defined search.

URL: https://api.iovox.com:444/Purchase?v=3&method=getVoxnumberRegions

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
page	The page number to return. Use together with limit to achieve paginated results	1	INTEGER	NO
limit	Determines how many results to return. Use together with page to achieve paginated results. Maximum here is 20000	20000	INTEGER	NO
number_type	Returns the Regions Details for the current region selected. number_type can be NATIONAL, GEOGRAPHIC, TOLLFREE		STRING	YES
area_code	Returns the Regions Details for the country_code selected.		STRING	YES
country_code	Returns the Regions Details for the area_code selected.		STRING	YES
req_fields	Comma separated list of abbreviated fields to return in response.ac=Area Code,cc=Country Code ,con=Country Name, stn=State Name, cin=City Name,ct=Cost		STRING	NO
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	NO

Result¶

Error Result¶

HTTP Code	Error String	Resolution
400	API Version Empty	Add a value for the v parameter in the query string
400	API Version Invalid	Correct v parameter
400	Request Method must be GET. x attempted	Switch request method x to GET
400	Page Number not an integer	Remove non-numerics from page
400	Limit not an integer	Remove non-numerics from limit
400	Limit must be between 1 and 20000	Correct the limit parameter
400	The requested Number Type is not valid	Correct the number_type parameter for one of the possible values: NATIONAL, GEOGRAPHIC, TOLLFREE.
400	Required Fields Invalid: fieldone,fieldtwo	Correct or remove fieldone and fieldtwo
400	Output Type Invalid	Correct output parameter
500	Internal Server Error	Retry later

Success Result¶

<?xml version="1.0" encoding="utf-8"?>
<response>
     <current_page>1<current_page>
     <total_pages>4<total_pages>
     <total_results>100<total_results>
     <results>
         <result>
            <area_code>1224</area_code>
            <country_code>44</country_code>
            <country_name>UNITED KINGDOM</country_name>
            <state_name/>
            <city_name>ABERDEEN</city_name>
            <require_purchase_info>false</require_purchase_info>
         </result>
         <result>
             ...
         <result>
     </results>
 </response>