PUTKEYWORD()`¶

About PutKeyword¶

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 MessagingSMS responds with a customizable message.

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

Method Signature¶

METHODS /AWS1/IF_PP2~PUTKEYWORD
  IMPORTING
    !IV_ORIGINATIONIDENTITY TYPE /AWS1/PP2PHONEORPOOLIDORARN OPTIONAL
    !IV_KEYWORD TYPE /AWS1/PP2KEYWORD OPTIONAL
    !IV_KEYWORDMESSAGE TYPE /AWS1/PP2KEYWORDMESSAGE OPTIONAL
    !IV_KEYWORDACTION TYPE /AWS1/PP2KEYWORDACTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pp2putkeywordresult
  RAISING
    /AWS1/CX_PP2ACCESSDENIEDEX
    /AWS1/CX_PP2CONFLICTEXCEPTION
    /AWS1/CX_PP2INTERNALSERVEREX
    /AWS1/CX_PP2RESOURCENOTFOUNDEX
    /AWS1/CX_PP2SERVICEQUOTAEXCDEX
    /AWS1/CX_PP2THROTTLINGEX
    /AWS1/CX_PP2VALIDATIONEX
    /AWS1/CX_PP2CLIENTEXC
    /AWS1/CX_PP2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_originationidentity` `TYPE /AWS1/PP2PHONEORPOOLIDORARN` `/AWS1/PP2PHONEORPOOLIDORARN`¶

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

If you are using a shared End User MessagingSMS resource then you must use the full Amazon Resource Name(ARN).

`iv_keyword` `TYPE /AWS1/PP2KEYWORD` `/AWS1/PP2KEYWORD`¶

The new keyword to add.

`iv_keywordmessage` `TYPE /AWS1/PP2KEYWORDMESSAGE` `/AWS1/PP2KEYWORDMESSAGE`¶

The message associated with the keyword.

Optional arguments:¶

`iv_keywordaction` `TYPE /AWS1/PP2KEYWORDACTION` `/AWS1/PP2KEYWORDACTION`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2putkeywordresult` `/AWS1/CL_PP2PUTKEYWORDRESULT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->putkeyword(
  iv_keyword = |string|
  iv_keywordaction = |string|
  iv_keywordmessage = |string|
  iv_originationidentity = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_originationidentityarn( ).
  lv_string = lo_result->get_originationidentity( ).
  lv_keyword = lo_result->get_keyword( ).
  lv_keywordmessage = lo_result->get_keywordmessage( ).
  lv_keywordaction = lo_result->get_keywordaction( ).
ENDIF.

/AWS1/IF_PP2=>PUTKEYWORD()¶