Developers

Msgme APIs

IVR API

get_inbound_vmails

URL:

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

METHOD:

Get

DESCRIPTION:

Returns a paginated list of voice mails recorded by the keyword owner's 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: YYYYMMDD

API REQUEST:

http://api.msgme.com/v1/ivr/get_inbound_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]" >
			<inboundVmails page="[page number]" numberOfPages="[total number of pages]" 
				siteId="[voice site ID]" >
				<inbound_vmail
					inboundVmailId="[Msgme internal voice mail ID]"
					city="[MSIDN city]"
					state="[MSIDN state, 2 letter format]"
					msidn="[10-digit phone number]"
					url="[voice mail URL]"  
					landOrCell="[land|cell]" 
					dateRecorded="[YYYYMMDD]" />
					...
			</inboundVmails>
		</apiResponse>

EXAMPLE USAGE:

REQUEST:

http://api.msgme.com/v1/ivr/get_inbound_vmails?token="dasdDKAKDU76djEKkeyhda"&keywordId="1030"&page="3"

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[Status text]" statusCode="[Status code]" >
			<inboundVmails page="3" numberOfPages="10" siteId="97453" >
				<inboundVmail
					inboundVmailId="1002"
					msidn="555-555-5555"
					city="Atlanta"
					state="GA"
					url="http://storage.msgme.com/vmails/inbound/xxxxxxx.mp3"  
					landOrCell="cell" 
					dateRecorded="2008-10-21 13:45:47" />
			</inboundVmails>
		</apiResponse>