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

     1  # \ChannelsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllChannels**](ChannelsApi.md#GetAllChannels) | **Get** /channels | Getting all channels
     8  [**GetChannel**](ChannelsApi.md#GetChannel) | **Get** /channels/{channelId} | Getting a channel from its id
     9  [**UpdateChannel**](ChannelsApi.md#UpdateChannel) | **Put** /channels/{channelId} | Updating a channel
    10  
    11  
    12  
    13  ## GetAllChannels
    14  
    15  > GetAllChannelsResponse GetAllChannels(ctx, optional)
    16  Getting all channels
    17  
    18  This method renders all channels ordered by date of creation.
    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   **optional** | ***GetAllChannelsOpts** | optional parameters | nil if no parameters
    27  
    28  ### Optional Parameters
    29  
    30  Optional parameters are passed through a pointer to a GetAllChannelsOpts struct
    31  
    32  
    33  Name | Type | Description  | Notes
    34  ------------- | ------------- | ------------- | -------------
    35   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    36   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    37  
    38  ### Return type
    39  
    40  [**GetAllChannelsResponse**](GetAllChannelsResponse.md)
    41  
    42  ### Authorization
    43  
    44  No authorization required
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## GetChannel
    57  
    58  > Channel GetChannel(ctx, channelId)
    59  Getting a channel from its id
    60  
    61  This method renders a channel from given id.
    62  
    63  ### Required Parameters
    64  
    65  
    66  Name | Type | Description  | Notes
    67  ------------- | ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **channelId** | **string**|  | 
    70  
    71  ### Return type
    72  
    73  [**Channel**](Channel.md)
    74  
    75  ### Authorization
    76  
    77  No authorization required
    78  
    79  ### HTTP request headers
    80  
    81  - **Content-Type**: Not defined
    82  - **Accept**: application/json
    83  
    84  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    85  [[Back to Model list]](../README.md#documentation-for-models)
    86  [[Back to README]](../README.md)
    87  
    88  
    89  ## UpdateChannel
    90  
    91  > Channel UpdateChannel(ctx, channelId, optional)
    92  Updating a channel
    93  
    94  This method updates an existing channel from given attributes and renders it in case of success.  Authorization​: only users that are able to update channels.
    95  
    96  ### Required Parameters
    97  
    98  
    99  Name | Type | Description  | Notes
   100  ------------- | ------------- | ------------- | -------------
   101  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   102  **channelId** | **string**|  | 
   103   **optional** | ***UpdateChannelOpts** | optional parameters | nil if no parameters
   104  
   105  ### Optional Parameters
   106  
   107  Optional parameters are passed through a pointer to a UpdateChannelOpts struct
   108  
   109  
   110  Name | Type | Description  | Notes
   111  ------------- | ------------- | ------------- | -------------
   112  
   113   **name** | **optional.String**| The name of the channel. | 
   114   **sourceIds** | [**optional.Interface of []string**](string.md)| An array containing id of each source assigned to a channel (multiple). | 
   115   **softCapability** | **optional.Int32**| Number of tasks that can be assigned to agent by the routing before they are considered \"occupied\". | 
   116   **hardCapability** | **optional.Int32**| M​aximum number of tasks that can be assigned to agents. | 
   117   **taskTimeoutSeconds** | **optional.Int32**| this field defines the time before a task expires (in seconds). | 
   118  
   119  ### Return type
   120  
   121  [**Channel**](Channel.md)
   122  
   123  ### Authorization
   124  
   125  No authorization required
   126  
   127  ### HTTP request headers
   128  
   129  - **Content-Type**: Not defined
   130  - **Accept**: application/json
   131  
   132  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   133  [[Back to Model list]](../README.md#documentation-for-models)
   134  [[Back to README]](../README.md)
   135