Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the WorkerChannel to fetch.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

• WorkerSid string Required

  The SID of the Worker with the WorkerChannel to fetch.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WK[0-9a-fA-F]{32}$.

• Sid string Required

  The SID of the WorkerChannel to fetch.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • X-Rate-Limit-Limit string
  • X-Rate-Limit-Remaining string
  • X-Rate-Limit-Config string
  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • account_sid string | null

    The SID of the Account that created the Worker resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • assigned_tasks integer

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

    Default value is 0.

  • available boolean | null

    Whether the Worker should receive Tasks of the TaskChannel type.

  • available_capacity_percentage integer

    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.

    Default value is 0.

  • configured_capacity integer

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

    Default value is 0.

  • date_created string(date-time) | null

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

  • date_updated string(date-time) | null

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

  • sid string | null

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WC[0-9a-fA-F]{32}$.

  • task_channel_sid string | null

    The SID of the TaskChannel.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^TC[0-9a-fA-F]{32}$.

  • task_channel_unique_name string | null

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

  • worker_sid string | null

    The SID of the Worker that contains the WorkerChannel.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WK[0-9a-fA-F]{32}$.

  • workspace_sid string | null

    The SID of the Workspace that contains the WorkerChannel.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

  • url string(uri) | null

    The absolute URL of the WorkerChannel resource.