メニュー

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: Workspaces

Workspaceは、Task、Worker、TaskQueue、Workflow、およびActivityの入れ物です。 これらのアイテムはそれぞれ単一のWorkspace内に存在し、複数のWorkspace間では共有されません。 たとえば、業務でTaskRouterを使用して2つの別々の組織のTaskを割り当てる場合、組織ごとにWorkspaceを作成します。

単一のWorkspaceに、さまざまなタイプと優先度のTaskおよびさまざまな能力を持つWorkerを保持できます。 たとえばコンタクトセンターは待ち呼、保留中の案件、および受信したチャットリクエストを単一のWorkspaceで収集できます。このWorkspaceにある通話の中には、英語を話すエージェントを必要とするものも、スペイン語を話すエージェントを必要とするものもあります。Taskの中で高価値顧客から発生したものには高い優先度が与えられ、それ以外のTaskは解決までにかかる時間が長くなる可能性があります。

アクション


全Workspaceを一覧する

リソースURI

GET /v1/Workspaces

{AccountSid} で識別されるアカウントのWorkspaceの一覧を返します。

アカウントに対する全Workspaceの一覧の例です。

        
        
        
        

        リストフィルター

        下記のGETのクエリー文字列パラメーターを使用すると、返される一覧を制限することができます。 パラメーターは大文字と小文字を区別することに注意してください:

        フィールド 概要
        FriendlyName Workspaceのわかりやすい名前 (friendly name) でフィルタリングを行います。 これは、このWorkspaceの、人間が読みやすい形式の説明(例:"Customer Support"、"2014 Election Campaign")です。

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


        Workspaceを作成する

        リソースURI

        POST /v1/Workspaces
        

        新しいWorkspaceを作成します。

        新しいWorkspaceを作成する例

              
              
              
              
              必須パラメーター
              フィールド 概要
              FriendlyName Human readable description of this workspace (for example “Customer Support” or “2014 Election Campaign”) (📇 PII )
              オプションパラメーター
              フィールド 概要
              EventCallbackUrl If provided, the Workspace will publish events to this URL. You can use this to gather data for reporting. See Workspace Events for more information. (🏢 not PII )
              EventsFilter Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace. For example if 'EventsFilter=task.created,task.canceled,worker.activity.update', then TaskRouter will webhook to EventCallbackUrl only when a task is created, canceled or a worker activity is updated. (🏢 not PII )
              テンプレート One of the available template names. Will pre-configure this Workspace with the Workflow and Activities specified in the template. “NONE” will create a Workspace with a set of default activities and nothing else. "FIFO" will configure TaskRouter with a set of default activities and a single task queue for first-in, first-out distribution, useful if you want to see a simple TaskRouter configuration when getting started. Defaults to "NONE". (🏢 not PII )
              MultiTaskEnabled Multi tasking allows workers to handle multiple tasks simultaneously. Default is enabled (MultiTaskEnabled=true), where each worker will be eligible to receive parallel reservations up to the per-channel maximums defined in the Workers section. When disabled (MultiTaskEnabled=false), each worker will only receive a new reservation when the previous task is completed. Learn more by visiting Multitasking. (🏢 not PII )
              PrioritizeQueueOrder Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues. Default is FIFO. Click here to learn more about LIFO and the use of the parameter. (🏢 not PII )

              メモ: あるアカウントで許容されるWorkspaceの最大数は 5,000 です。それよりも多くを必要とする事例の場合は、ご連絡ください


              Workspaceを取得する

              リソースURI

              GET /v1/Workspaces/{WorkspaceSid}
              

              {WorkspaceSid} で識別される単一の Workspace リソースを返します。

              リソースのプロパティ

              Workspace インスタンスリソースには、次のプロパティがあります。

              アカウントの単一のWorkspaceを取得する例です。

                    
                    
                    
                    
                    フィールド 概要
                    Sid Workspaceの一意なIDです。
                    AccountSid このWorkflowを所有するアカウントのIDです
                    FriendlyName このWorkspaceの、人間が読みやすい形式の説明(例:"Sales Call Center"、"Customer Support Team")です
                    DefaultActivitySid このWorkspaceで新しいWorkerを作成する際に使用するActivityのIDです。
                    DefaultActivityName 既定のActivityの、人間が読みやすい形式の名前です。読み取り専用です。
                    TimeoutActivitySid Task Reservationが応答なしでタイムアウトしたときにWorkerに割り当てられるActivityのIDです。
                    TimeoutActivityName タイムアウトActivityの、人間が読みやすい形式の名前です。読み取り専用です。
                    EventCallbackUrl WorkspaceがEventを送信するオプションのURLです。 これを使用して、レポート用データを収集できます。 詳細については、WorkspaceのEventを参照してください。指定はオプションです。
                    MultiTaskEnabled 属性はマルチタスキングが有効の時にはtrueが返され、それ以外はfalseとなります。 詳細については、マルチタスキングをご参照ください。
                    PrioritizeQueueOrder WorkerがLIFOおよびFIFOのTaskQueuesの組み合わせからなるTaskを受信している場合のTaskの優先順位です。 LIFOについての詳しい情報については、こちらをクリックしてください。
                    DateCreated このWorkspaceが生成された日時です。GMT ISO 8601フォーマットです。
                    DateUpdated このWorkspaceが最後に更新された日時です。GMT ISO 8601 フォーマットです。

                    Workspaceを更新する

                    リソースURI

                    POST /v1/Workspaces/{WorkspaceSid}
                    

                    Workspaceを更新します。

                    Workspaceを更新する例

                          
                          
                          
                          

                          POSTパラメーター

                          Workspace リソースを変更する際、次のパラメーターを使用できます。

                          フィールド 概要
                          FriendlyName Human readable description of this workspace (for example “Sales Call Center” or “Customer Support Team”) (📇 PII )
                          EventCallbackUrl The Workspace will publish events to this URL. You can use this to gather data for reporting. See Events for more information. (🏢 not PII )
                          EventsFilter Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace. For example if 'EventsFilter=task.created,task.canceled,worker.activity.update', then TaskRouter will webhook to EventCallbackUrl only when a task is created, canceled or a worker activity is updated. (🏢 not PII )
                          DefaultActivitySid The ID of the Activity that will be used when new Workers are created in this Workspace. (🏢 not PII )
                          TimeoutActivitySid The ID of the Activity that will be assigned to a Worker when a Task reservation times out without a response. (🏢 not PII )
                          MultiTaskEnabled Enable or Disable Multitasking by passing either true or False with the POST request. Learn more by visiting Multitasking. (🏢 not PII )
                          PrioritizeQueueOrder Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues. Default is FIFO. Click here to learn more about LIFO and the use of the parameter. (🏢 not PII )

                          Workspaceを削除する

                          リソースURI

                          DELETE /v1/Workspaces/{WorkspaceSid}
                          

                          Workspaceを削除します。

                          Workspaceを削除する例

                                
                                
                                
                                

                                Workspace インスタンスサブリソース

                                すべてのWorkspaceで、次のサブリソースがサポートされます。

                                Workers

                                /v1/Workspaces/{WorkspaceSid}/Workers
                                

                                コールセンターのエージェント、ヘルプデスクで働く人々など、このWorkflowからのTaskを処理できるリソースを表します。 詳細については、Workerを参照してください。

                                Activities

                                /v1/Workspaces/{WorkspaceSid}/Activities
                                

                                WorkerがTaskを処理できるかどうかは、そのActivityによって制御されます。 Activityは、Workerが現在何を実行しているかを表し、リアルタイムのWorker統計にわかりやすいラベルを付けます。詳細については、Activityをご覧ください。

                                TaskQueues

                                /v1/Workspaces/{WorkspaceSid}/TaskQueues
                                

                                TaskQueueには、Workerへの割り当てを待機中のTaskが保持されます。 各TaskQueueは、WorkerがこのQueueからのTaskを受諾するために持つ必要があるケイパビリティを指定します。詳細については、TaskQueueをご覧ください。

                                Workflow

                                /v1/Workspaces/{WorkspaceSid}/Workflows
                                

                                Workflowは、Taskに優先度を付けて、Queueにルーティングする方法を制御します。 また、Taskの優先度をエスカレートしたり、タイムアウトしたTaskを別のQueueに移動したり、割り当てられずにタイムアウトしたTaskをWorkspaceから完全に削除したりできます。 すべてのTaskは、Workflowを通じてWorkspaceに入れられます。それ以降は、Workerに割り当てられるか、Workspaceから削除されるまで、Workflowによって管理されます。詳細については、Workflowをご覧ください。

                                Tasks

                                /v1/Workspaces/{WorkspaceSid}/Tasks
                                

                                このWorkspaceで待機中のTaskを表します。詳細については、Taskをご覧ください。

                                Statistics

                                /v1/Workspaces/{WorkspaceSid}/Statistics
                                

                                統計は、TaskRouterのサブリソースごとに集計されます。 統計を使用して、チームのレポート用のダッシュボードや画面を構築できます。 詳細については、統計をご覧ください。

                                Events

                                /v1/Workspaces/{WorkspaceSid}/Events
                                

                                Eventは、Workspaceに対する変更を表します。 Eventを使用して、TaskRouter環境の履歴レポートを作成します。 詳細については、Eventをご覧ください。

                                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.