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?

Task Resource

A Task represents a single item of work waiting to be processed. Tasks can represent whatever type of work is important for your team. Twilio applications can create tasks from phone calls or SMS messages. Your CRM or ticketing system can generate tasks from emails or chat messages sent in by your customers. Your own applications can create custom tasks representing whatever unique work your users handle.

Task properties

Taskの属性

すべてのTaskに属性が存在し、それを使って、アプリケーションがTaskをルーティングし、割り当て時に適切なアクションを実行するために必要などんな種類のデータも渡すことができます。 属性はJSONデータで表されます。次に例を示します。

{ 
    "type": "call", 
    "contact": "+15558675309", 
    "customer-value": "gold", 
    "task-reason": "support", 
    "callSid": "CA42ed11..." 
}

Task Lifecycle

A Task does not have an explicit Lifecycle property, but it's an important concept for understanding how Tasks work. A Task's lifecycle is controlled by a Workflow, which will manage the Task's priority and find matching Workers to handle the Task. The Task State page and Workflows and Assignment page provide more detail on the Task lifecycle.

Names in PHP format
accountSid
sid<AC> Not PII

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

age
integer Not PII

このTaskが作成されてからの経過時間(秒)です。

assignmentStatus
enum:status Not PII

指定された AssignmentStatus を持つWorkspace内のすべてのTaskの一覧を返します。AssignmentStatus の許容値は pending、reserved、assigned、canceled、および completed です。

attributes
文字列 PII MTL: 30 DAYS

この作業の属性を表すユーザー定義 JSON 文字列です。

addons
文字列 Not PII

この属性で全てのインストール済みのAdd-onのデータが初期化されます。

dateCreated
date_time<iso8601> Not PII

このTaskが生成された日時です。ISO 8601フォーマットで指定します。

dateUpdated
date_time<iso8601> Not PII

このTaskが更新された日時です。 ISO 8601フォーマットで指定します。

priority
integer Not PII

指定された優先度を持つWorkspace内のすべてのTaskの一覧を取得します。

reason
文字列 Not PII

Taskが取り消された、または完了した理由です(該当する場合)

sid
sid<WT> Not PII

Taskの一意なIDです。

taskQueueSid
sid<WQ> Not PII

指定されたSidで識別されるTaskQueueで現在待機中のTaskの一覧を返します。

taskQueueFriendlyName
文字列 Not PII

taskChannelSid
sid<TC> Not PII

Task ChannelのIDです

taskChannelUniqueName
文字列 Not PII

Task Channelの一意な名前です

timeout
integer Not PII

Taskの有効期間(秒)です

workflowSid
sid<WW> Not PII

指定された Sid 値を持つWorkflowの制御下にあるTaskの一覧を返します。

workflowFriendlyName
文字列 Not PII

workspaceSid
sid<WS> Not PII

このTaskを保持するWorkspaceのIDです。

url
url Not PII

links
uri_map Not PII

Create a Task resource

post
https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks
パラメーター
Names in None format
timeout
オプション
post integer Not PII

Taskが生存を許可される時間を秒数で指定します。 (最大2週間) 既定値は24時間です。 タイムアウト時には、「Task TTL Exceeded (Taskの生存時間が超過) 」という説明付きで task.canceled Eventが発動します。

priority
オプション
post integer Not PII

Taskの優先度を上書きします。 指定されている場合、優先度が設定されているWorkflowターゲットに一致する場合を除いて、Taskは指定された優先度を使用します。指定されない場合、Taskは一致するWorkflowターゲットの優先度を使用します。

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

When MultiTasking is enabled specify the type of the task by passing either TaskChannel Unique Name or Task Channel Sid. Default value is "default"

workflow_sid
オプション
post sid<WW> Not PII

このTaskのルーティングを処理させるWorkflowの WorkflowSid です。 TaskをPOSTしたWorkspaceにWorkflowが1つしか定義されていない場合、このパラメーターはオプションであり、そのWorkflowが使用されます。

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

このTaskの属性を表すURLエンコードされたJSON文字列です。 TaskがWorkerに割り当てられると、このデータは、WorkflowのAssignmentCallbackURLに返されます。 例: { "task_type": "call", "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }

例 1
        
        
        
        

        The maximum amount of in-flight Tasks allowed for any given Workspace is 500,000. Please contact us if your use case will require more.

        Fetch a Task resource

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

              Read multiple Task resources

              GET
              https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks
              パラメーター
              Names in None format
              priority
              オプション
              GET integer Not PII

              指定された優先度を持つWorkspace内のすべてのTaskの一覧を取得します。

              assignment_status
              オプション
              GET string[] Not PII

              指定された AssignmentStatus を持つWorkspace内のすべてのTaskの一覧を返します。AssignmentStatus の許容値は pending、reserved、assigned、canceled、および completed です。

              workflow_sid
              オプション
              GET sid<WW> Not PII

              指定された Sid 値を持つWorkflowの制御下にあるTaskの一覧を返します。

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

              指定された FriendlyName 値を持つWorkflowの制御下にあるTaskの一覧を返します。

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

              指定されたSidで識別されるTaskQueueで現在待機中のTaskの一覧を返します。

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

              指定されたFriendlyNameで識別されるTaskQueueで現在待機中のTaskの一覧を返します。

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

              Task属性のExpressionを指定します。この属性にマッチングするTaskが返されます。

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

              このパラメーターを使用して、返されたTaskの並べ替えを制御します。 値はAttributeが Priority または DateCreated、そしてOrderが asc または desc となる Attribute:Order 形式で渡される必要があります。 たとえば、Priority:desc では優先度 (Priority) の降順で並べ替えられます。 Taskを優先度 (Priority) と作成日 (DateCreated) で並べ替えるには、Priority:desc,DateCreated:ascを渡します。 既定では、Taskは作成日 (DateCreated) の昇順で並べ替えられます。

              例 1
                    
                    
                    
                    
                    例 2
                          
                          
                          
                          
                          Fetches all Tasks which have a language attribute of "en" or "fr" and a "skill_rating" attribute with value greater than 5.1

                          List Tasks with Filters

                          Fetches all Tasks which have a language attribute of "en" or "fr" and a "skill_rating" attribute with value greater than 5.1

                          Tasks are deleted 5 minutes after either they are canceled or completed. You can still query events that occurred for a Task via the Events API.

                          EvaluateTaskAttributes で以下の演算子を使うことができます。

                          • 等号:===
                          • 不等号: !=
                          • より大きい: >
                          • より小さい: <
                          • 以上: >=
                          • 以下: <=
                          • カッコ(演算子の優先度を示す): ( )
                          • 角カッコ(リスト/配列を示す): [ ]
                          • HAS, >-。比較式の左辺のTask属性の値にExpressionの右辺の文字列が含まれるかどうか判断します。
                          • IN, <-。Expressionの左辺のTask属性の値が右辺のリストに * 含まれるかどうか判断します。
                          • AND - 左辺と右辺のサブExpressionが両方とも true の場合、true として解決されます。それ以外の場合は false として解決されます。
                          • OR - 左辺と右辺のサブExpressionの一方または両方とも true の場合、true として解決されます。それ以外の場合は false として解決されます。

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

                          Update a Task resource

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

                          このTaskのカスタム属性を表すユーザー定義JSONデータです。

                          assignment_status
                          オプション
                          post enum:status Not PII

                          保留中 (pending) または予約済 (reserved) のTaskは AssignmentStatus='canceled' をPOSTすることによって取り消すことができます。 AssignmentStatus='wrapping' をPOSTすると、Taskが「wrapup」状態に移行し、AssignmentStatus='completed' をPOSTすると、Taskは「completed」状態に移行します。

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

                          Taskが取消済 (canceled) または完了済 (completed) の場合のみ必要です。 Taskが取消、または完了した理由を記録し、5分後にTaskが削除されるよう、Queueに追加します。

                          priority
                          オプション
                          post integer Not PII

                          Taskの優先度を上書きします。 指定されている場合、優先度が設定されているWorkflowターゲットに一致する場合を除いて、Taskは指定された優先度を使用します。

                          例 1
                                
                                
                                
                                

                                When a pending Task's attributes are updated, the Task will be re-driven through the Workflow identified by the WorkflowSid associated with the task. Depending on the Workflow's filters, TaskRouter may move the Task into a different TaskQueue. The age of the Task will remain the same. If the Task is moved to a new TaskQueue, its TaskQueue position relative to other tasks will be determined by its age and priority, as usual.

                                Delete a Task resource

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

                                {TaskSid} で識別されるTaskを削除します。 削除されたTaskに関連づけられたすべての保留中のReservationについては、Taskの削除時に同様に削除されます。

                                      
                                      
                                      
                                      
                                      Rate this page:

                                      ヘルプが必要ですか?

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