SENDCHATINTEGRATIONEVENT()`¶

About SendChatIntegrationEvent¶

Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration.

Method Signature¶

METHODS /AWS1/IF_CNT~SENDCHATINTEGRATIONEVENT
  IMPORTING
    !IV_SOURCEID TYPE /AWS1/CNTSOURCEID OPTIONAL
    !IV_DESTINATIONID TYPE /AWS1/CNTDESTINATIONID OPTIONAL
    !IV_SUBTYPE TYPE /AWS1/CNTSUBTYPE OPTIONAL
    !IO_EVENT TYPE REF TO /AWS1/CL_CNTCHATEVENT OPTIONAL
    !IO_NEWSESSIONDETAILS TYPE REF TO /AWS1/CL_CNTNEWSESSIONDETAILS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsendchatintegrat01
  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_sourceid` `TYPE /AWS1/CNTSOURCEID` `/AWS1/CNTSOURCEID`¶

External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

`iv_destinationid` `TYPE /AWS1/CNTDESTINATIONID` `/AWS1/CNTDESTINATIONID`¶

Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.

`io_event` `TYPE REF TO /AWS1/CL_CNTCHATEVENT` `/AWS1/CL_CNTCHATEVENT`¶

Chat integration event payload

Optional arguments:¶

`iv_subtype` `TYPE /AWS1/CNTSUBTYPE` `/AWS1/CNTSUBTYPE`¶

Classification of a channel. This is used in part to uniquely identify chat.

Valid value: ["connect:sms", connect:"WhatsApp"]

`io_newsessiondetails` `TYPE REF TO /AWS1/CL_CNTNEWSESSIONDETAILS` `/AWS1/CL_CNTNEWSESSIONDETAILS`¶

Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntsendchatintegrat01` `/AWS1/CL_CNTSENDCHATINTEGRAT01`¶

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->sendchatintegrationevent(
  io_event = new /aws1/cl_cntchatevent(
    iv_content = |string|
    iv_contenttype = |string|
    iv_type = |string|
  )
  io_newsessiondetails = new /aws1/cl_cntnewsessiondetails(
    io_participantdetails = new /aws1/cl_cntparticipantdetails( |string| )
    io_streamingconfiguration = new /aws1/cl_cntchatstreamingconf( |string| )
    it_attributes = VALUE /aws1/cl_cntattributes_w=>tt_attributes(
      (
        VALUE /aws1/cl_cntattributes_w=>ts_attributes_maprow(
          value = new /aws1/cl_cntattributes_w( |string| )
          key = |string|
        )
      )
    )
    it_suppedmessagingconttypes = VALUE /aws1/cl_cntsuppedmessagingc00=>tt_suppedmessagingcontenttypes(
      ( new /aws1/cl_cntsuppedmessagingc00( |string| ) )
    )
  )
  iv_destinationid = |string|
  iv_sourceid = |string|
  iv_subtype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_contactid = lo_result->get_initialcontactid( ).
  lv_newchatcreated = lo_result->get_newchatcreated( ).
ENDIF.

/AWS1/IF_CNT=>SENDCHATINTEGRATIONEVENT()¶