メニュー

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: Worker Reservations

Worker Reservationsは、Workerの現在と過去のReservationを表します。 現在のReservationは、Reservationインスタンスリソースを使用して受諾できます。

アクション


Worker Reservationsを一覧する

リソースURI

GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations

{WorkerSid} で指定されるWorkerのReservationの一覧を返します。

        
        
        
        

        リストフィルター

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

        フィールド 概要
        ReservationStatus WorkerのReservationステータス(pending、accepted、rejected、timeout、canceled、rescinded)でフィルタリングします


        Worker Reservationを取得する

        リソースURI

        GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{ReservationSid}
        

        {WorkerSid} と {ReservationSid} で指定されるWorkerのReservationを返します。

              
              
              
              


              Reservationを更新する

              リソースURI

              POST /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{ReservationSid}
              

              Reservationを更新する

              WorkerがReservationを受諾または却下したことを示すために、ReservationインスタンスリソースURIにHTTP POSTリクエストを発行します。

              単純な受諾リクエストまたは拒否リクエストを送信できます。また、割り当てコールバックに応答するのと同じように、命令を発行することもできます。それぞれの方法で渡す必要があるパラメーターの詳細について、説明します。

              1. Reservationを承諾する
              2. Reservationを拒否する
              3. Dequeue命令を発行する
              4. 通話命令を発行する

              Reservationを承諾する

                    
                    
                    
                    

                    POSTパラメーター

                    フィールド 必須 概要
                    ReservationStatus はい accepted. Specifying accepted means the Worker has received the Task and will process it. TaskRouter will no longer consider this task eligible for assignment, and no other Worker will receive this Task. (🏢 not PII )

                    Reservationを拒否する

                          
                          
                          
                          

                          POSTパラメーター

                          フィールド 必須 概要
                          ReservationStatus はい rejected. Specifying rejected means the Worker has refused the assignment and TaskRouter will attempt to assign this Task to the next eligible Worker. (🏢 not PII )
                          WorkerActivitySid いいえ If rejecting a reservation, change the worker that is tied to this reservation to the supplied activity. If not provided, the WorkerPreviousActivitySid on the Reservation will be used. (🏢 not PII )

                          重要: Taskは、10回拒否されると、自動的にキャンセルされます。

                          詳細については、「手動でReservationを受諾または拒否する」を参照してください。

                          Dequeue命令

                                
                                
                                
                                

                                POSTパラメーター

                                フィールド 必須 概要
                                Instruction はい Dequeue (🏢 not PII )
                                DequeueFrom はい The caller ID for the call to the worker. Note: This needs to be a verified Twilio number. If you need this to be the original callee number, please contact Support (📇 PII )
                                DequeuePostWorkActivitySid いいえ The activity to move a worker to after executing a dequeue instruction. (🏢 not PII )

                                contact_uri プロパティは、通話先を示すために WorkerAttributes に必要です。詳細については、こちらをご覧ください。

                                詳細については、Dequeue命令を発行するをご覧ください。

                                通話命令

                                      
                                      
                                      
                                      

                                      POSTパラメーター

                                      フィールド 必須 概要
                                      Instruction はい Call (🏢 not PII )
                                      CallFrom はい The caller ID to use when placing the outbound call (📇 PII )
                                      CallUrl はい A valid TwiML URI that is executed on the answering Worker's leg. (🏢 not PII )
                                      CallStatusCallbackUrl いいえ A valid status callback url. (🏢 not PII )
                                      CallAccept いいえ If set to "true", the reservation will be accepted. Otherwise, a separate call to the REST API is responsible for moving the state to accept or reject. (🏢 not PII )

                                      contact_uri プロパティは、通話先を示すために WorkerAttributes に必要です。詳細については、こちらをご覧ください。

                                      詳細については、通話命令を発行するをご覧ください。

                                      Rate this page:

                                      ヘルプが必要ですか?

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