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

     1  # \AgentStatusApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ChangeAgentStatus**](AgentStatusApi.md#ChangeAgentStatus) | **Put** /status/{agentId} | Changing an agent's status
     8  [**GetAgentStatus**](AgentStatusApi.md#GetAgentStatus) | **Get** /status/{agentId} | Get a connected agent status
     9  [**GetAllAgentStatus**](AgentStatusApi.md#GetAllAgentStatus) | **Get** /status | Get all connected agents status
    10  
    11  
    12  
    13  ## ChangeAgentStatus
    14  
    15  > AgentStatus ChangeAgentStatus(ctx, agentId, optional)
    16  Changing an agent's status
    17  
    18  This method updates an agent's availability. Can be used to set either channels statuses OR custom  status. If both parameters are provided, ignores custom status.The status parameter​ **MUST** b​e either “away” or “available”.  Authorization​: only users that have the right to monitor the task view.
    19  
    20  ### Required Parameters
    21  
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **agentId** | **string**|  | 
    27   **optional** | ***ChangeAgentStatusOpts** | optional parameters | nil if no parameters
    28  
    29  ### Optional Parameters
    30  
    31  Optional parameters are passed through a pointer to a ChangeAgentStatusOpts struct
    32  
    33  
    34  Name | Type | Description  | Notes
    35  ------------- | ------------- | ------------- | -------------
    36  
    37   **status** | **optional.String**| A hash of channel_id => availability (must contain all channels). | 
    38   **customStatusId** | **optional.String**| id of presence status (optional) | 
    39  
    40  ### Return type
    41  
    42  [**AgentStatus**](AgentStatus.md)
    43  
    44  ### Authorization
    45  
    46  No authorization required
    47  
    48  ### HTTP request headers
    49  
    50  - **Content-Type**: Not defined
    51  - **Accept**: application/json
    52  
    53  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    54  [[Back to Model list]](../README.md#documentation-for-models)
    55  [[Back to README]](../README.md)
    56  
    57  
    58  ## GetAgentStatus
    59  
    60  > AgentStatus GetAgentStatus(ctx, agentId)
    61  Get a connected agent status
    62  
    63  This method get the status of a connected agent. Returns a 404 if the user does not exist (not_found) or if he’s not connected (disconnected).  Authorization​: only users that have the right to monitor the task view.
    64  
    65  ### Required Parameters
    66  
    67  
    68  Name | Type | Description  | Notes
    69  ------------- | ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **agentId** | **string**|  | 
    72  
    73  ### Return type
    74  
    75  [**AgentStatus**](AgentStatus.md)
    76  
    77  ### Authorization
    78  
    79  No authorization required
    80  
    81  ### HTTP request headers
    82  
    83  - **Content-Type**: Not defined
    84  - **Accept**: application/json
    85  
    86  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    87  [[Back to Model list]](../README.md#documentation-for-models)
    88  [[Back to README]](../README.md)
    89  
    90  
    91  ## GetAllAgentStatus
    92  
    93  > []AgentStatus GetAllAgentStatus(ctx, )
    94  Get all connected agents status
    95  
    96  This method get all currently connected agents & their status.  Authorization​: only users that have the right to monitor the task view.
    97  
    98  ### Required Parameters
    99  
   100  This endpoint does not need any parameter.
   101  
   102  ### Return type
   103  
   104  [**[]AgentStatus**](AgentStatus.md)
   105  
   106  ### Authorization
   107  
   108  No authorization required
   109  
   110  ### HTTP request headers
   111  
   112  - **Content-Type**: Not defined
   113  - **Accept**: application/json
   114  
   115  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   116  [[Back to Model list]](../README.md#documentation-for-models)
   117  [[Back to README]](../README.md)
   118