メニュー

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?

REST API: Activities

Activityは、Workerの現在のステータスを表します。これにより、WorkerがTask割り当てを受諾する資格があるかどうかが決まります。 Workerは、常に1つのActivityに設定されます。

各Activityに、Workerの状態を人間が読みやすい形式で説明するFriendlyNameがあります。 また、booleanの「availability」値があり、これにより現在そのActivityに設定されているWorkerがTask割り当てで使用可能かどうかが決まります。 可用性が「true」のActivityにWorkerが設定されている場合、これは、そのWorkerがTask割り当て可能であることを意味します。 可用性が「false」のActivityにWorkerが設定されている場合、これは、そのWorkerは新しいTaskを受諾できないので、割り当て対象として考慮されないことを意味します。

Workerを受付不可から受付可Activityに移動することで、TaskRouterにWorkerが新しいTaskに割り当て可能であることを合図します。 TaskRouterがWorkerにTaskを割り当てると自動的に受付不可のActivityに移行し、こちらに占有されている間は新しいTaskの割り当てが行われなくなります。 作業の完了時は、Workerは受付可のActivityに移行して再度、新しいTaskの承諾を開始できます。

既定のActivity

TaskRouter pre-populates new Workspaces with the Activities "Offline", "Unavailable", and "Available" to make it easy to get up and running quickly. You may add your own Activities to this list if you'd like a more granular understanding of the way your Workers are spending their time.

Workerの状態遷移に対する既定のActivityの構成

特定のWorkerの現在のActivityは、次の操作によって変更されます。

  • アプリケーションは、WorkerインスタンスリソースにPOSTを送信してWorkspaceに存在するActivitySidを渡すことによって、WorkerのActivityを更新できます。
  • If a Reservation times out, the Worker is placed in the TimeoutActivity identified by the Workspace. By default this is Offline.
  • 新しいWorkerが作成されると、特定のActivitySidが渡された場合を除いて、Workspaceで指定されている DefaultActivity にWorkerが配置されます。これは、既定では Offline です。

In addition, a single-tasking Workspace supports two additional automatic state transitions:

  • When the Worker is assigned a Task, the Worker is placed in the ReservationActivity identified by the TaskQueue that assigns the Worker the Task. By default this is the Reserved Activity.
  • When a Worker accepts a Task, the Worker is placed in the AssignmentActivity identified by the TaskQueue that assigns the Worker the Task. By default this is the Busy Activity.

In a multitasking Workspace, a Worker's state does not automatically update when a Task is assigned.

アクション


全Activityを一覧する

リソースURI

GET /v1/Workspaces/{WorkspaceSid}/Activities

{WorkspaceSid} で指定されるWorkspace内のActivityの一覧を返します。

WorkspaceのすべてのActivityを一覧する例

        
        
        
        

        リストフィルター

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

        フィールド 概要
        FriendlyName Filter by an Activity's friendly name (🏢 not PII )
        available Filter by activities that are available or unavailable. (Note: This can be 'true', '1'' or 'yes' to indicate a true value. All other values will represent false) (🏢 not PII )

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


        Activityを作成する

        リソースURI

        POST /v1/Workspaces/{WorkspaceSid}/Activities
        

        新しいActivityを作成します。

        新しいActivityを作成する例

              
              
              
              
              必須パラメーター
              フィールド 概要
              FriendlyName A human-readable name for the Activity, such as 'On Call', 'Break', 'Email', etc. Must be unique in this Workspace. These names will be used to calculate and expose statistics about workers, and give you visibility into the state of each of your workers. (🏢 not PII )
              オプションパラメーター
              フィールド 概要
              available Boolean value indicating whether the worker should be eligible to receive a Task when they occupy this Activity. For example, a call center might have an activity named 'On Call' with an availability set to 'false'. Note: This can be 'true', '1' or 'yes' to indicate a true value. All other values will represent false. Defaults to false. (🏢 not PII )

              メモ: 所定のWorkspaceに許容されるActivityの最大数は100です。


              Activityを取得する

              リソースURI

              GET /v1/Workspaces/{WorkspaceSid}/Activities/{ActivitySid}
              

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

              単一のActivityを取得する例

                    
                    
                    
                    

                    リソースのプロパティ

                    フィールド 概要
                    Sid このActivityの一意なIDです。
                    AccountSid このActivityを所有するアカウントの一意なIDです。
                    WorkspaceSid このActivityが属するWorkspaceの一意なIDです。
                    FriendlyName 「on-call」、「break」、「email」など、人間が読みやすい形式のActivityの名前です。 これらの名前は、Workerに関する統計を計算して公開し、各Workerの状態をわかりやすく示すために使われます。
                    available このActivityに設定されているWorkerに、Taskを受諾する資格があるかどうかを示すブール値です。たとえば、「On Call」という名前のActivityでは、WorkerがさらにTask割り当てを承諾することはできません。
                    DateCreated このActivityが作成された日付です。
                    DateUpdated このActivityが更新された日付です。

                    Activityを更新する

                    リソースURI

                    POST /v1/Workspaces/{WorkspaceSid}/Activities/{ActivitySid}
                    

                    {ActivitySid} で識別されるActivityを更新します。

                    Activityの FriendlyName を更新する例

                          
                          
                          
                          

                          POSTパラメーター

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

                          フィールド 概要
                          FriendlyName A human-readable name for the Activity, such as 'on-call', 'break', 'email', etc. These names will be used to calculate and expose statistics about workers, and give you visibility into the state of each of your workers. (🏢 not PII )

                          Activityを削除する

                          リソースURI

                          DELETE /v1/Workspaces/{WorkspaceSid}/Activities/{ActivitySid}
                          

                          {ActivitySid} で識別されるActivityを削除します。 現在そのActivityにWorkerが設定されている場合は失敗します。

                          Activityを削除する例

                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

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