Developers

Msgme APIs

Subscriber API

list_subscriptions

URL:

http://api.msgme.com/v1/subscribers/list_subscriptions

METHOD:

Get

DESCRIPTION:

Gets a list of all the subscriptions that a mobile number is subscribed to. If a short code or account id is supplied then it will only return the subscriptions in that short code or account.

If the keyword is a subword, then the keywordName attribute returned will be a concatenated keyword, with the main keyword and subword separated by a period, E.g. indy.500

PARAMETERS:

Parameter	Description
token	The security token that was returned using authentication_api method.
msidn	The 10-digit subscriber number.
shortcode	(Optional) This limits the list to only one specific short code.

API REQUEST:

http://api.msgme.com/v1/subscribers/list_subscriptions?token=[Developer token]&msidn=[10 digit mobile number]

API RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[status text]" statusCode="[status code]">
		<subscriber msidn="[10 digit US mobile number]" >
			<subscriptions>
				<subscription
					keywordName="[keyword name]" 
					keywordId="[keyword ID]"
					dateSubscribed="[YYYYMMDD]" 
					shortcode="[shortcode]">
				</subscription>
				<subscription 
					keywordName="[keyword name]" 
					keywordId="[keyword ID]" 
					dateSubscribed="[YYYYMMDD]"
					shortcode="[shortcode]">
				</subscription>
				...
			</subscriptions>
		</subscriber>
		</apiResponse>

EXAMPLE USAGE:

REQUEST:

GET http://api.msgme.com/v1/subscribers/list_subscriptions?token=0e9ace1582fbb754dfe7f4e11f572bf5273f3c69&msidn=55555512345

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="OK" statusCode="200">
		<subscriber msidn="55555512345" >
			<subscriptions>
				<subscription
					keywordName="indy" 
					keywordId="12345" 
					dateSubscribed="2008-09-12 13:15:12" 
					shortcode="67463">
				</subscription>
				<subscription
					keywordName="indy.500" 
					keywordId="12346" 
					dateSubscribed="2007-01-12 16:10:01" 
					shortcode="67463">
				</subscription>
			</subscriptions>
		</subscriber>
		</apiResponse>