Own AWS? Customize your docs with AI search, analytics, and more.

POST

/contact/transfer

http://connect.{region}.amazonaws.com/contact/transfer

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: <ul> <li> Transfer is supported for only <code>TASK</code> contacts. </li> <li> Do not use both <code>QueueId</code> and <code>UserId</code> in the same call. </li> <li> The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. </li> <li> The <code>TransferContact</code> API can be called only on active contacts. </li> <li> A contact cannot be transferred more than 11 times. </li> </ul>

Access Token Required: API Key

Body Params

UserIdstring

The identifier for the user.

QueueIdstring

The identifier for the queue.

ContactIdstringrequired

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

InstanceIdstringrequired

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

ClientTokenstring

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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

ContactFlowIdstringrequired

The identifier of the flow.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/contact/transfer' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/contact/transfer

http://connect.{region}.amazonaws.com/contact/transfer

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: <ul> <li> Transfer is supported for only <code>TASK</code> contacts. </li> <li> Do not use both <code>QueueId</code> and <code>UserId</code> in the same call. </li> <li> The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. </li> <li> The <code>TransferContact</code> API can be called only on active contacts. </li> <li> A contact cannot be transferred more than 11 times. </li> </ul>

Access Token Required: API Key

Body Params

UserIdstring

The identifier for the user.

QueueIdstring

The identifier for the queue.

ContactIdstringrequired

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

InstanceIdstringrequired

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

ClientTokenstring

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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

ContactFlowIdstringrequired

The identifier of the flow.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/contact/transfer' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/contact/transfer

http://connect.{region}.amazonaws.com/contact/transfer

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: <ul> <li> Transfer is supported for only <code>TASK</code> contacts. </li> <li> Do not use both <code>QueueId</code> and <code>UserId</code> in the same call. </li> <li> The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. </li> <li> The <code>TransferContact</code> API can be called only on active contacts. </li> <li> A contact cannot be transferred more than 11 times. </li> </ul>

Access Token Required: API Key

Body Params

UserIdstring

The identifier for the user.

QueueIdstring

The identifier for the queue.

ContactIdstringrequired

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

InstanceIdstringrequired

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

ClientTokenstring

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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

ContactFlowIdstringrequired

The identifier of the flow.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/contact/transfer' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/contact/transfer

http://connect.{region}.amazonaws.com/contact/transfer

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: <ul> <li> Transfer is supported for only <code>TASK</code> contacts. </li> <li> Do not use both <code>QueueId</code> and <code>UserId</code> in the same call. </li> <li> The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. </li> <li> The <code>TransferContact</code> API can be called only on active contacts. </li> <li> A contact cannot be transferred more than 11 times. </li> </ul>

Access Token Required: API Key

Body Params

UserIdstring

The identifier for the user.

QueueIdstring

The identifier for the queue.

ContactIdstringrequired

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

InstanceIdstringrequired

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

ClientTokenstring

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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

ContactFlowIdstringrequired

The identifier of the flow.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/contact/transfer' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}