Developers

Msgme APIs

Keyword API

get_keywords

URL:

http://api.msgme.com/v1/keywords/get_keywords

METHOD:

Get

DESCRIPTION:

This will retrieve a list of keywords that were created under the account or short code. If short code is specified, the account must have access to the short code.

PARAMETERS:

Parameter	Description
token	The security token that was returned using authentication_api method.
accountId (required)	Keywords that were created under the account will be returned.
shortcode (required)	Keywords that were created under this short code.

API REQUEST:

http://api.msgme.com/v1/keyword/get_keywords?token=[token]&accountId=[account ID]&shortcode=[short code ]

API RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[status text]" statusCode="[status code]" >
			<keywords>
				<keyword 
					keywordId="[keyword ID]"
					keywordName="[keyword name]"
					subscription="[true|false]"
					createdDate="[YYYY-MM-DD HH:MM:SS]"
					accountId="[account ID]" />
				...
			</keywords>
		</apiResponse>

EXAMPLE USAGE:

REQUEST:

GET http://api.msgme.com/v1/keyword/get_keywords?token= 0e9ace1582fbb754dfe7f4e11f572bf5273f3c69&accountId=10030

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="success" statusCode="200" >
			<keywords>
				<keyword 
					keywordName="tenger"
					keywordId="11545" 
					subscription="true"
					createdDate="2009-03-25 16:27:41"
					accountId="10030" />
				<keyword 
					keywordName="indy"
					keywordId="10475"
					subscription="false"
					createdDate="2009-03-25 16:27:41"
					accountId="10030" />
				<keyword 
					keywordName="indy 500"
					keywordId="10476" 
					subscription="false"
					createdDate="2009-03-25 16:27:41"
					accountId="10030" />	
			</keywords>
		</apiResponse>