Developers

Keyword API

get_new_keywords


URL:

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

METHOD:

Get

DESCRIPTION:

This will retrieve a list of keywords that were created under the account or shortcode. By default, this call returns keywords created in the past 24 hours.

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.
dateCreated When this parameter is included, then only the keywords that were created after the specified date. If this parameter omitted, then the keywords created in the pas 24 hours are returned.


API REQUEST:

http://api.msgme.com/v1/keyword/get_new_keywords?token=[Developer token]&accountId=[Msgme account ID]&shortcode=[Msgme shortcode ]&dateCreated=[YYYYMMDD]



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="[YYYYMMDD]"
					accountId="[account ID]">
				</keyword>
				...
			</keywords>
		</apiResponse>


EXAMPLE USAGE:


REQUEST:

GET http://api.msgme.com/v1/keyword/get_new_keywords?token=0e9ace1582fbb754dfe7f4e11f572bf&accountId=10030&dateCreated=20060101


RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="success" statusCode="200" >
			<keywords>
				<keyword 
					keywordName="acme"
					keywordId="13478" 
					subscription="true"
					createdDate="20071102"
					accountId="10130">
				</keyword>
				<keyword 
					keywordName="acmetour"
					keywordId="13389"
					subscription="false"
					createdDate="20091128"
					accountId="10130">
				</keyword>
				<keyword 
					keywordName="acme2010"
					keywordId="14427" 
					subscription="false"
					createdDate="200902032"
					accountId="10130">
				</keyword>	
			</keywords>
		</apiResponse>