Describe Keywords

pinpointsmsvoicev2_describe_keywords

R Documentation

Describes the specified keywords or all keywords on your origination phone number or pool¶

Description¶

Describes the specified keywords or all keywords on your 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¶

pinpointsmsvoicev2_describe_keywords(OriginationIdentity, Keywords,
  Filters, NextToken, MaxResults)

Arguments¶

OriginationIdentity: [required] The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use describe_phone_numbers to find the values for PhoneNumberId and PhoneNumberArn while describe_sender_ids can be used to get the values for SenderId and SenderIdArn.
Keywords: An array of keywords to search for.
Filters: An array of keyword filters to filter the results.
NextToken: The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
MaxResults: The maximum number of results to return per each request.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$describe_keywords(
  OriginationIdentity = "string",
  Keywords = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "keyword-action",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)