CREATERCSAGENT()`¶

About CreateRcsAgent¶

Creates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your recipients.

Method Signature¶

METHODS /AWS1/IF_PP2~CREATERCSAGENT
  IMPORTING
    !IV_DELETIONPROTECTIONENABLED TYPE /AWS1/PP2BOOLEAN OPTIONAL
    !IV_OPTOUTLISTNAME TYPE /AWS1/PP2OPTOUTLISTNAMEORARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_PP2TAG=>TT_TAGLIST OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/PP2CLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pp2creatercsagentrslt
  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¶

Optional arguments:¶

`iv_deletionprotectionenabled` `TYPE /AWS1/PP2BOOLEAN` `/AWS1/PP2BOOLEAN`¶

By default this is set to false. When set to true the RCS agent can't be deleted. You can change this value using the UpdateRcsAgent action.

`iv_optoutlistname` `TYPE /AWS1/PP2OPTOUTLISTNAMEORARN` `/AWS1/PP2OPTOUTLISTNAMEORARN`¶

The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

`it_tags` `TYPE /AWS1/CL_PP2TAG=>TT_TAGLIST` `TT_TAGLIST`¶

An array of tags (key and value pairs) associated with the RCS agent.

`iv_clienttoken` `TYPE /AWS1/PP2CLIENTTOKEN` `/AWS1/PP2CLIENTTOKEN`¶

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2creatercsagentrslt` `/AWS1/CL_PP2CREATERCSAGENTRSLT`¶

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->creatercsagent(
  it_tags = VALUE /aws1/cl_pp2tag=>tt_taglist(
    (
      new /aws1/cl_pp2tag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_deletionprotectionenabled = ABAP_TRUE
  iv_optoutlistname = |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_rcsagentarn( ).
  lv_string = lo_result->get_rcsagentid( ).
  lv_rcsagentstatus = lo_result->get_status( ).
  lv_primitiveboolean = lo_result->get_deletionprotectionenbd( ).
  lv_optoutlistname = lo_result->get_optoutlistname( ).
  lv_timestamp = lo_result->get_createdtimestamp( ).
  lv_primitiveboolean = lo_result->get_selfmanagedoptoutsenbd( ).
  lv_twowaychannelarn = lo_result->get_twowaychannelarn( ).
  lv_iamrolearn = lo_result->get_twowaychannelrole( ).
  lv_primitiveboolean = lo_result->get_twowayenabled( ).
  LOOP AT lo_result->get_tags( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_tagkey = lo_row_1->get_key( ).
      lv_tagvalue = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_PP2=>CREATERCSAGENT()¶