メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: Events

TaskRouterは、履歴のレポートと監査のために、Workspaceにおける各状態変更のEventを記録します。 また、それらのEventが発生するたびに、Eventの詳細を含むHTTPリクエストをWorkspaceのEventCallbackURLに送信します(詳細については、Eventコールバックをご覧ください)。

Event インスタンスリソース

リソースURI

/v1/Workspaces/{WorkspaceSid}/Events/{EventSid}

HTTP GET

{EventSid} で識別される特定のEventを返します。

リソースのプロパティ

すべてのEventに、次のプロパティが関連付けられています。

フィールド 概要
EventType このEventの識別子です
AccountSid このEventを所有するアカウントです
概要 このEventの説明です
リソースタイプ このEventをもっとも関連するオブジェクトのタイプです(Task、Reservation、Worker)
ResourceSid このEventを最も良く表しているオブジェクトのsidです(TaskSid、ReservationSid、WorkerSid)。
EventDate このEventが送信された時刻(UTC時刻)です
EventData この特定のEventに関するデータです。詳細については、下記をご覧ください

Event リストリソース

Workspaceにおける各状態変更に関して記録されたすべてのEventのリストを返します。 各Eventの内容については、下記をご覧ください。内容は、Eventタイプに応じて異なります。

リソースURI

/v1/Workspaces/{WorkspaceSid}/Events

HTTP GET

Eventをクエリーする際、次のパラメーターを追加できます。

WorkspaceのEventを一覧する例

        
        
        
        
        パラメーター 概要
        過去最大 'x' 分までのEventをフィルタリングします。過去15分、240分(4時間)、および480分(8時間)のEventを取得してトレンドを見る場合に役に立ちます。初期値は15分です。
        StartDate 開始日でEventをフィルタリングします。取得するEventの範囲を定義するのに役立ちます。GMT ISO 8601フォーマットで入力します。
        EndDate 終了日でEventをフィルタリングします。取得するEventの範囲を定義するのに役立ちます。GMT ISO 8601 フォーマット で入力します。
        EventType 特定のEventタイプのEventをフィルタリングします。
        WorkerSid 特定のWorkerに関連するEventをフィルタリングします。
        TaskQueueSid 特定のQueueに関連するEventをフィルタリングします。
        TaskSid 特定のTaskに関連するEventをフィルタリングします
        ReservationSid 特定のReservationに関連するEventをフィルタリングします

        メモ: 既定では、最初の50 Eventが返されます。それよりも多くのEventを取得する場合は、PageSizeパラメーターを指定してください。詳細については、「ページ情報」を参照してください。

        If the StartDate of the Events request is greater than 30 days in the past, then the events returned will not contain fields that may contain Personally Identifiable Information. The fields labeled as PII in the tables below will be redacted.

        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は、Eventが発生するたびに、Workspaceで構成されているEventCallbackURLにPOSTを送信して、次のパラメーターを渡します。

        注: 処理量の多いTaskRouterシステムでは、大量のEventが頻繁に発生します。アプリケーションの規模を検討する際は、このことに注意してください。

        パラメーター 概要
        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の送信日時です。

        イベントタイプ

        The following are the events sent by TaskRouter. All relevant fields at that particular moment will be logged.

        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.
        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.
        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 its first 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 enters a new queue during workflow processing
        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
        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

        TaskのEventのフィールド

        Task関連のEventのログを記録する場合、Eventコールバックには以下のフィールドが含まれます。

        パラメーター 概要
        TaskSid 変更されたTaskのSIDです
        TaskAttributes The JSON Attributes of the task (📇 PII )
        TaskAge Taskの有効期限です
        TaskPriority Taskの優先度です
        TaskAssignmentStatus Taskの割り当てステータスです
        TaskCanceledReason Taskがキャンセルされた理由です
        TaskCompletedReason Taskが完了した理由

        WorkerのEventのフィールド

        Workerに関連するEventが発生すると、以下のフィールドが渡されます。

        パラメーター 概要
        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) です。

        WorkerのActivityの変更に関するEventが発生すると、さらに以下のフィールドが渡されます。

        パラメーター 概要
        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
        Rate this page:

        ヘルプが必要ですか?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.