メニュー

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 Channels

Workers Channelsは複数の同時進行するTaskをこなすためのWorkerのキャパシティーを表示します。 Workerは、あらかじめ構成済のTask Channelのキャパシティーに達するまで、各Taskのタイプごとに並列にTaskのReservationリクエストを受信します。 加えて、Worker Channelは利用不可に設定することも可能で、これはあるWorkerのキャパシティーを一時的に削除し、受付可能に再度戻したときに直前のキャパシティーに戻す場合に便利です。

アクション


全Worker Channelを一覧する

リソースURI

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

{WorksspaceSID}にて識別されるWorkspace内のTask Channelの一覧を返します。

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

        
        
        
        

        Retrieve a Worker Channel

        リソースURI

        GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{WorkerChannelUniqueName}
        GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{WorkerChannelSid}
        

        Returns a single Worker Channel resource identified by either {WorkerChannelUniqueName} or {WorkerChannelSid}

        Example of retrieving a single Worker Channel

              
              
              
              

              リソースのプロパティ

              フィールド 概要
              Sid The unique ID for this Worker Channel.
              AccountSid The unique ID of the Account that owns this Worker Channel.
              WorkspaceSid The unique ID of the Workspace that this Worker Channel belongs to.
              WorkerSid The unique ID of the Worker that this Worker Channel belongs to.
              TaskChannelSid TaskChannelの一意なIDです。
              TaskChannelUniqueName 'voice'、'sms' などといったTaskChannelの一意な名前です。
              ConfiguredCapacity The current configured capacity for the Worker Channel. TaskRouter will not create any reservations once assigned Tasks for the worker reaches the value configured here.
              available TaskChannelのタイプをWorkerが受信すべきかどうかを示すブール値です。 このTaskChannelタイプにおいてWorkerが通知の受信をストップするようにするには、この値をfalseに設定します。
              AssignedTasks このTaskChannelのタイプに対してWorkerに割り当てられたTaskの総数です。
              AvailableCapacityPercentage このTaskChannelに対して現在利用可能なキャパシティーを、0〜100の範囲内で表します。 値が100を返した場合は、このTaskChannelタイプのいかなるTaskもWorkerが受け入れ可能であることを表しています。
              DateCreated このActivityが作成された日付です。
              DateUpdated このActivityが更新された日付です。

              Update a Worker Channel

              リソースURI

              POST /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{WorkerChannelUniqueName}
              POST /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{WorkerChannelSid}
              

              Updates a Worker Channel instance identified by either {WorkerChannelUniqueName} or {WorkerChannelSid}

              'Voice'チャネルに対するキャパシティーを更新する例です。

                    
                    
                    
                    

                    POSTパラメーター

                    You may use the following parameters when modifying a Worker Channel.

                    フィールド 概要
                    Capacity The total number of Tasks worker should handle for this TaskChannel type. TaskRouter will only create reservations for Tasks of this TaskChannel type up to the capacity configured. If the capacity is 0, no new reservations will be created (🏢 not PII )
                    available Toggle the availability of the Worker Channel. Set this to 'False' to make worker unavailable to receive any new Tasks of this TaskChannel type. (🏢 not PII )
                    Rate this page:

                    ヘルプが必要ですか?

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