ASSOCIATECONTACTWITHUSER()`¶

About AssociateContactWithUser¶

Associates a queued contact with an agent.

Use cases

Following are common uses cases for this API:

Programmatically assign queued contacts to available users.
Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user.

Important things to know

Use this API with chat, email, and task contacts. It does not support voice contacts.
Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.
It honors the IAM context key connect:PreferredUserArn to prevent unauthorized contact associations.
It respects the IAM context key connect:PreferredUserArn to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.
The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Amazon Connect quotas in the Amazon Connect Administrator Guide.

Endpoints: See Amazon Connect endpoints and quotas.

Method Signature¶

METHODS /AWS1/IF_CNT~ASSOCIATECONTACTWITHUSER
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_CONTACTID TYPE /AWS1/CNTCONTACTID OPTIONAL
    !IV_USERID TYPE /AWS1/CNTAGENTRESOURCEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntassccontwthuserrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /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 contact in this instance of Amazon Connect.

`iv_userid` `TYPE /AWS1/CNTAGENTRESOURCEID` `/AWS1/CNTAGENTRESOURCEID`¶

The identifier for the user. This can be the ID or the ARN of the user.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntassccontwthuserrsp` `/AWS1/CL_CNTASSCCONTWTHUSERRSP`¶

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->associatecontactwithuser(
  iv_contactid = |string|
  iv_instanceid = |string|
  iv_userid = |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=>ASSOCIATECONTACTWITHUSER()¶