Message-ID: <73437422.15813.1614958271890.JavaMail.confluence@wiki> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_15812_703572954.1614958271890" ------=_Part_15812_703572954.1614958271890 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html getKeywordAvailability

getKeywordAvailability

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

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

=20
=20
=20
=20
=20
=20
Example
=20
$result =3D $tmClient->getKeyword('gold');
$available =3D $result['available'] ? 'is' : 'is not';
$recycled =3D $result['recycle'] ? 'is' : 'is not';
echo "The keyword 'gold' $available available, and $recycled recycled&=
quot;;
=20
=20
=20
=20
=20
=20
=20

Arguments:

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

string $name:

=20
=20
=20
=20

Name of the delivery report to retrieve or 'all' to retrieve all campaig= n/API report data

=20
=20
=20
=20
=20
=20

Returns:

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

=20
=20
=20
=20
Array key  Value
available

Boolean. Whether this keyword is currently av= ailable from Text Marketer.

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

Specific error codes:

=20
=20
=20
=20

None.

=20 =20

NOTE error code 400 is reported if the keyword name is not specified. Se= e General error codes.<= /p>

=20
=20
=20
=20
=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20
=20
=20
=20
=20

 

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20
=20

You must know!

=20 =20

Our example code is an illustra= tion of how you might integrate with our systems and is not certified for p= roduction environments. You are responsible for testing and QA.

=20
=20
=20
=20
=20
------=_Part_15812_703572954.1614958271890--