Task interface for actionable Reservations from TaskRouter SDK
Properties:
| Name | Type | Description |
|---|---|---|
sourceObject |
Object | source object backing the instance (any) |
addOns |
Object | the addons attached to the Task |
age |
int | the age of the Task in seconds |
attributes |
Object | the attributes of the Task |
dateCreated |
Date | the date the Task was created |
dateUpdated |
Date | the date the Task was last updated |
priority |
int | the priority of the Task |
queueName |
string | the friendly name of the TaskQueue the Task is currently in |
queueSid |
string | the sid of the TaskQueue the Task is currently in |
reason |
string | the reason the Task was completed or canceled, if applicable |
sid |
string | the sid of the Reservation |
status |
ITask.TaskReservationStatus | the status of the Reservation |
taskSid |
string | the sid of the Task |
taskStatus |
ITask.TaskTaskStatus | the status of the Task |
taskChannelSid |
string | the sid of the Task Channel associated to the Task in MultiTask mode |
taskChannelUniqueName |
string | the unique name of the Task Channel associated to the Task in MultiTask mode |
timeout |
int | the number of seconds the Task is allowed to live |
workflowName |
string | the name of the Workflow responsible for routing the Task |
workflowSid |
string | the sid of the Workflow responsible for routing the Task |
incomingTransferObject |
ITask.TaskTransfer | transfer object if Task was transferred to the current user |
outgoingTransferObject |
ITask.TaskTransfer | transfer object if is being transferred to another user by current user |
channelType |
string | channel type - either `channelType` property defined in the attributes of Task or `taskChannelUniqueName` property |
defaultFrom |
string | default initiator of a Task. Either `name` or `from` property defined in the attributes. If not specified then 'Anonymous' is returned |
Type Definitions
"pending"
|
"accepted"
|
"wrapping"
|
"completed"
|
"canceled"
# TaskReservationStatus
Status of the Reservation
# TaskTransfer
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
mode |
"COLD" | "WARM" | transfer mode | |
sid |
string | The sid of this Transfer | |
status |
"INITIATED" | "FAILED" | "COMPLETE" | "CANCELED" | transfer status | |
to |
string | The sid of the Worker or TaskQueue this Transfer is intended for | |
type |
"QUEUE" | "WORKER" | The transfer type | |
workerSid |
string | The sid of the initiating Worker | |
worker |
IWorker |
<optional> |
The instance of the initiating Worker |
queue |
IQueue |
<optional> |
Target queue instance |