[ aws . connect ]

transfer-contact

Description

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 contact 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 contact flow types are supported: Inbound contact 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  transfer-contact
--instance-id <value>
--contact-id <value>
[--queue-id <value>]
[--user-id <value>]
--contact-flow-id <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--contact-id (string)

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

--queue-id (string)

The identifier for the queue.

--user-id (string)

The identifier for the user.

--contact-flow-id (string)

The identifier of the contact flow.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

ContactId -> (string)

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

ContactArn -> (string)

The Amazon Resource Name (ARN) of the contact.