github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/ApplicationSettingsApi.md (about) 1 # \ApplicationSettingsApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateSipRegistration**](ApplicationSettingsApi.md#CreateSipRegistration) | **Post** /restapi/v1.0/client-info/sip-provision | Register SIP Device 8 [**DeleteCustomData**](ApplicationSettingsApi.md#DeleteCustomData) | **Delete** /restapi/v1.0/client-info/custom-data/{key} | Delete Custom Data 9 [**GetAttachment**](ApplicationSettingsApi.md#GetAttachment) | **Get** /restapi/v1.0/client-info/custom-data/{key}/content | Get Custom Data Attachment 10 [**GetCustomData**](ApplicationSettingsApi.md#GetCustomData) | **Get** /restapi/v1.0/client-info/custom-data/{key} | Get Custom Data 11 [**GetInProductMessage**](ApplicationSettingsApi.md#GetInProductMessage) | **Get** /restapi/v1.0/client-info/banners | Get In Product Message List 12 [**GetSpecialNumberRules**](ApplicationSettingsApi.md#GetSpecialNumberRules) | **Get** /restapi/v1.0/client-info/special-number-rule | Get Special Numbers Calling Limitation 13 [**LoadClientInfo**](ApplicationSettingsApi.md#LoadClientInfo) | **Get** /restapi/v1.0/client-info | Get App Settings 14 [**LoadPhoneData**](ApplicationSettingsApi.md#LoadPhoneData) | **Get** /restapi/v1.0/number-parser/phonedata.xml | Get Phonedata 15 [**UpdateCustomData**](ApplicationSettingsApi.md#UpdateCustomData) | **Put** /restapi/v1.0/client-info/custom-data/{key} | Create/Update Custom Data 16 17 18 # **CreateSipRegistration** 19 > CreateSipRegistrationResponse CreateSipRegistration(ctx, createSipRegistrationRequest) 20 Register SIP Device 21 22 <p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Creates SIP registration of a device/application (WebPhone, Mobile, softphone)</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>VoipCalling</td><td>Registering as VoIP device and making VoIP calls</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p> 23 24 ### Required Parameters 25 26 Name | Type | Description | Notes 27 ------------- | ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **createSipRegistrationRequest** | [**CreateSipRegistrationRequest**](CreateSipRegistrationRequest.md)| JSON body | 30 31 ### Return type 32 33 [**CreateSipRegistrationResponse**](CreateSipRegistrationResponse.md) 34 35 ### Authorization 36 37 [OAuth2](../README.md#OAuth2) 38 39 ### HTTP request headers 40 41 - **Content-Type**: application/json 42 - **Accept**: application/json 43 44 [[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) 45 46 # **DeleteCustomData** 47 > DeleteCustomData(ctx, key) 48 Delete Custom Data 49 50 <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Deletes custom data by its ID.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 51 52 ### Required Parameters 53 54 Name | Type | Description | Notes 55 ------------- | ------------- | ------------- | ------------- 56 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 57 **key** | **int32**| Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension | 58 59 ### Return type 60 61 (empty response body) 62 63 ### Authorization 64 65 [OAuth2](../README.md#OAuth2) 66 67 ### HTTP request headers 68 69 - **Content-Type**: Not defined 70 - **Accept**: Not defined 71 72 [[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) 73 74 # **GetAttachment** 75 > GetAttachment(ctx, key, optional) 76 Get Custom Data Attachment 77 78 <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Returns custom data attachment by ID.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 79 80 ### Required Parameters 81 82 Name | Type | Description | Notes 83 ------------- | ------------- | ------------- | ------------- 84 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 85 **key** | **string**| | 86 **optional** | ***GetAttachmentOpts** | optional parameters | nil if no parameters 87 88 ### Optional Parameters 89 Optional parameters are passed through a pointer to a GetAttachmentOpts struct 90 91 Name | Type | Description | Notes 92 ------------- | ------------- | ------------- | ------------- 93 94 **range_** | **optional.String**| | 95 96 ### Return type 97 98 (empty response body) 99 100 ### Authorization 101 102 [OAuth2](../README.md#OAuth2) 103 104 ### HTTP request headers 105 106 - **Content-Type**: Not defined 107 - **Accept**: Not defined 108 109 [[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) 110 111 # **GetCustomData** 112 > CustomDataResource GetCustomData(ctx, key) 113 Get Custom Data 114 115 <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Returns custom data of a logged-in extension.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 116 117 ### Required Parameters 118 119 Name | Type | Description | Notes 120 ------------- | ------------- | ------------- | ------------- 121 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 122 **key** | **int32**| Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension | 123 124 ### Return type 125 126 [**CustomDataResource**](CustomDataResource.md) 127 128 ### Authorization 129 130 [OAuth2](../README.md#OAuth2) 131 132 ### HTTP request headers 133 134 - **Content-Type**: Not defined 135 - **Accept**: application/json 136 137 [[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) 138 139 # **GetInProductMessage** 140 > InProductMessages GetInProductMessage(ctx, bannerType) 141 Get In Product Message List 142 143 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns list of in-product messages: learderboards, announcements, etc. Please note: Banners are set on Marketing/Messages tab in Admin Web.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 144 145 ### Required Parameters 146 147 Name | Type | Description | Notes 148 ------------- | ------------- | ------------- | ------------- 149 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 150 **bannerType** | **string**| | [default to LeaderBoard] 151 152 ### Return type 153 154 [**InProductMessages**](InProductMessages.md) 155 156 ### Authorization 157 158 [OAuth2](../README.md#OAuth2) 159 160 ### HTTP request headers 161 162 - **Content-Type**: Not defined 163 - **Accept**: application/json 164 165 [[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) 166 167 # **GetSpecialNumberRules** 168 > NavigationInfo GetSpecialNumberRules(ctx, optional) 169 Get Special Numbers Calling Limitation 170 171 <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns available special numbers and rules of processing, depending on account brand and application type (mobile/softphone/web/other). A special number rule for each number includes limitations on the options: VoIP, RingOut, outgoing SMS and Fax. If the option is disallowed, the server returns the reason code and text description.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 172 173 ### Required Parameters 174 175 Name | Type | Description | Notes 176 ------------- | ------------- | ------------- | ------------- 177 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 178 **optional** | ***GetSpecialNumberRulesOpts** | optional parameters | nil if no parameters 179 180 ### Optional Parameters 181 Optional parameters are passed through a pointer to a GetSpecialNumberRulesOpts struct 182 183 Name | Type | Description | Notes 184 ------------- | ------------- | ------------- | ------------- 185 **countryId** | **optional.Int32**| Internal identifier of a country. If not specified, the response is returned for the brand country | 186 187 ### Return type 188 189 [**NavigationInfo**](NavigationInfo.md) 190 191 ### Authorization 192 193 [OAuth2](../README.md#OAuth2) 194 195 ### HTTP request headers 196 197 - **Content-Type**: Not defined 198 - **Accept**: application/json 199 200 [[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) 201 202 # **LoadClientInfo** 203 > ClientApiResponse LoadClientInfo(ctx, ) 204 Get App Settings 205 206 <p style='font-style:italic;'>Since 1.0.11 (Release 6.3)</p><p>Returns client application data: general info, specific provisioning parameters, hints, etc.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table> 207 208 ### Required Parameters 209 This endpoint does not need any parameter. 210 211 ### Return type 212 213 [**ClientApiResponse**](ClientApiResponse.md) 214 215 ### Authorization 216 217 [OAuth2](../README.md#OAuth2) 218 219 ### HTTP request headers 220 221 - **Content-Type**: Not defined 222 - **Accept**: application/json 223 224 [[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) 225 226 # **LoadPhoneData** 227 > LoadPhoneData(ctx, ) 228 Get Phonedata 229 230 <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns configuration settings for phone number parser in a phonedata.xml file.</p><h4>Usage Plan Group</h4><p>Medium</p> 231 232 ### Required Parameters 233 This endpoint does not need any parameter. 234 235 ### Return type 236 237 (empty response body) 238 239 ### Authorization 240 241 [OAuth2](../README.md#OAuth2) 242 243 ### HTTP request headers 244 245 - **Content-Type**: Not defined 246 - **Accept**: Not defined 247 248 [[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) 249 250 # **UpdateCustomData** 251 > CustomDataApiResponse UpdateCustomData(ctx, key, customDataRequest) 252 Create/Update Custom Data 253 254 <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Creates or updates custom data for the extension that is currently logged in.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table> 255 256 ### Required Parameters 257 258 Name | Type | Description | Notes 259 ------------- | ------------- | ------------- | ------------- 260 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 261 **key** | **int32**| Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension | 262 **customDataRequest** | [**CustomDataRequest**](CustomDataRequest.md)| JSON body | 263 264 ### Return type 265 266 [**CustomDataApiResponse**](CustomDataApiResponse.md) 267 268 ### Authorization 269 270 [OAuth2](../README.md#OAuth2) 271 272 ### HTTP request headers 273 274 - **Content-Type**: application/json 275 - **Accept**: application/json 276 277 [[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) 278