Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the WorkerChannels to read.

• WorkerSid string Required

  The SID of the Worker with the WorkerChannels to read.

Query parameters

• PageSize integer

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • channels array[object]
    Hide channels attributes Show channels attributes array[object]

    • account_sid string | null

      The SID of the Account that created the resource

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

    • assigned_tasks integer | null

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

    • available boolean | null

      Whether the Worker should receive Tasks of the TaskChannel type

    • available_capacity_percentage integer | null

      The current available capacity between 0 to 100 for the TaskChannel

    • configured_capacity integer | null

      The current configured capacity for the WorkerChannel

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • sid string | null

      The unique string that identifies the 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'

    • url string(uri) | null

      The absolute URL of the WorkerChannel resource

    • 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}$.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)