SMS Notify! API Update: View, Add, & Remove Shared Short Code Keywords

Instead of calling or  requesting a keyword addition to your shared short code, you can now manage incoming keywords for your shared short code via the SMS Notify! API. Here are the new methods available:

1. GetKeywords Method

Now you can get all currently enabled keywords for a license key with the GetKeywords method.

Request:

License Key: license key to retrieve keywords for.

Response:

ReturnCode: Return code for method call.  Should always return NoError for GetKeywords().

Returns an array of KeywordResponseInfo:

  • EntryDate: DateTime in UTC of when keyword was added.
  • Keyword: Keyword.
  • ReturnCode: Return code for this keyword.  Should always return NoError for GetKeywords() method.
  • ShortCode: ShortCode that this keyword is assigned to.

2. AssignKeyword Method

This method assigns one or more keywords to a license key.

Request:

License Key: license key to assign new keywords to.

Array of KeywordRequestInfo:

  • Keyword: New keyword.
  • ShortCode: ShortCode to assign new keyword to.

Response:

ReturnCode: Return code for method call.  Should always return NoError for AssignKeywords().

Returns an array of KeywordResponseInfo:

  • EntryDate: DateTime in UTC of when keyword was added.
  • Keyword: Keyword attempting to add.
  • ReturnCode: Return code for this keyword.  Can return: ShortCodeInvalid, KeywordInvalid, KeywordAdded, ShortCodeNotAssignedToKey, KeywordAlreadyInUse, or InternalError.
  • ShortCode: ShortCode that this keyword is assigned to.

3. RemoveKeyword Method

Remove assigned keywords with this method.

Request:

License Key: license key to remove keywords from.

Array of KeywordRequestInfo:

  • Keyword: Existing keyword.
  • ShortCode: ShortCode to remove keyword from.

Response:

ReturnCode: Return code for method call.  Should always return NoError for RemoveKeywords().

Returns an array of KeywordResponseInfo:

  • EntryDate: DateTime in UTC of when keyword was added.
  • Keyword: Keyword attempting to remove.
  • ReturnCode: Return code for this keyword. Can return: ShortCodeInvalid, KeywordInvalid, KeywordRemoved, KeywordNotFound, or InternalError.
  • ShortCode: ShortCode that this keyword is assigned to.

 

For more information on SMS short codes in the U.S. and Canada click here. Or read What Can You Expect With a CDYNE Short Code?

Leave a reply