STOPCONTACT()`¶

About StopContact¶

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR

Chat and task contacts can be terminated in any state, regardless of initiation method.

Method Signature¶

METHODS /AWS1/IF_CNT~STOPCONTACT
  IMPORTING
    !IV_CONTACTID TYPE /AWS1/CNTCONTACTID OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IO_DISCONNECTREASON TYPE REF TO /AWS1/CL_CNTDISCONNECTREASON OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntstopcontactrsp
  RAISING
    /AWS1/CX_CNTCONTACTNOTFOUNDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_contactid` `TYPE /AWS1/CNTCONTACTID` `/AWS1/CNTCONTACTID`¶

The ID of the contact.

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

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

Optional arguments:¶

`io_disconnectreason` `TYPE REF TO /AWS1/CL_CNTDISCONNECTREASON` `/AWS1/CL_CNTDISCONNECTREASON`¶

The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field. For a list and description of all the possible disconnect reasons by channel (including outbound campaign voice contacts) see DisconnectReason under ContactTraceRecord in the Amazon Connect Administrator Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntstopcontactrsp` `/AWS1/CL_CNTSTOPCONTACTRSP`¶

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->stopcontact(
  io_disconnectreason = new /aws1/cl_cntdisconnectreason( |string| )
  iv_contactid = |string|
  iv_instanceid = |string|
).

This is an example of reading all possible response values

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

/AWS1/IF_CNT=>STOPCONTACT()¶