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

     1  # \AgentsApi
     2  
     3  All URIs are relative to *https://portal.vacd.biz/api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAgentGroups**](AgentsApi.md#GetAgentGroups) | **Get** /admin/accounts/{accountId}/agentGroups | Get Agent Groups
     8  [**GetAgents**](AgentsApi.md#GetAgents) | **Get** /admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents | Get Group Agents
     9  
    10  
    11  
    12  ## GetAgentGroups
    13  
    14  > []AgentGroup GetAgentGroups(ctx, accountId)
    15  Get Agent Groups
    16  
    17  Returns a listing of agent groups for an account
    18  
    19  ### Required Parameters
    20  
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25  **accountId** | **string**|  | 
    26  
    27  ### Return type
    28  
    29  [**[]AgentGroup**](AgentGroup.md)
    30  
    31  ### Authorization
    32  
    33  [ApiKeyAuth](../README.md#ApiKeyAuth)
    34  
    35  ### HTTP request headers
    36  
    37  - **Content-Type**: Not defined
    38  - **Accept**: application/json
    39  
    40  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    41  [[Back to Model list]](../README.md#documentation-for-models)
    42  [[Back to README]](../README.md)
    43  
    44  
    45  ## GetAgents
    46  
    47  > []Agent GetAgents(ctx, accountId, agentGroupId)
    48  Get Group Agents
    49  
    50  Returns a listing of agents for an agent group
    51  
    52  ### Required Parameters
    53  
    54  
    55  Name | Type | Description  | Notes
    56  ------------- | ------------- | ------------- | -------------
    57  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    58  **accountId** | **string**|  | 
    59  **agentGroupId** | **string**|  | 
    60  
    61  ### Return type
    62  
    63  [**[]Agent**](Agent.md)
    64  
    65  ### Authorization
    66  
    67  [ApiKeyAuth](../README.md#ApiKeyAuth)
    68  
    69  ### HTTP request headers
    70  
    71  - **Content-Type**: Not defined
    72  - **Accept**: application/json
    73  
    74  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    75  [[Back to Model list]](../README.md#documentation-for-models)
    76  [[Back to README]](../README.md)
    77