VOICEMAIL.LIST - API REQUEST

VOICEMAIL.LIST - list VOICEMAILS in your account.

Description

VOICEMAIL.LIST API Action is used to list Voicemails in your account or a sub account.

Arguments

ACCOUNT_NUMBER
Optional. Only needed when listing voicemails for a sub-account.

FILTER.VOICEMAIL.BOX.NAME
Optional. Only return results for voicemail boxes matching the given voicemail box name.

FILTER.VOICEMAIL.BOX.NUMBER
Optional. Only return results for voicemail boxes matching the given voicemail box number.

FILTER.CALLFLOW.INSTANCE.KEY
Optional. Only return results for the given Call Flow Instance.

Example:
<PARAMETER NAME="ACCOUNT_NUMBER">23434323423</PARAMETER>

Response

VOICEMAILS XML Node contains a list of VOICEMAIL objects (XML Nodes). VOICEMAIL XML Node
VOICEMAIL XML Node has information about a voicemail message. The information is stored in separate XML Nodes as following:
ID [string] - a unique ID for a voicemail message. It can be used with other Voicemail API actions to reference a given Voicemail message.
URL [string] - a URL to voicemail audio file.
BOXNAME [string] - Voicemail Box Name where the voicemail message is stored.
BOXNUMBER [string] - Voicemail Box Number where the voicemail message is stored.
TRANSCRIPTIONTEXT [string] - Voicemail transcription text (if any).
E164 [string] - Phone number in E164 format which left a voicemail message.
DATETIME [dd/mm/yyyy hh24:mi:ss in UTC timezone] - Date and time when voicemail message was added.
CALLFLOW_INSTANCE_KEY Call Flow instance key.

NOTE! Due to asynchronous voicemail processing there is a delay between a moment when voicemail message is saved in the voicemail box and when the audio file is available for download at the URL above. The delay varies from a few seconds to a few minutes.

API Request Example

<?xml version="1.0" standalone="no" ?>
<REQUEST>
	<USERTOKEN>
		<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
	</USERTOKEN>
	<ACTION NAME="VOICEMAIL.LIST">
		<PARAMETER NAME="ACCOUNT_NUMBER">0123456789</PARAMETER>
	</ACTION>
</REQUEST>

Response Example

<?xml version="1.0" standalone="no" ?>
<RESPONSE>
	<RESULT>SUCCESS</RESULT>
	<VOICEMAILS>
		<VOICEMAIL>
			<URL>http://www.anveo.com/media/14343cb07412aff577d2ca4525f4279c3ee1/audio/voicemessage-44675e39757384bba2dbe1df85c9101bb3118.wav</URL>
			<ID>121.181.210.108.128.56.240.205|5d312857fc38f7e328a2098f31b9398d40f5e5fe</ID>
			<BOXNAME>GENERAL</BOXNAME>
			<BOXNUMBER>111</BOXNUMBER>
			<TRANSCRIPTIONTEXT>Hello!</TRANSCRIPTIONTEXT>
			<E164>19169284233</E164>
			<DATETIME>24/06/2012 01:17:25</DATETIME>
			<CALLFLOW_INSTANCE_KEY>12h3jsore7dusodif830sldj2834</CALLFLOW_INSTANCE_KEY>
		</VOICEMAIL>
		<VOICEMAIL>
			<URL>http://www.anveo.com/media/14343cb07412aff577d2ca4525f4279c3ee1/audio/voicemessage-q4e75eg9dt7584bba2dbe1df85cr101bb31dq.wav</URL>
			<ID>153.145.267.348.128.56.240.205|45gd6fdgds464sf46545a2098f31b9398d40f5e5fe</ID>
			<BOXNAME>GENERAL</BOXNAME>
			<BOXNUMBER>111</BOXNUMBER>
			<TRANSCRIPTIONTEXT></TRANSCRIPTIONTEXT>
			<E164>12124267801</E164>
			<DATETIME>24/06/2012 01:23:52</DATETIME>
			<CALLFLOW_INSTANCE_KEY>1rtu7843r7dusodif830sldj2834</CALLFLOW_INSTANCE_KEY>
		</VOICEMAIL>
	</VOICEMAILS>
</RESPONSE>