|
|
|
DID.LIST - list DID phone numbers in your account.
|
|
|
|
Description
|
|
|
DID.LIST API Action is used to list DIDs in your account (or sub account) that match filter critea specified. When none of the filter options was provided it will list all DIDs.
|
|
|
Arguments
|
|
ACCOUNT_NUMBER
Optional. Only needed when listing phone numbers from a sub-account.
FILTER.DID_TYPE
Optional. A type of DID to be listed.
FILTER.E164
Optional. E164 of DID to be listed.
FILTER.SMS_EMAIL
Optional. Include DIDs matching SMS_EMAIL.
FILTER.SMS_URL
Optional. Include DIDs matching SMS_URL.
FILTER.CALL_FORWARD_TYPE
Optional. Include DIDs matching CALL_FORWARD_TYPE.
FILTER.CALL_FORWARD_TO
Optional. Include DIDs matching FILTER.CALL_FORWARD_TO.
FILTER.TITLE
Optional. Include DIDs with title matching FILTER.TITLE.
|
|
|
Example:
<PARAMETER NAME="ACCOUNT_NUMBER">23434323423</PARAMETER>
<PARAMETER NAME="FILTER.DID_TYPE">GEOGRAPHIC</PARAMETER>
<PARAMETER NAME="FILTER.E164">12129535456</PARAMETER>
<PARAMETER NAME="FILTER.SMS_EMAIL">sms@ddd.com</PARAMETER>
<PARAMETER NAME="FILTER.SMS_URL">http://api.server.com/smshandler</PARAMETER>
<PARAMETER NAME="FILTER.CALL_FORWARD_TYPE">CALLFLOW</PARAMETER>
<PARAMETER NAME="FILTER.CALL_FORWARD_TO">asd7sd8as9fsfg7fd8gg7gffsd7</PARAMETER>
<PARAMETER NAME="FILTER.TITLE">ABCDEF</PARAMETER>
|
|
Example:
param[ACCOUNT_NUMBER]=23434323423
param[FILTER.DID_TYPE]=GEOGRAPHIC
param[FILTER.E164]=12129535456
param[FILTER.SMS_EMAIL]=sms@ddd.com
param[FILTER.SMS_URL]=http://api.server.com/smshandler
param[FILTER.CALL_FORWARD_TYPE]=CALLFLOW
param[FILTER.CALL_FORWARD_TO]=asd7sd8as9fsfg7fd8gg7gffsd7
param[FILTER.TITLE]=ABCDEF
|
|
|
Each parameter value needs to be URL Encoded separately.
|
|
|
|
Response
|
|
|
DIDS XML Node contains a list of DID objects (XML Nodes) that match filter criteria.
|
|
|
API Request Example
|
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="DID.LIST">
<PARAMETER NAME="FILTER.E164">12121111111</PARAMETER>
</ACTION>
</REQUEST>
|
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=DID.LIST¶m[FILTER.E164]=12121111111
|
|
|
|
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="" ORDER_DATE="01/01/2013 11:02"/>
</DIDS>
</RESPONSE>
|
|
|
