Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging SMS responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

post/#X-Amz-Target=PinpointSMSVoiceV2.PutKeyword

Headers

X-Amz-Target'PinpointSMSVoiceV2.PutKeyword' required

Request body

OriginationIdentitystring required
<p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <a>DescribePhoneNumbers</a> get the values for PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used to get the values for SenderId and SenderIdArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
Keywordstring required

The new keyword to add.

KeywordMessagestring required

The message associated with the keyword.

KeywordAction'AUTOMATIC_RESPONSE' | 'OPT_OUT' | 'OPT_IN'
<p>The action to perform for the new keyword when it is received.</p> <ul> <li> <p>AUTOMATIC_RESPONSE: A message is sent to the recipient.</p> </li> <li> <p>OPT_OUT: Keeps the recipient from receiving future messages.</p> </li> <li> <p>OPT_IN: The recipient wants to receive future messages.</p> </li> </ul>

Response

Success

OriginationIdentityArnstring

The PhoneNumberArn or PoolArn that the keyword was associated with.

OriginationIdentitystring

The PhoneNumberId or PoolId that the keyword was associated with.

Keywordstring

The keyword that was added.

KeywordMessagestring

The message associated with the keyword.

KeywordAction'AUTOMATIC_RESPONSE' | 'OPT_OUT' | 'OPT_IN'

The action to perform when the keyword is used.