TaskRouter Events Reference
TaskRouter will make an HTTP request containing Event details to the Workspace's EventCallbackURL each time an Event takes place. This page contains a full list of Events and a description of Event Callbacks.
A busy TaskRouter system will generate a large volume of Events at a frequent rate. Keep this in mind when considering how your application will scale.
Eventコールバック
The EventCallbackUrl is defined on the Workspace. Your application should respond to Event Callbacks with 204 No Content and a Content-Type header of application/json within 15 seconds.
TaskRouter will POST the following parameters to the EventCallbackURL configured on your Workspace each time an Event occurs.
| パラメーター | 概要 |
|---|---|
| EventType | このEventの識別子です |
| AccountSid | このEventを所有するアカウントです |
| WorkspaceSid | このEventが発生したWorkspaceのSidです |
| WorkspaceName | The Workspace Name generating this event (📇 PII ) |
| EventDescription | A description of the event (📇 PII ) |
| リソースタイプ | このEventをもっとも関連するオブジェクトのタイプです（Task、Reservation、Worker） |
| ResourceSid | このEventを最も良く表しているオブジェクトのsidです（TaskSid、ReservationSid、WorkerSid）。 |
| Timestamp | このEventの送信日時です。 |
イベントタイプ
Reservation
Events
| EventType | フィールドデータ | 概要 |
|---|---|---|
| reservation.created | Task Worker TaskQueueSid ReservationSid WorkflowSid |
A task is assigned to a worker |
| reservation.accepted | Task Worker TaskQueueSid ReservationSid WorkflowSid |
Task ReservationがWorkerによって承諾されました |
| reservation.rejected | Task Worker TaskQueueSid ReservationSid WorkflowSid |
Task ReservationがWorkerによって拒否されました |
| reservation.timeout | Task Worker TaskQueueSid ReservationSid WorkflowSid |
Too much time passed without a task being accepted or rejected. The reservation is canceled. |
| reservation.canceled | Task Worker TaskQueueSid ReservationSid WorkflowSid |
A task reservation is canceled before it has been accepted by a worker |
| reservation.rescinded | Task Worker TaskQueueSid ReservationSid WorkflowSid |
Multi-reservation was used for a task and another worker has accepted one of the created reservations |
| reservation.completed | Task Worker TaskQueueSid ReservationSid WorkflowSid |
A task reservation is completed. Aligns with task.completed. |
| reservation.failed | Task TaskQueueSid ReservationSid WorkflowSid |
The reservation failed and was not assigned to an agent. |
| reservation.wrapup | Task Worker TaskQueueSid ReservationSid WorkflowSid |
The task reservation is being wrapped up by the agent; happens directly before task completion. |
Task
イベント
| EventType | フィールドデータ | 概要 |
|---|---|---|
| task.created | Task WorkflowSid |
TaskアイテムがWorkspaceに追加されました |
| task.updated | Task TaskQueueSid WorkflowSid |
A task’s attributes are changed |
| task.canceled | Task TaskQueueSid WorkflowSid |
A task is canceled |
| task.wrapup | Task TaskQueueSid WorkflowSid |
A task is moved to wrapup state. |
| task.completed | Task TaskQueueSid WorkflowSid |
A task is completed |
| task.deleted | Task TaskQueueSid WorkflowSid |
A task is deleted via API. Does not include auto-deleted Tasks after cancelation/completion. |
| task.system-deleted | Task TaskQueueSid WorkflowSid |
A task is deleted via the system, after the task reaches its TTL. |
| task.transfer-initiated | Task TaskQueueSid WorkflowSid |
|
| task.transfer-attempt-failed | Task TaskQueueSid WorkflowSid |
|
| task.transfer-failed | Task TaskQueueSid WorkflowSid |
|
| task.transfer-canceled | Task TaskQueueSid WorkflowSid |
|
| task.transfer-completed | Task TaskQueueSid WorkflowSid |
Event Fields
Task関連のEventのログを記録する場合、Eventコールバックには以下のフィールドが含まれます。
| パラメーター | 概要 |
|---|---|
| TaskSid | 変更されたTaskのSIDです |
| TaskAttributes | The JSON Attributes of the task (📇 PII ) |
| TaskAge | Taskの有効期限です |
| TaskPriority | Taskの優先度です |
| TaskAssignmentStatus | Taskの割り当てステータスです |
| TaskCanceledReason | Taskがキャンセルされた理由です |
| TaskCompletedReason | Taskが完了した理由 |
TaskChannel
Events
| EventType | フィールドデータ | 概要 |
|---|---|---|
| task-channel.created | TaskChannel | A task channel is created |
| task-channel.updated | TaskChannel | A task channel is updated |
| task-channel.deleted | TaskChannel | A task channel is deleted |
Event Fields
When an event comes in that relates to a Task Channel, the following fields will be passed in:
| パラメーター | 概要 |
|---|---|
| TaskChannelSid | The SID of the task-channel |
| TaskChannelName | The Friendly Name of the task-channel (📇 PII ) |
| TaskChannelUniqueName | An application-defined string that uniquely identifies the Task Channel, such as voice or sms |
| TaskChannelOptimizedRouting | Whether the Task Channel should prioritize Workers that have been idle. If true, Workers that have been idle the longest are prioritized. |
Task Queue
Events
| EventType | フィールドデータ | 概要 |
|---|---|---|
| task-queue.created | TaskQueueSid TaskQueueName TaskQueueTargetExpression |
A TaskQueue has been created |
| task-queue.deleted | TaskQueueSid TaskQueueName TaskQueueTargetExpression |
A TaskQueue has been deleted |
| task-queue.entered | Task TaskQueueSid WorkflowSid |
A task enters a queue during workflow processing |
| task-queue.timeout | Task TaskQueueSid WorkflowSid |
A workflow routing step timed-out and a task is leaving a queue |
| task-queue.moved | Task TaskQueueSid WorkflowSid |
A task leaves its current queue to move to a new queue during workflow processing |
| task-queue.expression.updated | TaskQueueSid TaskQueueTargetExpression |
The queue expression has been updated |
Worker
Events
| EventType | フィールドデータ | 概要 |
|---|---|---|
| worker.created | Worker | A worker is created |
| worker.activity.update | Worker | A worker’s activity is updated |
| worker.attributes.update | Worker | A worker’s attributes are updated |
| worker.capacity.update | Worker Channel |
A worker's channel's configured capacity has been updated |
| worker.channel.availability.update | Worker Channel |
A worker's channel's availability has been updated |
| worker.deleted | Worker | A worker is deleted |
Event Fields
When an event comes in that relates to a Worker, the following fields will be passed in:
| パラメーター | 概要 |
|---|---|
| WorkerSid | 変更されたWorkerのSIDです。 |
| WorkerName | The Friendly Name of the worker (📇 PII ) |
| WorkerAttributes | The JSON Attributes of the worker (📇 PII ) |
| WorkerActivitySid | Workerの新しいActivityのSIDです。 |
| WorkerActivityName | Workerの新しいActivityの分かりやすい名前 (Friendly Name) です。 |
| WorkerVersion | The current worker version |
When an event comes in that relates to a Worker's activity changing, the following additional fields will be passed in:
| パラメーター | 概要 |
|---|---|
| WorkerTimeInPreviousActivity | 直前のActivityで費やされた時間で、小数点ゼロで切り捨てられた小数です |
| WorkerTimeInPreviousActivityMs | 直前のActivityで費やされた時間で、単位はミリ秒です |
| WorkerPreviousActivitySid | 今回の状態変更の前に実行したActivityのSIDです。 |
When an event comes in that relates to a Worker's configured channel capacity or availability changing, the following additional fields will be passed in:
| パラメーター | 概要 |
|---|---|
| WorkerChannelAvailable | The availability of the channel |
| WorkerChannelAvailableCapacity | The available capacity of the channel |
| WorkerChannelPreviousCapacity | The previous capacity of the channel |
| TaskChannelSid | The associated channel sid |
| TaskChannelUniqueName | The associated channel unique name |
| WorkerChannelTaskCount | The number of assigned tasks to this worker on this channel |
Workflow
Events
| EventType | フィールドデータ | 概要 |
|---|---|---|
| workflow.target-matched | Task WorkflowSid |
A task item matches a workflow routing step |
| workflow.entered | Task WorkflowSid |
A task enters a workflow |
| workflow.timeout | Task WorkflowSid |
A task reaches the end of a workflow without being accepted and is removed from the workspace |
| workflow.skipped | Task WorkflowSid |
A task skips-out of the workflow (because of skip_if in the final step) and is removed from the workspace |
ヘルプが必要ですか？
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.