Task Submission API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes | ||
|---|---|---|---|---|
|
title |
The name of the task request. |
Required for POST and GET (create). | ||
|
name |
The person who generated the task request. |
Required for POST and GET (create). The name is limited to a maximum of 100 characters. A newline (\n) is not allowed in name. | ||
|
description |
An optional description to accompany the task request. | |||
|
scriptSelector |
The dialed number or script selector that is used to route the request to an agent. |
Obtain the script selector from the CCE configuration. The string identifier is limited to a maximum of 32 characters. | ||
|
requeueOnRecovery |
Indicates if the task will be requeued or discarded when Customer Collaboration Platform recovers after a failure event. |
Boolean. Defaults to false. | ||
|
tags |
One or more tags or keywords associated with the task request.
|
When using GET to create a task contact, use the parameter "tags" in the query string. | ||
|
variables |
A set of custom name and value pairs. |
When using GET to create a task request, pass the variables as query parameters and start with "variable_". You can specify the pre-defined variables "mediaType" and "podRefURL" for a task request. For more information, see Variables Used for Callback and Task APIs. | ||
|
status |
The status of a task request. | |||
|
estimatedWaitTime |
An estimate of the amount of time (in seconds) until an agent is available to handle the task. |
Returned in the XML success response. If CCE does not have enough data to calculate estimatedWaitTime, the API returns a value of -1. | ||
|
taskId |
The unique ID that is assigned by Unified CCE for a task request. |
Returned in the XML success response. | ||
|
agentId |
The ID of the agent who is assigned by Unified CCE for a task request. |
Returned in the XML success response. |