Skip to content

/AWS1/IF_CN2=>DESCRIBECAMPAIGN()

About DescribeCampaign

Describes the specific campaign.

Method Signature

METHODS /AWS1/IF_CN2~DESCRIBECAMPAIGN
  IMPORTING
    !IV_ID TYPE /AWS1/CN2CAMPAIGNID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cn2descrcampaignrsp
  RAISING
    /AWS1/CX_CN2ACCESSDENIEDEX
    /AWS1/CX_CN2INTERNALSERVEREX
    /AWS1/CX_CN2RESOURCENOTFOUNDEX
    /AWS1/CX_CN2VALIDATIONEX
    /AWS1/CX_CN2CLIENTEXC
    /AWS1/CX_CN2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_id TYPE /AWS1/CN2CAMPAIGNID /AWS1/CN2CAMPAIGNID

id

RETURNING

oo_output TYPE REF TO /aws1/cl_cn2descrcampaignrsp /AWS1/CL_CN2DESCRCAMPAIGNRSP

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->describecampaign( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_campaign = lo_result->get_campaign( ).
  IF lo_campaign IS NOT INITIAL.
    lv_campaignid = lo_campaign->get_id( ).
    lv_campaignarn = lo_campaign->get_arn( ).
    lv_campaignname = lo_campaign->get_name( ).
    lv_instanceid = lo_campaign->get_connectinstanceid( ).
    lo_channelsubtypeconfig = lo_campaign->get_channelsubtypeconfig( ).
    IF lo_channelsubtypeconfig IS NOT INITIAL.
      lo_telephonychannelsubtype = lo_channelsubtypeconfig->get_telephony( ).
      IF lo_telephonychannelsubtype IS NOT INITIAL.
        lv_capacity = lo_telephonychannelsubtype->get_capacity( ).
        lv_queueid = lo_telephonychannelsubtype->get_connectqueueid( ).
        lo_telephonyoutboundmode = lo_telephonychannelsubtype->get_outboundmode( ).
        IF lo_telephonyoutboundmode IS NOT INITIAL.
          lo_progressiveconfig = lo_telephonyoutboundmode->get_progressive( ).
          IF lo_progressiveconfig IS NOT INITIAL.
            lv_bandwidthallocation = lo_progressiveconfig->get_bandwidthallocation( ).
          ENDIF.
          lo_predictiveconfig = lo_telephonyoutboundmode->get_predictive( ).
          IF lo_predictiveconfig IS NOT INITIAL.
            lv_bandwidthallocation = lo_predictiveconfig->get_bandwidthallocation( ).
          ENDIF.
          lo_agentlessconfig = lo_telephonyoutboundmode->get_agentless( ).
          IF lo_agentlessconfig IS NOT INITIAL.
          ENDIF.
          lo_previewconfig = lo_telephonyoutboundmode->get_preview( ).
          IF lo_previewconfig IS NOT INITIAL.
            lv_bandwidthallocation = lo_previewconfig->get_bandwidthallocation( ).
            lo_timeoutconfig = lo_previewconfig->get_timeoutconfig( ).
            IF lo_timeoutconfig IS NOT INITIAL.
              lv_timeoutduration = lo_timeoutconfig->get_durationinseconds( ).
            ENDIF.
            LOOP AT lo_previewconfig->get_agentactions( ) into lo_row.
              lo_row_1 = lo_row.
              IF lo_row_1 IS NOT INITIAL.
                lv_agentaction = lo_row_1->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDIF.
        lo_telephonyoutboundconfig = lo_telephonychannelsubtype->get_defaultoutboundconfig( ).
        IF lo_telephonyoutboundconfig IS NOT INITIAL.
          lv_contactflowid = lo_telephonyoutboundconfig->get_connectcontactflowid( ).
          lv_sourcephonenumber = lo_telephonyoutboundconfig->get_connectsourcephonenumber( ).
          lo_answermachinedetectionc = lo_telephonyoutboundconfig->get_answermachinedetectcfg( ).
          IF lo_answermachinedetectionc IS NOT INITIAL.
            lv_boolean = lo_answermachinedetectionc->get_enbanswermachinedetect( ).
            lv_boolean = lo_answermachinedetectionc->get_awaitanswermachineprompt( ).
          ENDIF.
        ENDIF.
      ENDIF.
      lo_smschannelsubtypeconfig = lo_channelsubtypeconfig->get_sms( ).
      IF lo_smschannelsubtypeconfig IS NOT INITIAL.
        lv_capacity = lo_smschannelsubtypeconfig->get_capacity( ).
        lo_smsoutboundmode = lo_smschannelsubtypeconfig->get_outboundmode( ).
        IF lo_smsoutboundmode IS NOT INITIAL.
          lo_agentlessconfig = lo_smsoutboundmode->get_agentless( ).
          IF lo_agentlessconfig IS NOT INITIAL.
          ENDIF.
        ENDIF.
        lo_smsoutboundconfig = lo_smschannelsubtypeconfig->get_defaultoutboundconfig( ).
        IF lo_smsoutboundconfig IS NOT INITIAL.
          lv_arn = lo_smsoutboundconfig->get_cnctsourcephonenumberarn( ).
          lv_arn = lo_smsoutboundconfig->get_wisdomtemplatearn( ).
        ENDIF.
      ENDIF.
      lo_emailchannelsubtypeconf = lo_channelsubtypeconfig->get_email( ).
      IF lo_emailchannelsubtypeconf IS NOT INITIAL.
        lv_capacity = lo_emailchannelsubtypeconf->get_capacity( ).
        lo_emailoutboundmode = lo_emailchannelsubtypeconf->get_outboundmode( ).
        IF lo_emailoutboundmode IS NOT INITIAL.
          lo_agentlessconfig = lo_emailoutboundmode->get_agentless( ).
          IF lo_agentlessconfig IS NOT INITIAL.
          ENDIF.
        ENDIF.
        lo_emailoutboundconfig = lo_emailchannelsubtypeconf->get_defaultoutboundconfig( ).
        IF lo_emailoutboundconfig IS NOT INITIAL.
          lv_emailaddress = lo_emailoutboundconfig->get_cnctsourceemailaddress( ).
          lv_emaildisplayname = lo_emailoutboundconfig->get_srcemailaddressdspname( ).
          lv_arn = lo_emailoutboundconfig->get_wisdomtemplatearn( ).
        ENDIF.
      ENDIF.
    ENDIF.
    lo_source = lo_campaign->get_source( ).
    IF lo_source IS NOT INITIAL.
      lv_arn = lo_source->get_cusprofilessegmentarn( ).
      lo_eventtrigger = lo_source->get_eventtrigger( ).
      IF lo_eventtrigger IS NOT INITIAL.
        lv_arn = lo_eventtrigger->get_cusprofilesdomainarn( ).
      ENDIF.
    ENDIF.
    lv_arn = lo_campaign->get_connectcampaignflowarn( ).
    lo_schedule = lo_campaign->get_schedule( ).
    IF lo_schedule IS NOT INITIAL.
      lv_timestamp = lo_schedule->get_starttime( ).
      lv_timestamp = lo_schedule->get_endtime( ).
      lv_iso8601duration = lo_schedule->get_refreshfrequency( ).
    ENDIF.
    lo_communicationtimeconfig = lo_campaign->get_communicationtimeconfig( ).
    IF lo_communicationtimeconfig IS NOT INITIAL.
      lo_localtimezoneconfig = lo_communicationtimeconfig->get_localtimezoneconfig( ).
      IF lo_localtimezoneconfig IS NOT INITIAL.
        lv_timezone = lo_localtimezoneconfig->get_defaulttimezone( ).
        LOOP AT lo_localtimezoneconfig->get_localtimezonedetection( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_localtimezonedetectiont = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_timewindow = lo_communicationtimeconfig->get_telephony( ).
      IF lo_timewindow IS NOT INITIAL.
        lo_openhours = lo_timewindow->get_openhours( ).
        IF lo_openhours IS NOT INITIAL.
          LOOP AT lo_openhours->get_dailyhours( ) into ls_row_4.
            lv_key = ls_row_4-key.
            LOOP AT ls_row_4-value into lo_row_5.
              lo_row_6 = lo_row_5.
              IF lo_row_6 IS NOT INITIAL.
                lv_iso8601time = lo_row_6->get_starttime( ).
                lv_iso8601time = lo_row_6->get_endtime( ).
              ENDIF.
            ENDLOOP.
          ENDLOOP.
        ENDIF.
        lo_restrictedperiods = lo_timewindow->get_restrictedperiods( ).
        IF lo_restrictedperiods IS NOT INITIAL.
          LOOP AT lo_restrictedperiods->get_restrictedperiodlist( ) into lo_row_7.
            lo_row_8 = lo_row_7.
            IF lo_row_8 IS NOT INITIAL.
              lv_restrictedperiodname = lo_row_8->get_name( ).
              lv_iso8601date = lo_row_8->get_startdate( ).
              lv_iso8601date = lo_row_8->get_enddate( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
      lo_timewindow = lo_communicationtimeconfig->get_sms( ).
      IF lo_timewindow IS NOT INITIAL.
        lo_openhours = lo_timewindow->get_openhours( ).
        IF lo_openhours IS NOT INITIAL.
          LOOP AT lo_openhours->get_dailyhours( ) into ls_row_4.
            lv_key = ls_row_4-key.
            LOOP AT ls_row_4-value into lo_row_5.
              lo_row_6 = lo_row_5.
              IF lo_row_6 IS NOT INITIAL.
                lv_iso8601time = lo_row_6->get_starttime( ).
                lv_iso8601time = lo_row_6->get_endtime( ).
              ENDIF.
            ENDLOOP.
          ENDLOOP.
        ENDIF.
        lo_restrictedperiods = lo_timewindow->get_restrictedperiods( ).
        IF lo_restrictedperiods IS NOT INITIAL.
          LOOP AT lo_restrictedperiods->get_restrictedperiodlist( ) into lo_row_7.
            lo_row_8 = lo_row_7.
            IF lo_row_8 IS NOT INITIAL.
              lv_restrictedperiodname = lo_row_8->get_name( ).
              lv_iso8601date = lo_row_8->get_startdate( ).
              lv_iso8601date = lo_row_8->get_enddate( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
      lo_timewindow = lo_communicationtimeconfig->get_email( ).
      IF lo_timewindow IS NOT INITIAL.
        lo_openhours = lo_timewindow->get_openhours( ).
        IF lo_openhours IS NOT INITIAL.
          LOOP AT lo_openhours->get_dailyhours( ) into ls_row_4.
            lv_key = ls_row_4-key.
            LOOP AT ls_row_4-value into lo_row_5.
              lo_row_6 = lo_row_5.
              IF lo_row_6 IS NOT INITIAL.
                lv_iso8601time = lo_row_6->get_starttime( ).
                lv_iso8601time = lo_row_6->get_endtime( ).
              ENDIF.
            ENDLOOP.
          ENDLOOP.
        ENDIF.
        lo_restrictedperiods = lo_timewindow->get_restrictedperiods( ).
        IF lo_restrictedperiods IS NOT INITIAL.
          LOOP AT lo_restrictedperiods->get_restrictedperiodlist( ) into lo_row_7.
            lo_row_8 = lo_row_7.
            IF lo_row_8 IS NOT INITIAL.
              lv_restrictedperiodname = lo_row_8->get_name( ).
              lv_iso8601date = lo_row_8->get_startdate( ).
              lv_iso8601date = lo_row_8->get_enddate( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDIF.
    lo_communicationlimitsconf = lo_campaign->get_communicationlmtsoverr00( ).
    IF lo_communicationlimitsconf IS NOT INITIAL.
      lo_communicationlimits = lo_communicationlimitsconf->get_allchannelsubtypes( ).
      IF lo_communicationlimits IS NOT INITIAL.
        LOOP AT lo_communicationlimits->get_communicationlimitslist( ) into lo_row_9.
          lo_row_10 = lo_row_9.
          IF lo_row_10 IS NOT INITIAL.
            lv_integer = lo_row_10->get_maxcountperrecipient( ).
            lv_integer = lo_row_10->get_frequency( ).
            lv_communicationlimittimeu = lo_row_10->get_unit( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_instancelimitshandling = lo_communicationlimitsconf->get_instancelimitshandling( ).
    ENDIF.
    LOOP AT lo_campaign->get_tags( ) into ls_row_11.
      lv_key_1 = ls_row_11-key.
      lo_value = ls_row_11-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.