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

     1  # \PresenceApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**AccountPresence**](PresenceApi.md#AccountPresence) | **Get** /restapi/v1.0/account/{accountId}/presence | Get all user statuses
     8  [**GetMonitoringExtensions**](PresenceApi.md#GetMonitoringExtensions) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission | Get User Presence Permissions
     9  [**GetPresenceLine**](PresenceApi.md#GetPresenceLine) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/{lineId} | Get Monitored Extensions by Id
    10  [**GetPresenceStatus**](PresenceApi.md#GetPresenceStatus) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence | Get User Status
    11  [**ListMonitoredExtensions**](PresenceApi.md#ListMonitoredExtensions) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line | Get Monitored Extensions
    12  [**PutMonitoringExtensions**](PresenceApi.md#PutMonitoringExtensions) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission | Update User Presence Permissions
    13  [**UpdatePresenceLines**](PresenceApi.md#UpdatePresenceLines) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line | Update Monitored Extensions
    14  [**UpdatePresenceStatus**](PresenceApi.md#UpdatePresenceStatus) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence | Update User Status
    15  
    16  
    17  # **AccountPresence**
    18  > AccountPresenceInfo AccountPresence(ctx, accountId)
    19  Get all user statuses
    20  
    21  ### Required Parameters
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26    **accountId** | **string**|  | 
    27  
    28  ### Return type
    29  
    30  [**AccountPresenceInfo**](AccountPresenceInfo.md)
    31  
    32  ### Authorization
    33  
    34  [OAuth2](../README.md#OAuth2)
    35  
    36  ### HTTP request headers
    37  
    38   - **Content-Type**: Not defined
    39   - **Accept**: application/json
    40  
    41  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    42  
    43  # **GetMonitoringExtensions**
    44  > MonitoringExtensionsResource GetMonitoringExtensions(ctx, extensionId, accountId)
    45  Get User Presence Permissions
    46  
    47  ### Required Parameters
    48  
    49  Name | Type | Description  | Notes
    50  ------------- | ------------- | ------------- | -------------
    51   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    52    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
    53    **accountId** | **string**|  | 
    54  
    55  ### Return type
    56  
    57  [**MonitoringExtensionsResource**](MonitoringExtensionsResource.md)
    58  
    59  ### Authorization
    60  
    61  [OAuth2](../README.md#OAuth2)
    62  
    63  ### HTTP request headers
    64  
    65   - **Content-Type**: Not defined
    66   - **Accept**: application/json
    67  
    68  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    69  
    70  # **GetPresenceLine**
    71  > PresenceLineResource GetPresenceLine(ctx, lineId, extensionId, accountId)
    72  Get Monitored Extensions by Id
    73  
    74  ### Required Parameters
    75  
    76  Name | Type | Description  | Notes
    77  ------------- | ------------- | ------------- | -------------
    78   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    79    **lineId** | **string**|  | 
    80    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
    81    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
    82  
    83  ### Return type
    84  
    85  [**PresenceLineResource**](PresenceLineResource.md)
    86  
    87  ### Authorization
    88  
    89  [OAuth2](../README.md#OAuth2)
    90  
    91  ### HTTP request headers
    92  
    93   - **Content-Type**: Not defined
    94   - **Accept**: application/json
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    97  
    98  # **GetPresenceStatus**
    99  > GetPresenceInfo GetPresenceStatus(ctx, accountId, extensionId)
   100  Get User Status
   101  
   102  <p style='font-style:italic;'>Since 1.0.2</p><p>Returns presence status of an extension or several extensions by their ID(s). Batch request is supported, see Batch Requests for details.The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off.Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadPresence</td><td>Getting user presence information</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>
   103  
   104  ### Required Parameters
   105  
   106  Name | Type | Description  | Notes
   107  ------------- | ------------- | ------------- | -------------
   108   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   109    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
   110    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
   111  
   112  ### Return type
   113  
   114  [**GetPresenceInfo**](GetPresenceInfo.md)
   115  
   116  ### Authorization
   117  
   118  [OAuth2](../README.md#OAuth2)
   119  
   120  ### HTTP request headers
   121  
   122   - **Content-Type**: Not defined
   123   - **Accept**: application/json
   124  
   125  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   126  
   127  # **ListMonitoredExtensions**
   128  > GetMonitoredExtensionsResponse ListMonitoredExtensions(ctx, accountId, extensionId)
   129  Get Monitored Extensions
   130  
   131  <p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns list of lines - extensions which presence status can be indicated and monitored on BLF-enabled (Busy Lamp Field) devices.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadPresence</td><td>Getting user presence information</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>
   132  
   133  ### Required Parameters
   134  
   135  Name | Type | Description  | Notes
   136  ------------- | ------------- | ------------- | -------------
   137   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   138    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
   139    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
   140  
   141  ### Return type
   142  
   143  [**GetMonitoredExtensionsResponse**](GetMonitoredExtensionsResponse.md)
   144  
   145  ### Authorization
   146  
   147  [OAuth2](../README.md#OAuth2)
   148  
   149  ### HTTP request headers
   150  
   151   - **Content-Type**: Not defined
   152   - **Accept**: application/json
   153  
   154  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   155  
   156  # **PutMonitoringExtensions**
   157  > MonitoringExtensionsResource PutMonitoringExtensions(ctx, extensionId, accountId, userPresencePermissionsUpdateRequest)
   158  Update User Presence Permissions
   159  
   160  ### Required Parameters
   161  
   162  Name | Type | Description  | Notes
   163  ------------- | ------------- | ------------- | -------------
   164   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   165    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
   166    **accountId** | **string**|  | 
   167    **userPresencePermissionsUpdateRequest** | [**UserPresencePermissionsUpdateRequest**](UserPresencePermissionsUpdateRequest.md)|  | 
   168  
   169  ### Return type
   170  
   171  [**MonitoringExtensionsResource**](MonitoringExtensionsResource.md)
   172  
   173  ### Authorization
   174  
   175  [OAuth2](../README.md#OAuth2)
   176  
   177  ### HTTP request headers
   178  
   179   - **Content-Type**: application/json
   180   - **Accept**: application/json
   181  
   182  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   183  
   184  # **UpdatePresenceLines**
   185  > UpdatePresenceLinesResponse UpdatePresenceLines(ctx, accountId, extensionId, updatePresenceLinesRequest)
   186  Update Monitored Extensions
   187  
   188  ### Required Parameters
   189  
   190  Name | Type | Description  | Notes
   191  ------------- | ------------- | ------------- | -------------
   192   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   193    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
   194    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
   195    **updatePresenceLinesRequest** | [**UpdatePresenceLinesRequest**](UpdatePresenceLinesRequest.md)|  | 
   196  
   197  ### Return type
   198  
   199  [**UpdatePresenceLinesResponse**](UpdatePresenceLinesResponse.md)
   200  
   201  ### Authorization
   202  
   203  [OAuth2](../README.md#OAuth2)
   204  
   205  ### HTTP request headers
   206  
   207   - **Content-Type**: application/json
   208   - **Accept**: application/json
   209  
   210  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   211  
   212  # **UpdatePresenceStatus**
   213  > PresenceInfoResource UpdatePresenceStatus(ctx, accountId, extensionId, presenceInfoResource)
   214  Update User Status
   215  
   216  ### Required Parameters
   217  
   218  Name | Type | Description  | Notes
   219  ------------- | ------------- | ------------- | -------------
   220   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   221    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
   222    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
   223    **presenceInfoResource** | [**PresenceInfoResource**](PresenceInfoResource.md)|  | 
   224  
   225  ### Return type
   226  
   227  [**PresenceInfoResource**](PresenceInfoResource.md)
   228  
   229  ### Authorization
   230  
   231  [OAuth2](../README.md#OAuth2)
   232  
   233  ### HTTP request headers
   234  
   235   - **Content-Type**: multipart/mixed, application/json
   236   - **Accept**: multipart/mixed, application/json
   237  
   238  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   239