Skip to content

/AWS1/IF_CNT=>SENDOUTBOUNDWEBNOTIFICATION()

About SendOutboundWebNotification

Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns.

Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

Method Signature

METHODS /AWS1/IF_CNT~SENDOUTBOUNDWEBNOTIFICATION
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
    !IV_BROWSERID TYPE /AWS1/CNTWEBBROWSERID OPTIONAL
    !IV_SESSIONID TYPE /AWS1/CNTWEBSESSIONID OPTIONAL
    !IV_EXPIRESAT TYPE /AWS1/CNTTIMESTAMP OPTIONAL
    !IO_SOURCE TYPE REF TO /AWS1/CL_CNTWEBNOTIFSOURCE OPTIONAL
    !IO_DESTINATION TYPE REF TO /AWS1/CL_CNTWIDGETDESTINATION OPTIONAL
    !IO_CONTENT TYPE REF TO /AWS1/CL_CNTWEBNOTIFCONTENT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsendoutbwebntfrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

iv_browserid TYPE /AWS1/CNTWEBBROWSERID /AWS1/CNTWEBBROWSERID

A unique identifier for the customer's web browser instance to which the notification is being sent.

iv_sessionid TYPE /AWS1/CNTWEBSESSIONID /AWS1/CNTWEBSESSIONID

A unique identifier for the customer's web session to which the notification is being sent.

iv_expiresat TYPE /AWS1/CNTTIMESTAMP /AWS1/CNTTIMESTAMP

The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

io_source TYPE REF TO /AWS1/CL_CNTWEBNOTIFSOURCE /AWS1/CL_CNTWEBNOTIFSOURCE

The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

io_destination TYPE REF TO /AWS1/CL_CNTWIDGETDESTINATION /AWS1/CL_CNTWIDGETDESTINATION

The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

io_content TYPE REF TO /AWS1/CL_CNTWEBNOTIFCONTENT /AWS1/CL_CNTWEBNOTIFCONTENT

The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

Optional arguments:

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntsendoutbwebntfrsp /AWS1/CL_CNTSENDOUTBWEBNTFRSP

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->sendoutboundwebnotification(
  io_content = new /aws1/cl_cntwebnotifcontent(
    io_attributes = new /aws1/cl_cntcontentattributes(
      io_recommenderconfig = new /aws1/cl_cntrecommenderconfig(
        it_context = VALUE /aws1/cl_cntrecmdrcontext_w=>tt_recommendercontext(
          (
            VALUE /aws1/cl_cntrecmdrcontext_w=>ts_recommendercontext_maprow(
              key = |string|
              value = new /aws1/cl_cntrecmdrcontext_w( |string| )
            )
          )
        )
        iv_domainname = |string|
        iv_recommendername = |string|
      )
    )
    iv_type = |string|
    iv_viewarn = |string|
  )
  io_destination = new /aws1/cl_cntwidgetdestination(
    iv_profileid = |string|
    iv_widgetid = |string|
  )
  io_source = new /aws1/cl_cntwebnotifsource(
    io_sourcecampaign = new /aws1/cl_cntsourcecampaign(
      iv_campaignid = |string|
      iv_outboundrequestid = |string|
    )
  )
  iv_browserid = |string|
  iv_clienttoken = |string|
  iv_expiresat = '20150101000000.0000000'
  iv_instanceid = |string|
  iv_sessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.