Put Keyword
pinpointsmsvoicev2_put_keyword | R Documentation |
Creates or updates a keyword configuration on an origination phone number or pool¶
Description¶
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, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
Usage¶
Arguments¶
OriginationIdentity
[required] The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use
describe_phone_numbers
get the values for PhoneNumberId and PhoneNumberArn whiledescribe_sender_ids
can be used to get the values for SenderId and SenderIdArn.Keyword
[required] The new keyword to add.
KeywordMessage
[required] The message associated with the keyword.
KeywordAction
The action to perform for the new keyword when it is received.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
Value¶
A list with the following syntax:
list(
OriginationIdentityArn = "string",
OriginationIdentity = "string",
Keyword = "string",
KeywordMessage = "string",
KeywordAction = "AUTOMATIC_RESPONSE"|"OPT_OUT"|"OPT_IN"
)