Add a keyword to a phone number in AWS End User Messaging SMS - AWS End User Messaging SMS
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Add a keyword to a phone number in AWS End User Messaging SMS

Use the AWS End User Messaging SMS console or AWS CLI to customize the keyword responses for your phone number.

Add a keyword (Console)

Use the AWS End User Messaging SMS console to add keywords to your phone number.

Add a keyword

  1. Open the AWS End User Messaging SMS console at https://console.aws.amazon.com/sms-voice/.

  2. In the navigation pane, under Configurations, choose Phone number.

  3. On the Phone number page, choose the phone number to add a keyword to.

  4. On the Keywords tab, choose the Add keyword button.

  5. In the Custom Keyword pane add the following:

    • Keyword – The new keyword to add.

    • Response message – The message to send back to the recipient.

    • Keyword action – The action to perform when the keyword is received.

  6. Choose Add keyword.

Add or edit a keyword (AWS CLI)

You can use the put-keyword command to create a new keyword or edit. If the keyword already exists then it will be over written.

To create a keyword, run the following command in the AWS CLI:

$ aws pinpoint-sms-voice-v2 put-keyword \
> --origination-identity OriginationIdentity \
> --keyword Keyword \
> --keyword-message KeywordMessage \
> --keyword-action KeywordAction

In the preceding command, make the following changes:

  • Replace OriginationIdentity with the unique ID or Amazon Resource Name (ARN) of the phone number that you want to add the keyword to.

  • Replace Keyword with the new keyword.

  • Replace KeywordMessage with the message to use when responding to the keyword.

  • Replace KeywordAction the action (AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN) to perform when the keyword is received.