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

     1  # \DialGroupsApi
     2  
     3  All URIs are relative to *https://portal.vacd.biz/api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ClearCampaignCache**](DialGroupsApi.md#ClearCampaignCache) | **Post** /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache | Clear Campaign Cache
     8  [**GetCampaigns**](DialGroupsApi.md#GetCampaigns) | **Get** /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns | Get Campaigns
     9  [**GetDialGroups**](DialGroupsApi.md#GetDialGroups) | **Get** /admin/accounts/{accountId}/dialGroups | Get Dial Groups
    10  
    11  
    12  
    13  ## ClearCampaignCache
    14  
    15  > ClearCampaignCache(ctx, accountId, dialGroupId, campaignId, body)
    16  Clear Campaign Cache
    17  
    18  lears the cache for a campaign  Permissions: READ on Campaign (Permission Override)
    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  **accountId** | **int64**|  | 
    27  **dialGroupId** | **int64**|  | 
    28  **campaignId** | **int64**|  | 
    29  **body** | **map[string]interface{}**| An `application/json` Content-Type header is required. Submit an empty body to trigger the header. | 
    30  
    31  ### Return type
    32  
    33   (empty response body)
    34  
    35  ### Authorization
    36  
    37  [ApiKeyAuth](../README.md#ApiKeyAuth)
    38  
    39  ### HTTP request headers
    40  
    41  - **Content-Type**: application/json
    42  - **Accept**: Not defined
    43  
    44  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    45  [[Back to Model list]](../README.md#documentation-for-models)
    46  [[Back to README]](../README.md)
    47  
    48  
    49  ## GetCampaigns
    50  
    51  > []Campaign GetCampaigns(ctx, accountId, dialGroupId)
    52  Get Campaigns
    53  
    54  Returns a listing of campaigns for a dial group
    55  
    56  ### Required Parameters
    57  
    58  
    59  Name | Type | Description  | Notes
    60  ------------- | ------------- | ------------- | -------------
    61  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    62  **accountId** | **string**|  | 
    63  **dialGroupId** | **string**|  | 
    64  
    65  ### Return type
    66  
    67  [**[]Campaign**](Campaign.md)
    68  
    69  ### Authorization
    70  
    71  [ApiKeyAuth](../README.md#ApiKeyAuth)
    72  
    73  ### HTTP request headers
    74  
    75  - **Content-Type**: Not defined
    76  - **Accept**: application/json
    77  
    78  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    79  [[Back to Model list]](../README.md#documentation-for-models)
    80  [[Back to README]](../README.md)
    81  
    82  
    83  ## GetDialGroups
    84  
    85  > []DialGroup GetDialGroups(ctx, accountId)
    86  Get Dial Groups
    87  
    88  Returns a listing of dial groups for an account
    89  
    90  ### Required Parameters
    91  
    92  
    93  Name | Type | Description  | Notes
    94  ------------- | ------------- | ------------- | -------------
    95  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    96  **accountId** | **string**|  | 
    97  
    98  ### Return type
    99  
   100  [**[]DialGroup**](DialGroup.md)
   101  
   102  ### Authorization
   103  
   104  [ApiKeyAuth](../README.md#ApiKeyAuth)
   105  
   106  ### HTTP request headers
   107  
   108  - **Content-Type**: Not defined
   109  - **Accept**: application/json
   110  
   111  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   112  [[Back to Model list]](../README.md#documentation-for-models)
   113  [[Back to README]](../README.md)
   114