Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
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?

Workflow Resource

Workflows control how tasks will be prioritized and routed into Queues, and how Tasks should escalate in priority or move across queues over time. Workflows are described in a simple JSON format and can be modified through the REST API or through the account portal. You can learn more about Workflows here.

You specify which Workflow should control a Task when you add the Task to the Workspace. The Workflow will manage the Task's queue and priority until it is either assigned to a Worker, removed from the queue, or modified.

When a Task is assigned to a Worker, your application will receive a callback to the Workflow's AssignmentCallbackUrl, and your application can then do whatever is required to deliver the Task to the worker (for example, instructing Twilio to dial the phone number of the Worker selected to receive the call). Read more about Task assignment here.

複数のWorkflow

1つのWorkspaceに複数のWorkflowを設定できます。 これにより、さまざまなタイプのアプリケーションや状況に応じて異なるルーティングルールを設定できます。

For example, a call center has one group of Workers that handles both phone and chat tasks. These two Task types have different service-level targets and agent requirements. They will also originate from separate external applications. To separate application concerns, the call center creates a single Workspace with two separate Workflows, one for phone calls and the other for chat requests.

Taskの作成と割り当て

TaskをWorkspaceに追加するたびに、どのWorkflowでこのTaskをルーティングする必要があるかを指定します。 Workflowは、Taskに優先度を付けてQueueに入れます。QueueにあるTaskは、必要なケイパビリティを備えた使用可能なWorkerに割り当てられます。 詳細については、Taskリソースをご覧ください。

AssignmentCallbackUrl によるTask割り当ての処理

Every Workflow has an AssignmentCallbackURL property, as well as a FallbackAssignmentCallbackUrl in case requests to the first URL fail. When a Worker is assigned a Task, TaskRouter will make an HTTP request to this URL. Your application must handle this request to then do whatever is required to connect the Task to the Worker in your application. For example, this might mean pushing a case to an instance of an agent's web application, or dialing an agent's phone number using Twilio. See this section for more information on handling Task Assignment callbacks.

The AssignmentCallbackUrl is not required if you are planning on using just the JS SDK. In that case, simply leave the value blank.

If we cannot hit your AssignmentCallbackUrl or FallbackAssignmentCallbackUrl, TaskRouter will automatically change your Reservation status to canceled. To get a better sense of how assignment callbacks work, use a tool like Beeceptor to ensure that the assignment callback is firing correctly and to examine the contents of the post.

Workflow properties

Names in PHP format
accountSid
sid<AC> Not PII

このWorkflowを所有するアカウントのIDです

assignmentCallbackUrl
url Not PII

このWorkflowで管理しているTaskがWorkerに割り当てられるたびに呼び出されるURLです。 詳細については、割り当てコールバックURLをご覧ください。

configuration
文字列 Not PII

このWorkflowのルールを設定するJSONドキュメントです。詳細については、Workflowを設定するを参照してください。

dateCreated
date_time<iso8601> Not PII

このWorkflowが作成された日付です。

dateUpdated
date_time<iso8601> Not PII

このWorkflowが最後に更新された日付です。

documentContentType
文字列 Not PII

fallbackAssignmentCallbackUrl
url Not PII

AssignmentCallbackUrl に送信されたリクエストが失敗した場合、この URL に割り当てコールバックが送信されます。

friendlyName
文字列 PII MTL: 30 DAYS

Human readable description of this Workflow (for example "Customer Support" or "2014 Election Campaign")

sid
sid<WW> Not PII

Workflowの一意なIDです。

taskReservationTimeout
integer Not PII

TaskがWorkerに割り当てられた後、開発者のアプリケーションからの確認レスポンスをどのくらい待機するかを指定します。 既定値は120秒です。 最大値は86400 (24時間) です

workspaceSid
sid<WS> Not PII

このWorkflowが含まれるWorkspaceのIDです。

url
url Not PII

links
uri_map Not PII

Create a Workflow resource

post
https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows
パラメーター
Names in None format
friendly_name
必須
post 文字列 PII MTL: 30 DAYS

このWorkflowの、人間が読みやすい形式の名前を表す文字列です。 例: 「Inbound Call Workflow」、「2014 Outbound Campaign」

configuration
必須
post 文字列 Not PII

このWorkflowのルールを設定するJSONドキュメントです。詳細については、Workflowを設定するを参照してください。

assignment_callback_url
オプション
post url Not PII

Taskの割り当てEventを処理するアプリケーションへの有効なURLです。 詳細については、Task割り当てコールバックの処理をご参照ください。

fallback_assignment_callback_url
オプション
post url Not PII

AssignmentCallbackUrl に送信されたリクエストが失敗した場合、この URL に割り当てコールバックが送信されます。

task_reservation_timeout
オプション
post integer Not PII

TaskがWorkerに割り当てられた後、開発者のアプリケーションからの確認レスポンスをどのくらい待機するかを制御する整数値を秒数で指定します。 詳細については、Task割り当てコールバックを参照してください。 既定値は120秒です。 最大値は86400 (24時間) です

例 1
        
        
        
        

        The maximum amount of Workflows allowed for any given Workspace is 1,000. Please contact us if your use case will require more.

        Fetch a Workflow resource

        GET
        https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}
              
              
              
              

              Read multiple Workflow resources

              GET
              https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows
              パラメーター
              Names in None format
              friendly_name
              オプション
              GET 文字列 PII MTL: 30 DAYS

              Human readable description of this Workflow (for example "Customer Support" or "2014 Election Campaign")

                    
                    
                    
                    

                    Update a Workflow resource

                    post
                    https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}

                    Workflowを変更します。Workflowを変更するたびに、次の処理が行われます。

                    • TaskRouter validates your Workflow configuration to ensure it is syntactically correct and that all queues referenced in the document exist. If any problems are found, the update will fail, and the active Workflow will remain in place.
                    • 指定された構成に問題がない場合、TaskRouterは、変更前に保留中だったTaskをすべて変更前のWorkflowでルーティングします。変更直後から、新しいTaskは変更後のWorkflowを使い始めます。
                    パラメーター
                    Names in None format
                    friendly_name
                    オプション
                    post 文字列 PII MTL: 30 DAYS

                    このWorkflowの、人間が読みやすい形式の名前を表す文字列です。 たとえば、「Customer Support」、「Sales Team」などです。

                    assignment_callback_url
                    オプション
                    post url Not PII

                    Taskの割り当てEventを処理するアプリケーションへの有効なURLです。 詳細については、Task割り当てコールバックの処理をご参照ください。

                    fallback_assignment_callback_url
                    オプション
                    post url Not PII

                    AssignmentCallbackUrl に送信されたリクエストが失敗した場合、この URL に割り当てコールバックが送信されます。

                    configuration
                    オプション
                    post 文字列 Not PII

                    このWorkflowのルールを設定するJSONドキュメントです。詳細については、Workflowを設定するを参照してください。

                    task_reservation_timeout
                    オプション
                    post integer Not PII

                    TaskがWorkerに割り当てられた後、開発者のアプリケーションからの確認レスポンスをどのくらい待機するかを制御する整数値を秒数で指定します。 既定値は120秒です。 最大値は86400 (24時間) です

                          
                          
                          
                          

                          Delete a Workflow resource

                          削除する
                          https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}

                          Workflowを削除します。 指定されたWorkflowで制御されている、保留中のTaskまたは予約されているTaskが存在する場合はエラーを返します。

                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。