github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/TasksApi.md (about)

     1  # \TasksApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllTasks**](TasksApi.md#GetAllTasks) | **Get** /tasks | Getting all tasks
     8  [**GetTask**](TasksApi.md#GetTask) | **Get** /tasks/{taskId} | Getting a task from its id
     9  [**MoveTask**](TasksApi.md#MoveTask) | **Delete** /tasks/{taskId}/move | Move a task to another queue
    10  [**TransferTask**](TasksApi.md#TransferTask) | **Put** /tasks/{taskId}/transfer | Transferring a task
    11  
    12  
    13  
    14  ## GetAllTasks
    15  
    16  > GetAllTasksResponse GetAllTasks(ctx, optional)
    17  Getting all tasks
    18  
    19  This method renders tasks ordered by priority (highest first) and then by creation date (latest first).  Authorization​: only users that can read tasks.
    20  
    21  ### Required Parameters
    22  
    23  
    24  Name | Type | Description  | Notes
    25  ------------- | ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27   **optional** | ***GetAllTasksOpts** | optional parameters | nil if no parameters
    28  
    29  ### Optional Parameters
    30  
    31  Optional parameters are passed through a pointer to a GetAllTasksOpts struct
    32  
    33  
    34  Name | Type | Description  | Notes
    35  ------------- | ------------- | ------------- | -------------
    36   **queue** | **optional.String**| To filter tasks on given queue name (filters on the “global” queue by default).The most commonly used queues are: “global” (contains every task pending assignation), “workbin_{agent_id}” (contains every tasks assigned to the {agent_id} agent, “history” (contains every processed tasks), and “undelivered” (contains every undelivered tasks). If queue is set to “workbins” all the tasks currently in a workbin will be returned. | 
    37   **channelId** | **optional.String**| To filter tasks on given channel id. | 
    38   **step** | **optional.String**| To filter tasks on the step they’re currently in. | 
    39   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    40   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    41  
    42  ### Return type
    43  
    44  [**GetAllTasksResponse**](GetAllTasksResponse.md)
    45  
    46  ### Authorization
    47  
    48  No authorization required
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: Not defined
    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  ## GetTask
    61  
    62  > Task GetTask(ctx, taskId)
    63  Getting a task from its id
    64  
    65  This method renders a task from given id.
    66  
    67  ### Required Parameters
    68  
    69  
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **taskId** | **string**|  | 
    74  
    75  ### Return type
    76  
    77  [**Task**](Task.md)
    78  
    79  ### Authorization
    80  
    81  No authorization required
    82  
    83  ### HTTP request headers
    84  
    85  - **Content-Type**: Not defined
    86  - **Accept**: application/json
    87  
    88  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    89  [[Back to Model list]](../README.md#documentation-for-models)
    90  [[Back to README]](../README.md)
    91  
    92  
    93  ## MoveTask
    94  
    95  > Task MoveTask(ctx, taskId, queue)
    96  Move a task to another queue
    97  
    98  This method changes a task queue and renders it in case of success. Only accepts “undelivered” and special queue defined in topology (e.g. triage).  Authorization​: only users that have the right to monitor the task view.
    99  
   100  ### Required Parameters
   101  
   102  
   103  Name | Type | Description  | Notes
   104  ------------- | ------------- | ------------- | -------------
   105  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   106  **taskId** | **string**|  | 
   107  **queue** | **string**| Name of the queue task has to be moved in. | 
   108  
   109  ### Return type
   110  
   111  [**Task**](Task.md)
   112  
   113  ### Authorization
   114  
   115  No authorization required
   116  
   117  ### HTTP request headers
   118  
   119  - **Content-Type**: Not defined
   120  - **Accept**: application/json
   121  
   122  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   123  [[Back to Model list]](../README.md#documentation-for-models)
   124  [[Back to README]](../README.md)
   125  
   126  
   127  ## TransferTask
   128  
   129  > Task TransferTask(ctx, taskId, optional)
   130  Transferring a task
   131  
   132  This method transfers an existing task and renders it in case of success.  Authorization​: only users that have the right to monitor the task view.
   133  
   134  ### Required Parameters
   135  
   136  
   137  Name | Type | Description  | Notes
   138  ------------- | ------------- | ------------- | -------------
   139  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   140  **taskId** | **string**|  | 
   141   **optional** | ***TransferTaskOpts** | optional parameters | nil if no parameters
   142  
   143  ### Optional Parameters
   144  
   145  Optional parameters are passed through a pointer to a TransferTaskOpts struct
   146  
   147  
   148  Name | Type | Description  | Notes
   149  ------------- | ------------- | ------------- | -------------
   150  
   151   **agentIds** | [**optional.Interface of []string**](string.md)| List of agents to transfer the task to (multiple). | 
   152   **bypass** | **optional.String**| Force the transfer to the first agent in agent_ids if set. When bypass is used, | 
   153   **categoryIds** | [**optional.Interface of []string**](string.md)| Filter agents receiving the task depending on their categories. | 
   154   **language** | **optional.String**| Filter agents receiving the task depending on their spoken languages. | 
   155   **teamIds** | [**optional.Interface of []string**](string.md)| Filter agents receiving the task depending on their teams. | 
   156   **comment** | **optional.String**| Add a comment to the task. | 
   157  
   158  ### Return type
   159  
   160  [**Task**](Task.md)
   161  
   162  ### Authorization
   163  
   164  No authorization required
   165  
   166  ### HTTP request headers
   167  
   168  - **Content-Type**: Not defined
   169  - **Accept**: application/json
   170  
   171  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   172  [[Back to Model list]](../README.md#documentation-for-models)
   173  [[Back to README]](../README.md)
   174