|
ANVEO.AREAS.LIST - API REQUEST
|
|
|
ANVEO.AREAS.LIST - Get a list of areas where DID phone numbers are available.
|
|
|
|
Description
|
|
|
ANVEO.AREAS.LIST API Action is used to obtain a list of area codes where Anveo has DID coverage. Each area includes stock information as well as RATE_PLANs.
|
|
|
Arguments
|
|
DID_TYPE
Required. A type of DID to be ordered.
COUNTRY_ID
Required. Country ID from ANVEO.COUNTRIES.LIST action for which a list of areas is needed. When country has states then COUNTRY_ID is optional and STATE_ID is required.
STATE_ID
Only required for countries with states. State ID from ANVEO.STATES.LIST action for which a list of areas is needed.
|
|
|
Example:
<PARAMETER NAME="DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="COUNTRY_ID">123.123.123.123.123.123.123.123.123.</PARAMETER>
<PARAMETER NAME="STATE_ID">222.123.123.123.123.123.123.123.123.</PARAMETER>
|
|
Example:
param[DID_TYPE]=GEOGRAPHIC
param[COUNTRY_ID]=123.123.123.123.123.123.123.123.123
param[STATE_ID]=222.123.123.123.123.123.123.123.123
|
|
|
|
Response
|
|
|
AREAS XML node contains a list of area codes. Each area contains a list of RATE_PLAN available for a given area code.
|
|
|
API Request Examples
|
|
|
API Request Example for a country without states
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>YOURAPIKEY</USERKEY>
</USERTOKEN>
<ACTION NAME="ANVEO.AREAS.LIST">
<PARAMETER NAME="DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="COUNTRY_ID">123.123.123.123.123.123.123.123.123</PARAMETER>
</ACTION>
</REQUEST>
|
|
|
API Request Example for a country with states
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="ANVEO.AREAS.LIST">
<PARAMETER NAME="DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="STATE_ID">222.123.123.123.123.123.123.123.123</PARAMETER>
</ACTION>
</REQUEST>
|
|
|
API Request Example for a country without states
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=ANVEO.AREAS.LIST¶m[DID_TYPE]=GEOGRAPHIC¶m[COUNTRY_ID]=123.123.123.123.123.123.123.123.123
|
|
|
API Request Example for a country with states
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=ANVEO.AREAS.LIST¶m[DID_TYPE]=GEOGRAPHIC¶m[STATE_ID]=222.123.123.123.123.123.123.123.123
|
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
<AREAS>
<AREA AREA_ID="34.34.34.343.2" AREA_NAME="New York" AREA_CODE="646" STOCK="79">
<RATE_PLANS>
<RATE_PLAN RATE_PLAN_ID="SU" RATE_PLAN_NAME="Service Unlimited" MONTHLY100="149" SETUP100="249" />
<RATE_PLAN RATE_PLAN_ID="OU" RATE_PLAN_NAME="Office Unlimited" MONTHLY100="499" SETUP100="249" />
</RATE_PLANS>
</AREA>
</AREAS>
</RESPONSE>
|
|
|
