| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Connect.TransferContact
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 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
TASKcontacts. - Do not use both
QueueIdandUserIdin the same call. - The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
- The
TransferContactAPI can be called only on active contacts. - A contact cannot be transferred more than 11 times.
Synopsis
- data TransferContact = TransferContact' {
- clientToken :: Maybe Text
- queueId :: Maybe Text
- userId :: Maybe Text
- instanceId :: Text
- contactId :: Text
- contactFlowId :: Text
- newTransferContact :: Text -> Text -> Text -> TransferContact
- transferContact_clientToken :: Lens' TransferContact (Maybe Text)
- transferContact_queueId :: Lens' TransferContact (Maybe Text)
- transferContact_userId :: Lens' TransferContact (Maybe Text)
- transferContact_instanceId :: Lens' TransferContact Text
- transferContact_contactId :: Lens' TransferContact Text
- transferContact_contactFlowId :: Lens' TransferContact Text
- data TransferContactResponse = TransferContactResponse' {
- contactArn :: Maybe Text
- contactId :: Maybe Text
- httpStatus :: Int
- newTransferContactResponse :: Int -> TransferContactResponse
- transferContactResponse_contactArn :: Lens' TransferContactResponse (Maybe Text)
- transferContactResponse_contactId :: Lens' TransferContactResponse (Maybe Text)
- transferContactResponse_httpStatus :: Lens' TransferContactResponse Int
Creating a Request
data TransferContact Source #
See: newTransferContact smart constructor.
Constructors
| TransferContact' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TransferContact |
Create a value of TransferContact with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:TransferContact', transferContact_clientToken - 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.
TransferContact, transferContact_queueId - The identifier for the queue.
TransferContact, transferContact_userId - The identifier for the user.
TransferContact, transferContact_instanceId - The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
TransferContact, transferContact_contactId - The identifier of the contact in this instance of Amazon Connect.
TransferContact, transferContact_contactFlowId - The identifier of the flow.
Request Lenses
transferContact_clientToken :: Lens' TransferContact (Maybe Text) Source #
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.
transferContact_queueId :: Lens' TransferContact (Maybe Text) Source #
The identifier for the queue.
transferContact_userId :: Lens' TransferContact (Maybe Text) Source #
The identifier for the user.
transferContact_instanceId :: Lens' TransferContact Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
transferContact_contactId :: Lens' TransferContact Text Source #
The identifier of the contact in this instance of Amazon Connect.
transferContact_contactFlowId :: Lens' TransferContact Text Source #
The identifier of the flow.
Destructuring the Response
data TransferContactResponse Source #
See: newTransferContactResponse smart constructor.
Constructors
| TransferContactResponse' | |
Fields
| |
Instances
newTransferContactResponse Source #
Create a value of TransferContactResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contactArn:TransferContactResponse', transferContactResponse_contactArn - The Amazon Resource Name (ARN) of the contact.
TransferContact, transferContactResponse_contactId - The identifier of the contact in this instance of Amazon Connect.
$sel:httpStatus:TransferContactResponse', transferContactResponse_httpStatus - The response's http status code.
Response Lenses
transferContactResponse_contactArn :: Lens' TransferContactResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the contact.
transferContactResponse_contactId :: Lens' TransferContactResponse (Maybe Text) Source #
The identifier of the contact in this instance of Amazon Connect.
transferContactResponse_httpStatus :: Lens' TransferContactResponse Int Source #
The response's http status code.