TextMarks API V2 Documentation: Anybody.keyword

Method: keyword_status() (GET) - Check existing availability/status of a keyword

Package: Anybody - Public data and methods for pre- or anonymous users (... View package)

Args:

Req?	Name	Type	Description

REQ	keyword	String	Possible TextMark keyword to check

OPT	api_key	API Key	API Key (Register here)
OPT	tria	TRIA	TextMarks Resource Indicator Address domain
OPT	suggest	Integer	# similar keyword recommendations if not available
OPT	auth_user	User	User account / phone# used for login
OPT	auth_pass	Password	Password

Test:

Human? GET in new window?

Docs:

In the response, 'available' boolean indicates if keyword is available for creation, 'status' string indicates details of the keyword's status, and 'suggestions' will contain suggested similar keywords if requested one is not available.
The auth_user is optional. If specified (and valid), additional information may be reported, such as whether the keyword belongs to that user.
The 'status' will be one of the following constants:

available

Keyword is available (the only status where 'available' will be true).

authusers

Keyword already belongs to auth_user.

system

Keyword is a system command.

occupied

Keyword is already in use.

reserved

Keyword is reserved, but may be available to Pro users by manual approval of TextMarks staff.

long

Keyword is too long.

short

Keyword is too short.

pro

Keyword is short, but available to Pro users (not shown if auth_user is already a Pro user).

promaybe

Keyword is reserved-short, but may be available to Pro users by manual approval of TextMarks staff.

badchars

Keyword contains illegal characters.

contextual

Keyword is reserved for contextual responses.
If keyword is a live keyword, then an additional 'public_config' key will contain public information about that keyword. Portions of this information is also returned by TextMarkManager.public_config().
If a valid auth_user is specified along with a valid live keyword, then an additional 'member' key will indicate if the user is a member of that group or not.

Resp:

JSON response.head.rescode==0 for success, or error code otherwise.

JSON-P callback: (as 'jsonp' param, optional) (blank for none)

HTTP:

GET https://api2ssl.textmarks.com//Anybody/keyword_status/

This page documents a single API function keyword_status() within the Anybody package of the TextMarks Text Message API.
You may use the interactive form above to invoke this function and observe its actual JSON response.

More resources:

API Overview
API Error / Result Code reference
Client Libraries
Help / FAQ / File a ticket
Developer Support Hotline: (800) 696-1393

TextMarks API V2 - AutoDoc: Anybody / keyword_status()