メニュー

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 Channel Resource

Workers Channels shows the Worker’s capacity for handling multiple concurrent Tasks. Workers receive Task reservation requests in parallel for each task type until the configured Task Channel capacity is reached. In addition, Worker Channels can also be marked as unavailable, which is useful for temporarily removing the capacity for a given Worker Channel and then restoring to the previous capacity when marking available again.

WorkerChannel properties

Names in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Worker resource.

assigned_tasks
integer Not PII

The total number of Tasks assigned to Worker for the TaskChannel type.

available
boolean Not PII

Whether the Worker should receive Tasks of the TaskChannel type.

available_capacity_percentage
integer Not PII

The current percentage of capacity the TaskChannel has available. Can be a number between 0 and 100. A value of 0 indicates that TaskChannel has no capacity available and a value of 100 means the Worker is available to receive any Tasks of this TaskChannel type.

configured_capacity
integer Not PII

The current configured capacity for the WorkerChannel. TaskRouter will not create any reservations after the assigned Tasks for the Worker reaches the value.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

sid
sid<WC> Not PII

The unique string that we created to identify the WorkerChannel resource.

task_channel_sid
sid<TC> Not PII

The SID of the TaskChannel.

task_channel_unique_name
文字列 Not PII

The unique name of the TaskChannel, such as voice or sms.

worker_sid
sid<WK> Not PII

The SID of the Worker that contains the WorkerChannel.

workspace_sid
sid<WS> Not PII

The SID of the Workspace that contains the WorkerChannel.

url
url Not PII

The absolute URL of the WorkerChannel resource.

Fetch a WorkerChannel resource

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

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

パラメーター
Names in REST API format
workspace_sid
Path
GET sid<WS> Not PII

The SID of the Workspace with the WorkerChannel to fetch.

worker_sid
Path
GET sid<WK> Not PII

The SID of the Worker with the WorkerChannel to fetch.

sid
Path
GET sid_like<WC> Not PII

The SID of the WorkerChannel to fetch.

        
        
        
        

        Read multiple WorkerChannel resources

        GET
        https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels
        パラメーター
        Names in REST API format
        workspace_sid
        Path
        GET sid<WS> Not PII

        The SID of the Workspace with the WorkerChannels to read.

        worker_sid
        Path
        GET sid<WK> Not PII

        The SID of the Worker with the WorkerChannels to read.

              
              
              
              

              Update a WorkerChannel resource

              post
              https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}
              パラメーター
              Names in REST API format
              workspace_sid
              Path
              post sid<WS> Not PII

              The SID of the Workspace with the WorkerChannel to update.

              worker_sid
              Path
              post sid<WK> Not PII

              The SID of the Worker with the WorkerChannel to update.

              sid
              Path
              post sid_like<WC> Not PII

              The SID of the WorkerChannel to update.

              capacity
              オプション
              post integer Not PII

              The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.

              available
              オプション
              post boolean Not PII

              Whether the WorkerChannel is available. Set to false to prevent the Worker from receiving any new Tasks of this TaskChannel type.

                    
                    
                    
                    
                    Rate this page:

                    ヘルプが必要ですか?

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