Developers

Msgme APIs

Subscriber API

get_subscriber

URL:

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

METHOD:

Get

DESCRIPTION:

Retrieves the basic subscriber information. If a keyword ID is included then metadata associated with the subscriber for that keyword will be returned.

For pre-defined fields, please see add_subscriber.

PARAMETERS:

Parameter	Description
token	The security token that was returned using authentication_api method.
msidn	The 10-digit subscriber.
keywordId	The keyword id of the subscribe-able keyword.

API REQUEST:

http://api.msgme.com/v1/subscribers/get_subscriber?token=[token]&msidn=[phone number]&keywordId=[keyword ID]

API RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[status text]" statusCode="[status code]">
			<subscriber 
				msidn="[10 digit mobile number]" 
				carrierName="[wireless carrier name]" 
				createDate="[YYYYMMDD]" 
				updateDate="[YYYYMMDD]">
				<keyword keywordId="keywordId?">
					<fields>
						<field name="[name]" value="[value]"></field>
						...
					</fields>
				</keyword>	
			</subscriber>
		</apiResponse>

EXAMPLE USAGE:

REQUEST:

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

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="OK" statusCode="200" >
			<subscriber 
				msidn="6264298416" 
				carrierName="TMobile" 
				createDate="20060617" 
				updateDate="20060713">
				<keyword keywordId="12345">
					<fields>
						<field name="email" value="email@domain.com" /></field>
						<field name="dob" value="19810810" /></field>
						<field name="zip" value="87654" /></field>
					</fields>
				</keyword>	
			</subscriber>
		</apiResponse>