PinpointSMSVoiceV2 / Client / delete_keyword

delete_keyword#

PinpointSMSVoiceV2.Client.delete_keyword(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_keyword(
    OriginationIdentity='string',
    Keyword='string'
)
Parameters:

  • OriginationIdentity (string) –

    [REQUIRED]

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

    Warning

    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 (string) –

    [REQUIRED]

    The keyword to delete.

Return type:

dict

Returns:

Response Syntax

{
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'Keyword': 'string',
    'KeywordMessage': 'string',
    'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
}

Response Structure

  • (dict) –

    • OriginationIdentityArn (string) –

      The PhoneNumberArn or PoolArn that the keyword was associated with.

    • OriginationIdentity (string) –

      The PhoneNumberId or PoolId that the keyword was associated with.

    • Keyword (string) –

      The keyword that was deleted.

    • KeywordMessage (string) –

      The message that was associated with the deleted keyword.

    • KeywordAction (string) –

      The action that was associated with the deleted keyword.

Exceptions