Developers

Msgme APIs

IVR API

get_outbound_vmails

URL:

http://api.msgme.com/v1/ivr/get_outbound_vmails

METHOD:

Get

DESCRIPTION:

Returns a paginated list of voice mails recorded by the keyword owner for his or her fans, subscribers, and etc.

PARAMETERS:

Parameter	Description
token	The security token that was returned using authentication_api method.
keywordId	The keyword with an active IVR campaign and the campaign is voicemail enabled.
page	The page of the result set to be returned. Default is page 1, with 50 results per page. Ordered by latest voicemail first.
dateRecorded	(Optional) When this field is specified, the method will only return voicemails recorded after this date. Format: YYYY-MM-DD HH:MM:SS

API REQUEST:

http://api.msgme.com/v1/ivr/get_outbound_vmails?token="[token]"&keywordId="[keyword ID]"&page="[result set page]"&dateRecorded="[YYYYMMDD]"

API RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[status text]" statusCode="[status code]" >
			<outboundVmails page="[page number]" numberOfPages="[total number of pages]" 
				siteId="[voice site ID]" >
				<outboundVmail
					outboundVmailId="[Msgme internal voice mail ID]"
					msidn="[10-digit mobile number]"
					url="[voice mail URL]"
					landOrCell="[land|cell]"
					dateRecorded="[YYYYMMDD]" />
					...
			</outboundVmails>
		</apiResponse>

EXAMPLE USAGE:

REQUEST:

http://api.msgme.com/v1/ivr/get_outbound_vmails?token=-dasdDKAKDU76djEKkeyhda_&keywordId=1030&page=3

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="OK" statusCode="200" >
			<outboundVmails page="3" numberOfPages="10" siteId="97453" >
				<outboundVmail
					outboundVmailId="1002"
					msidn="555-555-5555"
					url="http://storage.msgme.com/vmails/outbound/xxxxxxx.mp3" 
					landOrCell="land" 
					dateRecorded="2008-10-21 13:45:47" />
			</outboundVmails>
		</apiResponse>