Amazon Connect Service

{'RelatedContactId': 'string'}

Initiates a flow to start a new task.

See also: AWS API Documentation

Request Syntax

client.start_task_contact(
    InstanceId='string',
    PreviousContactId='string',
    ContactFlowId='string',
    Attributes={
        'string': 'string'
    },
    Name='string',
    References={
        'string': {
            'Value': 'string',
            'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
        }
    },
    Description='string',
    ClientToken='string',
    ScheduledTime=datetime(2015, 1, 1),
    TaskTemplateId='string',
    QuickConnectId='string',
    RelatedContactId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type PreviousContactId:

string

param PreviousContactId:

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

type ContactFlowId:

string

param ContactFlowId:

The identifier of the 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 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

type Attributes:

dict

param 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.

• (string) --

  • (string) --

type Name:

string

param Name:

[REQUIRED]

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

type References:

dict

param References:

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

• (string) --

  • (dict) --

    Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

    • Value (string) -- [REQUIRED]

      A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

    • Type (string) -- [REQUIRED]

      The type of the reference. DATE must be of type Epoch timestamp.

type Description:

string

param Description:

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

type ClientToken:

string

param 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.

This field is autopopulated if not provided.

type ScheduledTime:

datetime

param 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.

type TaskTemplateId:

string

param TaskTemplateId:

A unique identifier for the task template.

type QuickConnectId:

string

param QuickConnectId:

The identifier for the quick connect.

type RelatedContactId:

string

param RelatedContactId:

The contactId that is related to this contact.

rtype:

dict

returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

• (dict) --

  • ContactId (string) --

    The identifier of this contact within the Amazon Connect instance.