DESCRIBEOPTEDOUTNUMBERS()`¶

About DescribeOptedOutNumbers¶

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an exception is returned.

Method Signature¶

METHODS /AWS1/IF_PP2~DESCRIBEOPTEDOUTNUMBERS
  IMPORTING
    !IV_OPTOUTLISTNAME TYPE /AWS1/PP2OPTOUTLISTNAMEORARN OPTIONAL
    !IT_OPTEDOUTNUMBERS TYPE /AWS1/CL_PP2OPTEDOUTNUMLIST_W=>TT_OPTEDOUTNUMBERLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_PP2OPTEDOUTFILTER=>TT_OPTEDOUTFILTERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PP2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PP2MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pp2dscoptedoutnosrs
  RAISING
    /AWS1/CX_PP2ACCESSDENIEDEX
    /AWS1/CX_PP2INTERNALSERVEREX
    /AWS1/CX_PP2RESOURCENOTFOUNDEX
    /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_optoutlistname` `TYPE /AWS1/PP2OPTOUTLISTNAMEORARN` `/AWS1/PP2OPTOUTLISTNAMEORARN`¶

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

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

Optional arguments:¶

`it_optedoutnumbers` `TYPE /AWS1/CL_PP2OPTEDOUTNUMLIST_W=>TT_OPTEDOUTNUMBERLIST` `TT_OPTEDOUTNUMBERLIST`¶

An array of phone numbers to search for in the OptOutList.

If you specify an opted out number that isn't valid, an exception is returned.

`it_filters` `TYPE /AWS1/CL_PP2OPTEDOUTFILTER=>TT_OPTEDOUTFILTERLIST` `TT_OPTEDOUTFILTERLIST`¶

An array of OptedOutFilter objects to filter the results on.

`iv_nexttoken` `TYPE /AWS1/PP2NEXTTOKEN` `/AWS1/PP2NEXTTOKEN`¶

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.

`iv_maxresults` `TYPE /AWS1/PP2MAXRESULTS` `/AWS1/PP2MAXRESULTS`¶

The maximum number of results to return per each request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2dscoptedoutnosrs` `/AWS1/CL_PP2DSCOPTEDOUTNOSRS`¶

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->describeoptedoutnumbers(
  it_filters = VALUE /aws1/cl_pp2optedoutfilter=>tt_optedoutfilterlist(
    (
      new /aws1/cl_pp2optedoutfilter(
        it_values = VALUE /aws1/cl_pp2filtervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_pp2filtervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_optedoutnumbers = VALUE /aws1/cl_pp2optedoutnumlist_w=>tt_optedoutnumberlist(
    ( new /aws1/cl_pp2optedoutnumlist_w( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  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_optoutlistarn( ).
  lv_optoutlistname = lo_result->get_optoutlistname( ).
  LOOP AT lo_result->get_optedoutnumbers( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_phonenumber = lo_row_1->get_optedoutnumber( ).
      lv_timestamp = lo_row_1->get_optedouttimestamp( ).
      lv_primitiveboolean = lo_row_1->get_enduseroptedout( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PP2=>DESCRIBEOPTEDOUTNUMBERS()¶