Delete Keyword

pinpointsmsvoicev2_delete_keyword

R Documentation

Deletes an existing keyword from an origination phone number or pool¶

Description¶

Deletes an existing keyword from 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.

Keywords "HELP" and "STOP" can't be deleted or modified.

Usage¶

pinpointsmsvoicev2_delete_keyword(OriginationIdentity, Keyword)

Arguments¶

OriginationIdentity

[required] The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use describe_phone_numbers to find the values for PhoneNumberId and PhoneNumberArn and describe_pools to find the values of PoolId and PoolArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Keyword

[required] The keyword to delete.

Value¶

A list with the following syntax:

list(
  OriginationIdentityArn = "string",
  OriginationIdentity = "string",
  Keyword = "string",
  KeywordMessage = "string",
  KeywordAction = "AUTOMATIC_RESPONSE"|"OPT_OUT"|"OPT_IN"
)

Request syntax¶

svc$delete_keyword(
  OriginationIdentity = "string",
  Keyword = "string"
)