StartTaskContact
Initiates a flow to start a new task.
Request Syntax
PUT /contact/task HTTP/1.1
Content-type: application/json
{
"Attributes": {
"string
" : "string
"
},
"ClientToken": "string
",
"ContactFlowId": "string
",
"Description": "string
",
"InstanceId": "string
",
"Name": "string
",
"PreviousContactId": "string
",
"QuickConnectId": "string
",
"References": {
"string
" : {
"Type": "string
",
"Value": "string
"
}
},
"RelatedContactId": "string
",
"ScheduledTime": number
,
"TaskTemplateId": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- 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.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 32767.
Value Length Constraints: Minimum length of 0. Maximum length of 32767.
Required: No
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
. Type: String
Length Constraints: Maximum length of 500.
Required: No
- 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: String
Length Constraints: Maximum length of 500.
Required: No
- Description
-
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- Name
-
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Required: Yes
- PreviousContactId
-
The identifier of the previous chat, voice, or task contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- QuickConnectId
-
The identifier for the quick connect.
Type: String
Required: No
- References
-
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
Type: String to Reference object map
Key Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- RelatedContactId
-
The contactId that is related to this contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- 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: Timestamp
Required: No
- TaskTemplateId
-
A unique identifier for the task template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ContactId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ContactId
-
The identifier of this contact within the Amazon Connect instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The service quota has been exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: