Learn R Programming

paws.customer.engagement (version 0.1.12)

connect_start_task_contact: Initiates a contact flow to start a new task

Description

Initiates a contact flow to start a new task.

Usage

connect_start_task_contact(InstanceId, PreviousContactId, ContactFlowId,
  Attributes, Name, References, Description, ClientToken)

Value

A list with the following syntax:

list(
  ContactId = "string"
)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

PreviousContactId

The identifier of the previous chat, voice, or task contact.

ContactFlowId

[required] The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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 contact 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).

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.

Request syntax

svc$start_task_contact(
  InstanceId = "string",
  PreviousContactId = "string",
  ContactFlowId = "string",
  Attributes = list(
    "string"
  ),
  Name = "string",
  References = list(
    list(
      Value = "string",
      Type = "URL"
    )
  ),
  Description = "string",
  ClientToken = "string"
)