|
|
|
DID.ORDER - Places an order for a DID(s).
|
|
|
|
Description
|
|
|
DID.ORDER API Action is used to order DIDs in a a given area.
|
|
|
Arguments
|
|
DID_TYPE
Required. A type of DID to be ordered. DID_TYPE can be GEOGRAPHIC, NATIONAL, TOLLFREE or MOBILE
AREA_ID
Required. Area ID from which DID should be ordered.
RATE_PLAN_ID
Optional. Rate Plan for a DID. If not specified Service Unlimited rate plan will be used.
QUANTITY
Optional. How many DIDs to be purchased. If not specified 1 number will be ordered.
ACCOUNT_NUMBER
Optional. Account number can be spacified when DID is ordered by sub-account instead of the main account.
TITLE
Optional. Title can be any value to help you identify DID number.
|
|
|
Example:
<PARAMETER NAME="DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="AREA_ID">123.123.123.123.123.123.123.123.123.</PARAMETER>
<PARAMETER NAME="RATE_PLAN_ID">SU</PARAMETER>
<PARAMETER NAME="QUANTITY">1</PARAMETER>
<PARAMETER NAME="ACCOUNT_NUMBER">1234567895</PARAMETER>
<PARAMETER NAME="TITLE">ABCDEF</PARAMETER>
|
|
param[DID_TYPE]=GEOGRAPHIC
param[AREA_ID]=123.123.123.123.123.123.123.123.123
param[RATE_PLAN_ID]=SU
param[QUANTITY]=1
param[ACCOUNT_NUMBER]=1234567895
param[TITLE]=ABCDEF
|
|
|
|
Response
|
|
|
When order was processed successfully then the result will be SUCCESS and <DIDS> XML node will list all newly purchased DIDs.
|
|
|
API Request Example
|
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>YOURAPIKEY</USERKEY>
</USERTOKEN>
<ACTION NAME="DID.ORDER">
<PARAMETER NAME="DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="AREA_ID">123.123.123.123.123.123.123.123.123</PARAMETER>
<PARAMETER NAME="RATE_PLAN_ID">SU</PARAMETER>
<PARAMETER NAME="QUANTITY">1</PARAMETER>
<PARAMETER NAME="TITLE">ABCDEF</PARAMETER>
</ACTION>
</REQUEST>
|
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=DID.ORDER¶m[DID_TYPE]=GEOGRAPHIC¶m[AREA_ID]=123.123.123.123.123.123.123.123.123¶m[RATE_PLAN_ID]=SU¶m[QUANTITY]=1¶m[ACCOUNT_NUMBER]=1234567895¶m[TITLE]=ABCDEF
|
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
<DIDS>
<DID E164="12121111111" DID_TYPE="GEOGRAPHIC" SMS_URL="" SMS_EMAIL=""
CALL_FORWARD_TYPE="CALLFLOW" CALL_FORWARD_TO="8c25e06faf2b98erts3gdtb83df91b307ff287f1"
STATUS="Active" COUNTRY_NAME="UNITED STATES" AREA_NAME="New York" AREA_CODE="212" MONTHLY100="149" TITLE="ABCDEF"/>
</DIDS>
</RESPONSE>
|
|
|
