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

     1  # WorkspacesTaskQueuesApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateTaskQueue**](WorkspacesTaskQueuesApi.md#CreateTaskQueue) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskQueues | 
     8  [**DeleteTaskQueue**](WorkspacesTaskQueuesApi.md#DeleteTaskQueue) | **Delete** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | 
     9  [**FetchTaskQueue**](WorkspacesTaskQueuesApi.md#FetchTaskQueue) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | 
    10  [**ListTaskQueue**](WorkspacesTaskQueuesApi.md#ListTaskQueue) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues | 
    11  [**UpdateTaskQueue**](WorkspacesTaskQueuesApi.md#UpdateTaskQueue) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | 
    12  
    13  
    14  
    15  ## CreateTaskQueue
    16  
    17  > TaskrouterV1TaskQueue CreateTaskQueue(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 TaskQueue belongs to.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateTaskQueueParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **FriendlyName** | **string** | A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
    39  **TargetWorkers** | **string** | A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, `'\\\"language\\\" == \\\"spanish\\\"'`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see [Describing Worker selection criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).
    40  **MaxReservedWorkers** | **int** | The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.
    41  **TaskOrder** | **string** | 
    42  **ReservationActivitySid** | **string** | The SID of the Activity to assign Workers when a task is reserved for them.
    43  **AssignmentActivitySid** | **string** | The SID of the Activity to assign Workers when a task is assigned to them.
    44  
    45  ### Return type
    46  
    47  [**TaskrouterV1TaskQueue**](TaskrouterV1TaskQueue.md)
    48  
    49  ### Authorization
    50  
    51  [accountSid_authToken](../README.md#accountSid_authToken)
    52  
    53  ### HTTP request headers
    54  
    55  - **Content-Type**: application/x-www-form-urlencoded
    56  - **Accept**: application/json
    57  
    58  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    59  [[Back to Model list]](../README.md#documentation-for-models)
    60  [[Back to README]](../README.md)
    61  
    62  
    63  ## DeleteTaskQueue
    64  
    65  > DeleteTaskQueue(ctx, WorkspaceSidSid)
    66  
    67  
    68  
    69  
    70  
    71  ### Path Parameters
    72  
    73  
    74  Name | Type | Description
    75  ------------- | ------------- | -------------
    76  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    77  **WorkspaceSid** | **string** | The SID of the Workspace with the TaskQueue to delete.
    78  **Sid** | **string** | The SID of the TaskQueue resource to delete.
    79  
    80  ### Other Parameters
    81  
    82  Other parameters are passed through a pointer to a DeleteTaskQueueParams struct
    83  
    84  
    85  Name | Type | Description
    86  ------------- | ------------- | -------------
    87  
    88  ### Return type
    89  
    90   (empty response body)
    91  
    92  ### Authorization
    93  
    94  [accountSid_authToken](../README.md#accountSid_authToken)
    95  
    96  ### HTTP request headers
    97  
    98  - **Content-Type**: Not defined
    99  - **Accept**: Not defined
   100  
   101  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   102  [[Back to Model list]](../README.md#documentation-for-models)
   103  [[Back to README]](../README.md)
   104  
   105  
   106  ## FetchTaskQueue
   107  
   108  > TaskrouterV1TaskQueue FetchTaskQueue(ctx, WorkspaceSidSid)
   109  
   110  
   111  
   112  
   113  
   114  ### Path Parameters
   115  
   116  
   117  Name | Type | Description
   118  ------------- | ------------- | -------------
   119  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   120  **WorkspaceSid** | **string** | The SID of the Workspace with the TaskQueue to fetch.
   121  **Sid** | **string** | The SID of the TaskQueue resource to fetch.
   122  
   123  ### Other Parameters
   124  
   125  Other parameters are passed through a pointer to a FetchTaskQueueParams struct
   126  
   127  
   128  Name | Type | Description
   129  ------------- | ------------- | -------------
   130  
   131  ### Return type
   132  
   133  [**TaskrouterV1TaskQueue**](TaskrouterV1TaskQueue.md)
   134  
   135  ### Authorization
   136  
   137  [accountSid_authToken](../README.md#accountSid_authToken)
   138  
   139  ### HTTP request headers
   140  
   141  - **Content-Type**: Not defined
   142  - **Accept**: application/json
   143  
   144  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   145  [[Back to Model list]](../README.md#documentation-for-models)
   146  [[Back to README]](../README.md)
   147  
   148  
   149  ## ListTaskQueue
   150  
   151  > []TaskrouterV1TaskQueue ListTaskQueue(ctx, WorkspaceSidoptional)
   152  
   153  
   154  
   155  
   156  
   157  ### Path Parameters
   158  
   159  
   160  Name | Type | Description
   161  ------------- | ------------- | -------------
   162  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   163  **WorkspaceSid** | **string** | The SID of the Workspace with the TaskQueue to read.
   164  
   165  ### Other Parameters
   166  
   167  Other parameters are passed through a pointer to a ListTaskQueueParams struct
   168  
   169  
   170  Name | Type | Description
   171  ------------- | ------------- | -------------
   172  **FriendlyName** | **string** | The `friendly_name` of the TaskQueue resources to read.
   173  **EvaluateWorkerAttributes** | **string** | The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.
   174  **WorkerSid** | **string** | The SID of the Worker with the TaskQueue resources to read.
   175  **Ordering** | **string** | Sorting parameter for TaskQueues
   176  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   177  **Limit** | **int** | Max number of records to return.
   178  
   179  ### Return type
   180  
   181  [**[]TaskrouterV1TaskQueue**](TaskrouterV1TaskQueue.md)
   182  
   183  ### Authorization
   184  
   185  [accountSid_authToken](../README.md#accountSid_authToken)
   186  
   187  ### HTTP request headers
   188  
   189  - **Content-Type**: Not defined
   190  - **Accept**: application/json
   191  
   192  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   193  [[Back to Model list]](../README.md#documentation-for-models)
   194  [[Back to README]](../README.md)
   195  
   196  
   197  ## UpdateTaskQueue
   198  
   199  > TaskrouterV1TaskQueue UpdateTaskQueue(ctx, WorkspaceSidSidoptional)
   200  
   201  
   202  
   203  
   204  
   205  ### Path Parameters
   206  
   207  
   208  Name | Type | Description
   209  ------------- | ------------- | -------------
   210  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   211  **WorkspaceSid** | **string** | The SID of the Workspace with the TaskQueue to update.
   212  **Sid** | **string** | The SID of the TaskQueue resource to update.
   213  
   214  ### Other Parameters
   215  
   216  Other parameters are passed through a pointer to a UpdateTaskQueueParams struct
   217  
   218  
   219  Name | Type | Description
   220  ------------- | ------------- | -------------
   221  **FriendlyName** | **string** | A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
   222  **TargetWorkers** | **string** | A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example '\\\"language\\\" == \\\"spanish\\\"' If no TargetWorkers parameter is provided, Tasks will wait in the queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below.
   223  **ReservationActivitySid** | **string** | The SID of the Activity to assign Workers when a task is reserved for them.
   224  **AssignmentActivitySid** | **string** | The SID of the Activity to assign Workers when a task is assigned for them.
   225  **MaxReservedWorkers** | **int** | The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50.
   226  **TaskOrder** | **string** | 
   227  
   228  ### Return type
   229  
   230  [**TaskrouterV1TaskQueue**](TaskrouterV1TaskQueue.md)
   231  
   232  ### Authorization
   233  
   234  [accountSid_authToken](../README.md#accountSid_authToken)
   235  
   236  ### HTTP request headers
   237  
   238  - **Content-Type**: application/x-www-form-urlencoded
   239  - **Accept**: application/json
   240  
   241  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   242  [[Back to Model list]](../README.md#documentation-for-models)
   243  [[Back to README]](../README.md)
   244