View source: R/connect_operations.R
connect_start_task_contact | R Documentation |
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
See https://www.paws-r-sdk.com/docs/connect_start_task_contact/ for full documentation.
connect_start_task_contact(
InstanceId,
PreviousContactId = NULL,
ContactFlowId = NULL,
Attributes = NULL,
Name,
References = NULL,
Description = NULL,
ClientToken = NULL,
ScheduledTime = NULL,
TaskTemplateId = NULL,
QuickConnectId = NULL,
RelatedContactId = NULL
)
InstanceId |
[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
PreviousContactId |
The identifier of the previous chat, voice, or task contact. Any updates
to user-defined attributes to task contacts linked using the same
|
ContactFlowId |
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold: arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx |
Attributes |
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. |
Name |
[required] The name of a task that is shown to an agent in the Contact Control Panel (CCP). |
References |
A formatted URL that is shown to an agent in the Contact Control Panel
(CCP). Tasks can have the following reference types at the time of
creation: |
Description |
A description of the task that is shown to an agent in the Contact Control Panel (CCP). |
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. |
ScheduledTime |
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. |
TaskTemplateId |
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide. |
QuickConnectId |
The identifier for the quick connect. Tasks that are created by using
|
RelatedContactId |
The contactId that is
related
to this contact. Linking tasks together by using |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.