Skip to end of metadata
Go to start of metadata


Get the availability of a given reply keyword.
A reply keyword allows you receive incoming text messages to your account by providing people with a keyword, which they text to the short code 88802, e.g. text 'INFO' to 88802 to see this in action.




string $name:

Name of the delivery report to retrieve or 'all' to retrieve all campaign/API report data


an array with two keys: 'available' and 'recycle' e.g. $result['available']

Array key Value

Boolean. Whether this keyword is currently available from Text Marketer.

recycle Boolean. Whether this keyword has been recycled (previously used).

Specific error codes:


NOTE error code 400 is reported if the keyword name is not specified. See General error codes.


You must know!

Our example code is an illustration of how you might integrate with our systems and is not certified for production environments. You are responsible for testing and QA.