LISTCONTACTREFERENCES()`¶

About ListContactReferences¶

This API is in preview release for Amazon Connect and is subject to change.

For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

Method Signature¶

METHODS /AWS1/IF_CNT~LISTCONTACTREFERENCES
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_CONTACTID TYPE /AWS1/CNTCONTACTID OPTIONAL
    !IT_REFERENCETYPES TYPE /AWS1/CL_CNTREFERENCETYPES_W=>TT_REFERENCETYPES OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntlstcontactrefere01
  RAISING
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

The identifier of the initial contact.

`it_referencetypes` `TYPE /AWS1/CL_CNTREFERENCETYPES_W=>TT_REFERENCETYPES` `TT_REFERENCETYPES`¶

The type of reference.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/CNTNEXTTOKEN` `/AWS1/CNTNEXTTOKEN`¶

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

This is not expected to be set, because the value returned in the previous response is always null.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntlstcontactrefere01` `/AWS1/CL_CNTLSTCONTACTREFERE01`¶

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->listcontactreferences(
  it_referencetypes = VALUE /aws1/cl_cntreferencetypes_w=>tt_referencetypes(
    ( new /aws1/cl_cntreferencetypes_w( |string| ) )
  )
  iv_contactid = |string|
  iv_instanceid = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_referencesummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_urlreference = lo_row_1->get_url( ).
      IF lo_urlreference IS NOT INITIAL.
        lv_referencekey = lo_urlreference->get_name( ).
        lv_referencevalue = lo_urlreference->get_value( ).
      ENDIF.
      lo_attachmentreference = lo_row_1->get_attachment( ).
      IF lo_attachmentreference IS NOT INITIAL.
        lv_referencekey = lo_attachmentreference->get_name( ).
        lv_referencevalue = lo_attachmentreference->get_value( ).
        lv_referencestatus = lo_attachmentreference->get_status( ).
        lv_referencearn = lo_attachmentreference->get_arn( ).
      ENDIF.
      lo_emailmessagereference = lo_row_1->get_emailmessage( ).
      IF lo_emailmessagereference IS NOT INITIAL.
        lv_referencekey = lo_emailmessagereference->get_name( ).
        lv_referencearn = lo_emailmessagereference->get_arn( ).
      ENDIF.
      lo_stringreference = lo_row_1->get_string( ).
      IF lo_stringreference IS NOT INITIAL.
        lv_referencekey = lo_stringreference->get_name( ).
        lv_referencevalue = lo_stringreference->get_value( ).
      ENDIF.
      lo_numberreference = lo_row_1->get_number( ).
      IF lo_numberreference IS NOT INITIAL.
        lv_referencekey = lo_numberreference->get_name( ).
        lv_referencevalue = lo_numberreference->get_value( ).
      ENDIF.
      lo_datereference = lo_row_1->get_date( ).
      IF lo_datereference IS NOT INITIAL.
        lv_referencekey = lo_datereference->get_name( ).
        lv_referencevalue = lo_datereference->get_value( ).
      ENDIF.
      lo_emailreference = lo_row_1->get_email( ).
      IF lo_emailreference IS NOT INITIAL.
        lv_referencekey = lo_emailreference->get_name( ).
        lv_referencevalue = lo_emailreference->get_value( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CNT=>LISTCONTACTREFERENCES()¶