SMS keywords
A keyword is a word you define to perform an action when used in a mobile-originated message, such as triggering a text response, opting in a user, or applying a tag for segmentation.
Use keywords to:
- Opt users in to messaging campaigns based on their keyword-indicated interests.
- Drive loyalty with unique keywords for loyalty members and non-members.
- Trigger external processes, e.g., a chatbot, using webhooks.
- Provide directions or access to promotional information, coupons, etc.
- Target future messaging based on keyword generated tags or subscription lists.
You can define opt-in keywords that will opt the user in to receiving SMS notifications or trigger opt-in flows. By default, users can text any of these words to opt out of notifications: STOP
, STOPALL
, UNSUBSCRIBE
, CANCEL
, END
, QUIT
, ARRET
. You can also add additional opt-out keywords. See: Opt-In/Out Handling.
Mobile-originated messages are represented as EventsEvents represent activities in the Airship system, as well as user behavior in your app or website. You can also send external activities (e.g., POS transactions) into the Airship system as events. Events power Airship data products and can be used in audience segments, as Automation triggers, and for partner integrations.. Each event records the keywords that your audience uses and additional identifying information. You can use these events to observe opt-in and opt-out trends in Performance AnalyticsA customizable marketing intelligence tool that provides access to reports and graphs based on engagement data. or to get events directly from Real-Time Data StreamingA service that delivers engagement events in real time via the Data Streaming API or an Airship partner integration..
Before implementing changes to compliance keywords (e.g., HELP and STOP), please consult your legal counsel in order to address your specific use case or regulatory requirements in your jurisdiction. Certain compliance keywords may be required in certain jurisdictions or under the local carrier requirements.
Keyword format
When you create a keyword, you must configure the following:
- Keyword — The word that triggers the response text and opt-in action, e.g.,
JOIN
orYES
.- Must be unique per sender ID
- 100 characters maximum
- Cannot contain spaces
- Case insensitive
- Response — The text that is sent to a user when they reply with the keyword or alias. You can select a pre-configured webhook as an alternative or in addition to the response text.
- Sender — A Sender IDAn originating phone number or string identifier used to indicate who an SMS message comes from. Members of your audience subscribe (opt in) to each sender ID they want to receive messages from.. You must have at least one sender ID configured in your project before you can create keywords.
You can also configure these options:
- Alias — Alternatives to the keyword. Must be unique per sender ID. Aliases have the same formatting requirements and restrictions as keywords.
- Opt-in action — The event that occurs when a user replies with the keyword or alias: None, Opt in, Opt out, or Create channel without opting in.
- Tags — Add or remove TagsMetadata that you can associate with channels or Named Users for audience segmentation. Generally, they are descriptive terms indicating user preferences or other categorizations, e.g.,
wine_enthusiast
orweather_alerts_los_angeles
. Tags are case-sensitive. when a user replies with the keyword or alias. - Shorten links — When enabled, if your response includes URLs (beginning with
http://
orhttps://
), they will be converted to shortened linksConverts HTTP/HTTPS URLs in your SMS messages to unique, shortened URLs for your recipients. The shortened URLs reduce the total number of characters that links consume and produce click tracking metrics, helping you determine how effective your SMS messages are in driving traffic to your links.. - Subscription lists — Opt a user in to or out of Subscription ListsAn audience list of users who are opted in to messaging about a specific topic. Users can manage their opt-in status per list using a Preference Center.. See: Subscription List Opt In/Out.
- Webhook — You can select a pre-configured webhook as an alternative or in addition to the response text.
Create keywords
- Go to Messages » SMS Keywords and click in the map or Create new keyword.
- Enter the keyword and aliases. Click Add after entering each alias.
- Click Keyword action or select the Response card in the map.
- Enter the response text. You can leave this field empty if you are configuring a webhook instead.
- Configure options:
- Shorten links — Toggle to enable.
- Opt-in action — Make a selection.
- Webhook — Make a selection. A selection is required if you are omitting response text.
- Tags — Select Add or Remove, enter a tag name in the search field, then:
- If searching for an existing tag, click to select from the search results. Search for existing tags returns all custom tag groups that contain that tag.
- If creating a new tag, click Create new tag: [search term], enter a custom tag group name in the search field that appears, then click to to select from the search results.
- Subscription lists — Select Opt in to or Opt out of, search for a subscription list and select from the results. Repeat for multiple lists.
- Click Settings and select a sender ID. Each sender ID in the list is prepended with its country.
- Click Save and confirm.
Manage keywords
Go to Messages » SMS Keywords to view a list of the keywords in your project.
- Keywords are grouped by sender ID.
- Sender IDs are sorted numerically then alphabetically. Keywords are sorted by creation order.
- You can filter the list by searching for keyword, alias, or sender ID.
You can edit all fields and selections in an existing keyword:
- Select a keyword from the list.
- Make your changes.
- Click Save and confirm.
To delete a keyword:
- Select a keyword from the list.
- Click Settings.
- Click Delete keyword and confirm.
Categories