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?

Worker Resource

Workerは、コールセンターで働くエージェントやリードを処理する販売員など、Taskを実行できるエンティティを表します。

Worker properties

Workerの属性
Every Worker has a set of Attributes that describe what sort of tasks the Worker is able to complete. Attributes are modeled as a JSON string and may contain string, integer, and array data. These attributes will be used to link a Worker to one or more TaskQueues, and thus determine which Tasks the Worker is eligible to handle.

たとえば、2人のエージェントが存在するとします。 1人目のWorkerであるAliceは英語を話し、サポートとセールスのTaskを処理します。

{ 
    "skills": ["support", "sales"], 
    "languages":["english"]
}

2人目のWorkerであるBobは、セールスリクエストのみ処理し、スペイン語と英語を話します。

{ 
    "skills": ["sales"], 
    "languages": ["spanish", "english"]
}

A property of contact_uri is required on the WorkerAttributes to indicate whom to call when issuing a Dequeue Instruction.

{ 
    "skills": ["sales"], 
    "languages": ["spanish", "english"],
    "contact_uri": "client:Bob"
}

WorkerのActivity

また、各WorkerにはActivityが存在し、ActivitySid で表されます。 このActivityによって、Workerのシステム内での現在の状態、さらにWorkerが新しいTask割り当てを受諾できるかどうかが決まります。

Names in PHP format
accountSid
sid<AC> Not PII

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

activityName
文字列 Not PII

フレンドリー名で指定される特定のActivityに存在するWorkerでフィルタリングします。

activitySid
sid<WA> Not PII

SIDで指定される特定のActivityに存在するWorkerでフィルタリングします。

attributes
文字列 PII MTL: 30 DAYS

このWorkerを記述するJSONオブジェクトです(例: { 'email: 'Bob@foo.com', 'phone': '8675309' })。 TaskRouterがこのWorkerにTaskを割り当てると、このデータが割り当てコールバックURLに渡されます。初期値は {} です。

available
boolean Not PII

Filter by workers that are available or unavailable. (Note: This can be 'true', '1' or 'yes' to indicate a true value. All other values will represent false)

dateCreated
date_time<iso8601> Not PII

このWorkerが生成された日時です。

dateStatusChanged
date_time<iso8601> Not PII

WorkerのActivityが最後に変更された日時です。 Workflow統計の計算に使用します。

dateUpdated
date_time<iso8601> Not PII

最後に更新された日時です。

friendlyName
文字列 PII MTL: 30 DAYS

Filter by a worker's friendly name

sid
sid<WK> Not PII

Workerの一意なIDです。

workspaceSid
sid<WS> Not PII

このWorkerが関連付けられているWorkflowのIDです。

url
url Not PII

links
uri_map Not PII

Create a Worker resource

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

ユーザーにわかりやすいWorkerの名前を表す文字列です。

activity_sid
オプション
post sid<WA> Not PII

Workerの初期状態を表す有効なActivityです。 詳細については、Activityをご覧ください。 指定されない場合、新しいWorkerは、Workspaceで構成されている DefaultActivitySid を使用します。

attributes
オプション
post 文字列 PII MTL: 30 DAYS

このWorkerを記述するJSONオブジェクトです(例: { 'email: 'Bob@foo.com', 'phone': '8675309' })。 TaskRouterがこのWorkerにTaskを割り当てると、このデータが割り当てコールバックURLに渡されます。初期値は {} です。

        
        
        
        

        Fetch a Worker resource

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

              Read multiple Worker resources

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

              By default, this will return the first 50 Workers. Supply a PageSize parameter to fetch more than 50 Workers. See pagination information for more information.

              パラメーター
              Names in None format
              activity_name
              オプション
              GET 文字列 Not PII

              フレンドリー名で指定される特定のActivityに存在するWorkerでフィルタリングします。

              activity_sid
              オプション
              GET sid<WA> Not PII

              SIDで指定される特定のActivityに存在するWorkerでフィルタリングします。

              available
              オプション
              GET 文字列 Not PII

              Filter by workers that are available or unavailable. (Note: This can be 'true', '1' or 'yes' to indicate a true value. All other values will represent false)

              friendly_name
              オプション
              GET 文字列 PII MTL: 30 DAYS

              Filter by a worker's friendly name

              target_workers_expression
              オプション
              GET 文字列 Not PII

              TaskQueueのExpressionに一致するWorkerでフィルタリングします。 これは、使用する可能性があるQueueに一致するWorkerをデバッグする場合に役立ちます。

              task_queue_name
              オプション
              GET 文字列 Not PII

              分かりやすい名前 (friendly name) で指定されるTaskQueueを処理する資格を持つWorkerでフィルタリングします。

              task_queue_sid
              オプション
              GET sid<WQ> Not PII

              SIDで指定されるTaskQueueを処理する資格を持つWorkerでフィルタリングします。

              例 1
                    
                    
                    
                    
                    例 2
                          
                          
                          
                          

                          You can use the TargetWorkersExpression parameter to see which workers are eligible for a queue, or to understand why a certain queue isn't mapping to the workers you would expect.

                          This example checks which workers have a name attribute of Alice, Bob, Connie or David - and, by extension, if we had a queue that mapped to workers with those names, we can be confident that these workers would be associated with the queue.

                          Update a Worker resource

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

                          Workerの現在のActivityの更新は、どのTaskRouterアプリケーションでも共通の操作です。 この操作を実行するには、TaskRouterの Worker.jsライブラリまたはこのREST APIを使用します。

                                
                                
                                
                                

                                Delete a Worker resource

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

                                      If you wish to view Reservations for a particular worker, use the Worker Reservation Resource.

                                      Rate this page:

                                      ヘルプが必要ですか?

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