github.com/twilio/twilio-go@v1.20.1/rest/taskrouter/v1/docs/WorkspacesWorkersChannelsApi.md (about)

     1  # WorkspacesWorkersChannelsApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchWorkerChannel**](WorkspacesWorkersChannelsApi.md#FetchWorkerChannel) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid} | 
     8  [**ListWorkerChannel**](WorkspacesWorkersChannelsApi.md#ListWorkerChannel) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels | 
     9  [**UpdateWorkerChannel**](WorkspacesWorkersChannelsApi.md#UpdateWorkerChannel) | **Post** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid} | 
    10  
    11  
    12  
    13  ## FetchWorkerChannel
    14  
    15  > TaskrouterV1WorkerChannel FetchWorkerChannel(ctx, WorkspaceSidWorkerSidSid)
    16  
    17  
    18  
    19  
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerChannel to fetch.
    28  **WorkerSid** | **string** | The SID of the Worker with the WorkerChannel to fetch.
    29  **Sid** | **string** | The SID of the WorkerChannel to fetch.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a FetchWorkerChannelParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  
    39  ### Return type
    40  
    41  [**TaskrouterV1WorkerChannel**](TaskrouterV1WorkerChannel.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: Not defined
    50  - **Accept**: application/json
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## ListWorkerChannel
    58  
    59  > []TaskrouterV1WorkerChannel ListWorkerChannel(ctx, WorkspaceSidWorkerSidoptional)
    60  
    61  
    62  
    63  
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerChannels to read.
    72  **WorkerSid** | **string** | The SID of the Worker with the WorkerChannels to read.
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a ListWorkerChannelParams struct
    77  
    78  
    79  Name | Type | Description
    80  ------------- | ------------- | -------------
    81  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    82  **Limit** | **int** | Max number of records to return.
    83  
    84  ### Return type
    85  
    86  [**[]TaskrouterV1WorkerChannel**](TaskrouterV1WorkerChannel.md)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: application/json
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## UpdateWorkerChannel
   103  
   104  > TaskrouterV1WorkerChannel UpdateWorkerChannel(ctx, WorkspaceSidWorkerSidSidoptional)
   105  
   106  
   107  
   108  
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerChannel to update.
   117  **WorkerSid** | **string** | The SID of the Worker with the WorkerChannel to update.
   118  **Sid** | **string** | The SID of the WorkerChannel to update.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a UpdateWorkerChannelParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  **Capacity** | **int** | 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.
   128  **Available** | **bool** | Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.
   129  
   130  ### Return type
   131  
   132  [**TaskrouterV1WorkerChannel**](TaskrouterV1WorkerChannel.md)
   133  
   134  ### Authorization
   135  
   136  [accountSid_authToken](../README.md#accountSid_authToken)
   137  
   138  ### HTTP request headers
   139  
   140  - **Content-Type**: application/x-www-form-urlencoded
   141  - **Accept**: application/json
   142  
   143  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   144  [[Back to Model list]](../README.md#documentation-for-models)
   145  [[Back to README]](../README.md)
   146