Connect / Client / start_task_contact

start_task_contact

Connect.Client.start_task_contact(**kwargs)

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.

When using PreviousContactId and RelatedContactId input parameters, note the following:

• PreviousContactId

  • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

  • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

• RelatedContactId

  • Copies contact attributes from the related task contact to the new contact.

  • Any update on attributes in a new task contact does not update attributes on previous contact.

  • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_task_contact(
    InstanceId='string',
    PreviousContactId='string',
    ContactFlowId='string',
    Attributes={
        'string': 'string'
    },
    Name='string',
    References={
        'string': {
            'Value': 'string',
            'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE',
            'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
            'Arn': 'string',
            'StatusReason': 'string'
        }
    },
    Description='string',
    ClientToken='string',
    ScheduledTime=datetime(2015, 1, 1),
    TaskTemplateId='string',
    QuickConnectId='string',
    RelatedContactId='string',
    SegmentAttributes={
        'string': {
            'ValueString': 'string',
            'ValueMap': {
                'string': {'... recursive ...'}
            },
            'ValueInteger': 123
        }
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

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

• PreviousContactId (string) – The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

• ContactFlowId (string) –

  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, 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 (dict) –

  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) –

• Name (string) –

  [REQUIRED]

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

• References (dict) –

  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: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

  • (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) –

        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.

      • Status (string) –

        Status of the attachment reference type.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the reference

      • StatusReason (string) –

        Relevant details why the reference was not successfully created.

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

• ClientToken (string) –

  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.

• ScheduledTime (datetime) – 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 (string) – A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.

• QuickConnectId (string) – The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

• RelatedContactId (string) – The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

• SegmentAttributes (dict) –

  A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

  Attribute keys can include only alphanumeric, -, and _.

  This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.

  Note

  To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

  To set the created by user, a valid AgentResourceId must be supplied, with SegmentAttributes like { "connect:CreatedByUser" { "ValueString": "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}.

  • (string) –

    • (dict) –

      A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

      • ValueString (string) –

        The value of a segment attribute.

      • ValueMap (dict) –

        The value of a segment attribute.

        • (string) –

          • (dict) –

            A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

      • ValueInteger (integer) –

        The value of a segment attribute.

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

• (dict) –

  • ContactId (string) –

    The identifier of this contact within the Amazon Connect instance.

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.ServiceQuotaExceededException

• Connect.Client.exceptions.InternalServiceException