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

     1  # WorkspacesTaskChannelsApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateTaskChannel**](WorkspacesTaskChannelsApi.md#CreateTaskChannel) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskChannels | 
     8  [**DeleteTaskChannel**](WorkspacesTaskChannelsApi.md#DeleteTaskChannel) | **Delete** /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid} | 
     9  [**FetchTaskChannel**](WorkspacesTaskChannelsApi.md#FetchTaskChannel) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid} | 
    10  [**ListTaskChannel**](WorkspacesTaskChannelsApi.md#ListTaskChannel) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskChannels | 
    11  [**UpdateTaskChannel**](WorkspacesTaskChannelsApi.md#UpdateTaskChannel) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid} | 
    12  
    13  
    14  
    15  ## CreateTaskChannel
    16  
    17  > TaskrouterV1TaskChannel CreateTaskChannel(ctx, WorkspaceSidoptional)
    18  
    19  
    20  
    21  
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **WorkspaceSid** | **string** | The SID of the Workspace that the new Task Channel belongs to.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateTaskChannelParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **FriendlyName** | **string** | A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
    39  **UniqueName** | **string** | An application-defined string that uniquely identifies the Task Channel, such as `voice` or `sms`.
    40  **ChannelOptimizedRouting** | **bool** | Whether the Task Channel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
    41  
    42  ### Return type
    43  
    44  [**TaskrouterV1TaskChannel**](TaskrouterV1TaskChannel.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeleteTaskChannel
    61  
    62  > DeleteTaskChannel(ctx, WorkspaceSidSid)
    63  
    64  
    65  
    66  
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **WorkspaceSid** | **string** | The SID of the Workspace with the Task Channel to delete.
    75  **Sid** | **string** | The SID of the Task Channel resource to delete.
    76  
    77  ### Other Parameters
    78  
    79  Other parameters are passed through a pointer to a DeleteTaskChannelParams struct
    80  
    81  
    82  Name | Type | Description
    83  ------------- | ------------- | -------------
    84  
    85  ### Return type
    86  
    87   (empty response body)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: Not defined
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## FetchTaskChannel
   104  
   105  > TaskrouterV1TaskChannel FetchTaskChannel(ctx, WorkspaceSidSid)
   106  
   107  
   108  
   109  
   110  
   111  ### Path Parameters
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   117  **WorkspaceSid** | **string** | The SID of the Workspace with the Task Channel to fetch.
   118  **Sid** | **string** | The SID of the Task Channel resource to fetch.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchTaskChannelParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**TaskrouterV1TaskChannel**](TaskrouterV1TaskChannel.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListTaskChannel
   147  
   148  > []TaskrouterV1TaskChannel ListTaskChannel(ctx, WorkspaceSidoptional)
   149  
   150  
   151  
   152  
   153  
   154  ### Path Parameters
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160  **WorkspaceSid** | **string** | The SID of the Workspace with the Task Channel to read.
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListTaskChannelParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]TaskrouterV1TaskChannel**](TaskrouterV1TaskChannel.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188  
   189  
   190  ## UpdateTaskChannel
   191  
   192  > TaskrouterV1TaskChannel UpdateTaskChannel(ctx, WorkspaceSidSidoptional)
   193  
   194  
   195  
   196  
   197  
   198  ### Path Parameters
   199  
   200  
   201  Name | Type | Description
   202  ------------- | ------------- | -------------
   203  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   204  **WorkspaceSid** | **string** | The SID of the Workspace with the Task Channel to update.
   205  **Sid** | **string** | The SID of the Task Channel resource to update.
   206  
   207  ### Other Parameters
   208  
   209  Other parameters are passed through a pointer to a UpdateTaskChannelParams struct
   210  
   211  
   212  Name | Type | Description
   213  ------------- | ------------- | -------------
   214  **FriendlyName** | **string** | A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
   215  **ChannelOptimizedRouting** | **bool** | Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
   216  
   217  ### Return type
   218  
   219  [**TaskrouterV1TaskChannel**](TaskrouterV1TaskChannel.md)
   220  
   221  ### Authorization
   222  
   223  [accountSid_authToken](../README.md#accountSid_authToken)
   224  
   225  ### HTTP request headers
   226  
   227  - **Content-Type**: application/x-www-form-urlencoded
   228  - **Accept**: application/json
   229  
   230  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   231  [[Back to Model list]](../README.md#documentation-for-models)
   232  [[Back to README]](../README.md)
   233