|
VOICEMAIL.BOX.LIST - API REQUEST
|
|
|
VOICEMAIL.BOX.LIST - list voicemail boxes for the account.
|
|
|
|
Description
|
|
|
VOICEMAIL.BOX.LIST API action is used to show voicemail boxes with its configuration for the account/sub-account.
|
|
|
Arguments
|
|
ACCOUNT_NUMBER
Optional. Only needed when accessing voicemail boxes for a sub-account.
|
|
FILTER.VOICEMAIL.BOX.NUMBER
Optional. Only return results for a given voicemail box number.
|
|
|
Example:
<PARAMETER NAME="ACCOUNT_NUMBER">23434323423</PARAMETER>
<PARAMETER NAME="FILTER.VOICEMAIL.BOX.NUMBER">100</PARAMETER>
|
|
Example:
param[ACCOUNT_NUMBER]=123456789¶m[FILTER.VOICEMAIL.BOX.NUMBER]=100
|
|
|
Each parameter value needs to be URL Encoded separately.
|
|
|
|
Response
|
|
VOICEMAIL XML Node contains a list of BOX objects (XML Nodes).
BOX XML Node contains details of a voicemail box options
|
|
|
API Request Example
|
|
<?xml version="1.0" standalone="no" ?>
<REQUEST>
<USERTOKEN>
<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
</USERTOKEN>
<ACTION NAME="VOICEMAIL.BOX.LIST">
<PARAMETER NAME="ACCOUNT_NUMBER">0123456789</PARAMETER>
<PARAMETER NAME="FILTER.VOICEMAIL.BOX.NUMBER">100</PARAMETER>
</ACTION>
</REQUEST>
|
|
https://www.anveo.com/api/v2.asp?userkey=YOURAPIKEY&action=VOICEMAIL.BOX.LIST¶m[ACCOUNT_NUMBER]=123456789¶m[FILTER.VOICEMAIL.BOX.NUMBER]=100
|
|
|
Each parameter value needs to be URL Encoded separately.
|
|
|
|
Response Example
|
<?xml version="1.0" standalone="no" ?>
<RESPONSE>
<RESULT>SUCCESS</RESULT>
<VOICEMAIL>
<BOX>
<BOX_NUMBER>100</BOX_NUMBER>
<PIN>987</PIN>
<LANGUAGE>ENG</LANGUAGE>
<TITLE>Default</TITLE>
<MAXIMUM_DURATION>45</MAXIMUM_DURATION>
<IS_CUSTOM_EMAIL>FALSE</IS_CUSTOM_EMAIL>
<CUSTOM_EMAIL_BODY></EMAIL_BODY>
<CUSTOM_EMAIL_SUBJECT></EMAIL_SUBJECT>
<IS_TRANSCRIPTION>FALSE</IS_TRANSCRIPTION>
<TRANSCRIPTION_LANGUAGE>ENGLISH</TRANSCRIPTION_LANGUAGE>
<NOTIFICATION_SMS></NOTIFICATION_SMS>
<KEEP_DAYS>30</KEEP_DAYS>
<MINIMUM_DURATION>1</MINIMUM_DURATION>
<NOTIFICATION_EMAIL>test@xxxxxxxx.com</NOTIFICATION_EMAIL>
<NOTIFICATION_PUSHOVER_USERKEY></NOTIFICATION_PUSHOVER_USERKEY>
<NOTIFICATION_URL></NOTIFICATION_URL>
</BOX>
</VOICEMAIL>
</RESPONSE>
|
|
|
