Connect / Client / transfer_contact

transfer_contact#

Connect.Client.transfer_contact(**kwargs)#

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:

  • Transfer is supported for only TASK contacts.

  • Do not use both QueueId and UserId in the same call.

  • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

  • The TransferContact API can be called only on active contacts.

  • A contact cannot be transferred more than 11 times.

See also: AWS API Documentation

Request Syntax

response = client.transfer_contact(
    InstanceId='string',
    ContactId='string',
    QueueId='string',
    UserId='string',
    ContactFlowId='string',
    ClientToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact in this instance of Amazon Connect.

  • QueueId (string) – The identifier for the queue.

  • UserId (string) – The identifier for the user.

  • ContactFlowId (string) –

    [REQUIRED]

    The identifier of the flow.

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string',
    'ContactArn': 'string'
}

Response Structure

  • (dict) –

    • ContactId (string) –

      The identifier of the contact in this instance of Amazon Connect.

    • ContactArn (string) –

      The Amazon Resource Name (ARN) of the contact.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.IdempotencyException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ServiceQuotaExceededException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException