Developers
Keyword API
keyword_available
URL:
http://api.msgme.com/v1/keywords/keyword_available
METHOD:
Get
DESCRIPTION:
Checks if the requested keyword is available for registration on the specified short code.
PARAMETERS:
| Parameter | Description |
|---|---|
| token | The security token that was returned using authentication_api method. |
| keywordName | The desired keyword to be registered |
| accountId | The account ID the keyword will be registered under. |
| shortcode | The short code the keyword will be registered on. |
API REQUEST:
http://api.msgme.com/v1/keyword/keyword_available?token=[token]&keywordName=[keyword name]&accountId=[account ID]&shortcode=[short code]
API RESPONSE:
<?xml version=1.0 encoding=UTF-8?> <apiResponse status="[status text]" statusCode="[status code]"> <keyword keywordName="[keyword name]" available="[true|false]" /> </apiResponse>
EXAMPLE USAGE:
REQUEST:
GET http://api.msgme.com/v1/keyword/keyword_available?token=RhjiGIaGJwJKT1Yd8hxquZ3rrOY994dHLEzO4AYyG-7T1Ru7WJBIm7&keywordName=idushyegfds&accountId=10030&shortcode=28444
RESPONSE:
<?xml version=1.0 encoding=UTF-8?> <apiResponse status="OK" statusCode="200"> <keyword keywordName="ashbycircus" available="true" /> </apiResponse>