CREATECAMPAIGN()`¶

About CreateCampaign¶

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Method Signature¶

METHODS /AWS1/IF_CNC~CREATECAMPAIGN
  IMPORTING
    !IV_NAME TYPE /AWS1/CNCCAMPAIGNNAME OPTIONAL
    !IV_CONNECTINSTANCEID TYPE /AWS1/CNCINSTANCEID OPTIONAL
    !IO_DIALERCONFIG TYPE REF TO /AWS1/CL_CNCDIALERCONFIG OPTIONAL
    !IO_OUTBOUNDCALLCONFIG TYPE REF TO /AWS1/CL_CNCOUTBOUNDCALLCONFIG OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CNCTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cnccreatecampaignrsp
  RAISING
    /AWS1/CX_CNCACCESSDENIEDEX
    /AWS1/CX_CNCCONFLICTEXCEPTION
    /AWS1/CX_CNCINTERNALSERVEREX
    /AWS1/CX_CNCRESOURCENOTFOUNDEX
    /AWS1/CX_CNCSERVICEQUOTAEXCDEX
    /AWS1/CX_CNCTHROTTLINGEX
    /AWS1/CX_CNCVALIDATIONEX
    /AWS1/CX_CNCCLIENTEXC
    /AWS1/CX_CNCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/CNCCAMPAIGNNAME` `/AWS1/CNCCAMPAIGNNAME`¶

The name of an Amazon Connect Campaign name.

`iv_connectinstanceid` `TYPE /AWS1/CNCINSTANCEID` `/AWS1/CNCINSTANCEID`¶

Amazon Connect Instance Id

`io_dialerconfig` `TYPE REF TO /AWS1/CL_CNCDIALERCONFIG` `/AWS1/CL_CNCDIALERCONFIG`¶

The possible types of dialer config parameters

`io_outboundcallconfig` `TYPE REF TO /AWS1/CL_CNCOUTBOUNDCALLCONFIG` `/AWS1/CL_CNCOUTBOUNDCALLCONFIG`¶

The configuration used for outbound calls.

Optional arguments:¶

`it_tags` `TYPE /AWS1/CL_CNCTAGMAP_W=>TT_TAGMAP` `TT_TAGMAP`¶

Tag map with key and value.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cnccreatecampaignrsp` `/AWS1/CL_CNCCREATECAMPAIGNRSP`¶

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->createcampaign(
  io_dialerconfig = new /aws1/cl_cncdialerconfig(
    io_agentlessdialerconfig = new /aws1/cl_cncagentlessdialercfg( '0.1' )
    io_predictivedialerconfig = new /aws1/cl_cncpredictivedialer00(
      iv_bandwidthallocation = '0.1'
      iv_dialingcapacity = '0.1'
    )
    io_progressivedialerconfig = new /aws1/cl_cncprgssivedialercfg(
      iv_bandwidthallocation = '0.1'
      iv_dialingcapacity = '0.1'
    )
  )
  io_outboundcallconfig = new /aws1/cl_cncoutboundcallconfig(
    io_answermachinedetectconfig = new /aws1/cl_cncanswermachinedet00(
      iv_awaitanswermachineprompt = ABAP_TRUE
      iv_enableanswermachinedetect = ABAP_TRUE
    )
    iv_connectcontactflowid = |string|
    iv_connectqueueid = |string|
    iv_connectsourcephonenumber = |string|
  )
  it_tags = VALUE /aws1/cl_cnctagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_cnctagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_cnctagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_connectinstanceid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_campaignid = lo_result->get_id( ).
  lv_campaignarn = lo_result->get_arn( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_CNC=>CREATECAMPAIGN()¶