github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/UserSettingsApi.md (about) 1 # \UserSettingsApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**DeleteExtension**](UserSettingsApi.md#DeleteExtension) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId} | Delete Extension 8 [**DownloadImage**](UserSettingsApi.md#DownloadImage) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Get User Profile Image 9 [**GetNotificationSettings**](UserSettingsApi.md#GetNotificationSettings) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings | Get Notification Settings 10 [**ListExtensionGrants**](UserSettingsApi.md#ListExtensionGrants) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/grant | Get Extension Grants 11 [**ListSecretQuestions**](UserSettingsApi.md#ListSecretQuestions) | **Get** /restapi/v1.0/dictionary/secret-question | Get Secret Questions 12 [**LoadConferencingInfo**](UserSettingsApi.md#LoadConferencingInfo) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing | Get User Conferencing Settings 13 [**LoadExtensionCallerId**](UserSettingsApi.md#LoadExtensionCallerId) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id | Get Extension Caller ID 14 [**LoadExtensionInfo**](UserSettingsApi.md#LoadExtensionInfo) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId} | Get Extension Info 15 [**LoadExtensionProfileImage**](UserSettingsApi.md#LoadExtensionProfileImage) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize} | Get Extension Profile Image (Scaled) 16 [**LoadExtensionUserCredentials**](UserSettingsApi.md#LoadExtensionUserCredentials) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials | Get User Credentials 17 [**LoadSecretQuestion**](UserSettingsApi.md#LoadSecretQuestion) | **Get** /restapi/v1.0/dictionary/secret-question/{questionId} | Get Secret Question 18 [**UpdateConferencingInfo**](UserSettingsApi.md#UpdateConferencingInfo) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing | Update User Conferencing Settings 19 [**UpdateExtension**](UserSettingsApi.md#UpdateExtension) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId} | Update Extension 20 [**UpdateExtensionCallerId**](UserSettingsApi.md#UpdateExtensionCallerId) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id | Update Extension Caller ID 21 [**UpdateExtensionUserCredentials**](UserSettingsApi.md#UpdateExtensionUserCredentials) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials | Update User Credentials 22 [**UpdateNotificationSettings**](UserSettingsApi.md#UpdateNotificationSettings) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings | Update Notification Settings 23 [**UploadImageByPostForm**](UserSettingsApi.md#UploadImageByPostForm) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Upload User Profile Image 24 [**UploadImageByPutForm**](UserSettingsApi.md#UploadImageByPutForm) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Update User Profile Image 25 [**ValidateExtensionUserCredentials**](UserSettingsApi.md#ValidateExtensionUserCredentials) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/validate | Validate User Credentials 26 [**VerifyExtensionUserCredentials**](UserSettingsApi.md#VerifyExtensionUserCredentials) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/verify | Verify Extension User Credentials 27 28 29 # **DeleteExtension** 30 > DeleteExtension(ctx, extensionId, accountId) 31 Delete Extension 32 33 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Deletes extension(s) by ID(s).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 34 35 ### Required Parameters 36 37 Name | Type | Description | Notes 38 ------------- | ------------- | ------------- | ------------- 39 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 40 **extensionId** | **string**| | 41 **accountId** | **string**| | 42 43 ### Return type 44 45 (empty response body) 46 47 ### Authorization 48 49 [OAuth2](../README.md#OAuth2) 50 51 ### HTTP request headers 52 53 - **Content-Type**: Not defined 54 - **Accept**: Not defined 55 56 [[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) 57 58 # **DownloadImage** 59 > Binary DownloadImage(ctx, extensionId, accountId) 60 Get User Profile Image 61 62 <p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 63 64 ### Required Parameters 65 66 Name | Type | Description | Notes 67 ------------- | ------------- | ------------- | ------------- 68 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 69 **extensionId** | **string**| | 70 **accountId** | **string**| | 71 72 ### Return type 73 74 [**Binary**](Binary.md) 75 76 ### Authorization 77 78 [OAuth2](../README.md#OAuth2) 79 80 ### HTTP request headers 81 82 - **Content-Type**: Not defined 83 - **Accept**: */*, image/png, image/jpeg, image/gif 84 85 [[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) 86 87 # **GetNotificationSettings** 88 > NotificationSettings GetNotificationSettings(ctx, accountId, extensionId) 89 Get Notification Settings 90 91 <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Returns notification settings for the current extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 92 93 ### Required Parameters 94 95 Name | Type | Description | Notes 96 ------------- | ------------- | ------------- | ------------- 97 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 98 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 99 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | 100 101 ### Return type 102 103 [**NotificationSettings**](NotificationSettings.md) 104 105 ### Authorization 106 107 [OAuth2](../README.md#OAuth2) 108 109 ### HTTP request headers 110 111 - **Content-Type**: Not defined 112 - **Accept**: application/json 113 114 [[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) 115 116 # **ListExtensionGrants** 117 > GetExtensionGrantListResponse ListExtensionGrants(ctx, accountId, extensionId, optional) 118 Get Extension Grants 119 120 <p style='font-style:italic;'></p><p>Returns the list of extension grants.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 121 122 ### Required Parameters 123 124 Name | Type | Description | Notes 125 ------------- | ------------- | ------------- | ------------- 126 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 127 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 128 **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 ~] 129 **optional** | ***ListExtensionGrantsOpts** | optional parameters | nil if no parameters 130 131 ### Optional Parameters 132 Optional parameters are passed through a pointer to a ListExtensionGrantsOpts struct 133 134 Name | Type | Description | Notes 135 ------------- | ------------- | ------------- | ------------- 136 137 138 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 139 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 140 141 ### Return type 142 143 [**GetExtensionGrantListResponse**](GetExtensionGrantListResponse.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 # **ListSecretQuestions** 157 > GetSecretQuestionListResponse ListSecretQuestions(ctx, optional) 158 Get Secret Questions 159 160 <p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns the list of secret questions for a specific language.</p><h4>Usage Plan Group</h4><p>Light</p> 161 162 ### Required Parameters 163 164 Name | Type | Description | Notes 165 ------------- | ------------- | ------------- | ------------- 166 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 167 **optional** | ***ListSecretQuestionsOpts** | optional parameters | nil if no parameters 168 169 ### Optional Parameters 170 Optional parameters are passed through a pointer to a ListSecretQuestionsOpts struct 171 172 Name | Type | Description | Notes 173 ------------- | ------------- | ------------- | ------------- 174 **signupOnly** | **optional.Bool**| | [default to false] 175 **page** | **optional.String**| | [default to 1] 176 **perPage** | **optional.String**| | [default to 100] 177 178 ### Return type 179 180 [**GetSecretQuestionListResponse**](GetSecretQuestionListResponse.md) 181 182 ### Authorization 183 184 [OAuth2](../README.md#OAuth2) 185 186 ### HTTP request headers 187 188 - **Content-Type**: Not defined 189 - **Accept**: application/json 190 191 [[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) 192 193 # **LoadConferencingInfo** 194 > GetConferencingInfoResponse LoadConferencingInfo(ctx, accountId, extensionId, optional) 195 Get User Conferencing Settings 196 197 <p style='font-style:italic;'>Since 1.0.4 (Release 5.13)</p><p>Returns the information on the Free Conference Calling (FCC) feature for a given extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 198 199 ### Required Parameters 200 201 Name | Type | Description | Notes 202 ------------- | ------------- | ------------- | ------------- 203 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 204 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 205 **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 ~] 206 **optional** | ***LoadConferencingInfoOpts** | optional parameters | nil if no parameters 207 208 ### Optional Parameters 209 Optional parameters are passed through a pointer to a LoadConferencingInfoOpts struct 210 211 Name | Type | Description | Notes 212 ------------- | ------------- | ------------- | ------------- 213 214 215 **countryId** | **optional.String**| Internal identifier of a country. If not specified, the response is returned for the brand country | 216 217 ### Return type 218 219 [**GetConferencingInfoResponse**](GetConferencingInfoResponse.md) 220 221 ### Authorization 222 223 [OAuth2](../README.md#OAuth2) 224 225 ### HTTP request headers 226 227 - **Content-Type**: Not defined 228 - **Accept**: application/json 229 230 [[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) 231 232 # **LoadExtensionCallerId** 233 > ExtensionCallerIdInfo LoadExtensionCallerId(ctx, accountId, extensionId) 234 Get Extension Caller ID 235 236 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns information on an outbound caller ID of an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 237 238 ### Required Parameters 239 240 Name | Type | Description | Notes 241 ------------- | ------------- | ------------- | ------------- 242 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 243 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 244 **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 ~] 245 246 ### Return type 247 248 [**ExtensionCallerIdInfo**](ExtensionCallerIdInfo.md) 249 250 ### Authorization 251 252 [OAuth2](../README.md#OAuth2) 253 254 ### HTTP request headers 255 256 - **Content-Type**: Not defined 257 - **Accept**: application/json 258 259 [[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) 260 261 # **LoadExtensionInfo** 262 > GetExtensionInfoResponse LoadExtensionInfo(ctx, accountId, extensionId) 263 Get Extension Info 264 265 <p style='font-style:italic;'>Since 1.0.0</p><p>Returns basic information about a particular extension of an account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 266 267 ### Required Parameters 268 269 Name | Type | Description | Notes 270 ------------- | ------------- | ------------- | ------------- 271 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 272 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 273 **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 ~] 274 275 ### Return type 276 277 [**GetExtensionInfoResponse**](GetExtensionInfoResponse.md) 278 279 ### Authorization 280 281 [OAuth2](../README.md#OAuth2) 282 283 ### HTTP request headers 284 285 - **Content-Type**: Not defined 286 - **Accept**: application/json 287 288 [[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) 289 290 # **LoadExtensionProfileImage** 291 > Binary LoadExtensionProfileImage(ctx, accountId, extensionId, scaleSize) 292 Get Extension Profile Image (Scaled) 293 294 <p style='font-style:italic;'></p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 295 296 ### Required Parameters 297 298 Name | Type | Description | Notes 299 ------------- | ------------- | ------------- | ------------- 300 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 301 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 302 **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 ~] 303 **scaleSize** | **string**| Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then | 304 305 ### Return type 306 307 [**Binary**](Binary.md) 308 309 ### Authorization 310 311 [OAuth2](../README.md#OAuth2) 312 313 ### HTTP request headers 314 315 - **Content-Type**: Not defined 316 - **Accept**: application/json 317 318 [[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) 319 320 # **LoadExtensionUserCredentials** 321 > ExtensionUserCredentials LoadExtensionUserCredentials(ctx, accountId, extensionId) 322 Get User Credentials 323 324 <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 325 326 ### Required Parameters 327 328 Name | Type | Description | Notes 329 ------------- | ------------- | ------------- | ------------- 330 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 331 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 332 **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 ~] 333 334 ### Return type 335 336 [**ExtensionUserCredentials**](ExtensionUserCredentials.md) 337 338 ### Authorization 339 340 [OAuth2](../README.md#OAuth2) 341 342 ### HTTP request headers 343 344 - **Content-Type**: Not defined 345 - **Accept**: application/json 346 347 [[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) 348 349 # **LoadSecretQuestion** 350 > SecretQuestionInfo LoadSecretQuestion(ctx, questionId) 351 Get Secret Question 352 353 <p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns a particular secret question in specific language by question ID.</p><h4>Usage Plan Group</h4><p>Light</p> 354 355 ### Required Parameters 356 357 Name | Type | Description | Notes 358 ------------- | ------------- | ------------- | ------------- 359 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 360 **questionId** | **int32**| Internal identifier of a question | 361 362 ### Return type 363 364 [**SecretQuestionInfo**](SecretQuestionInfo.md) 365 366 ### Authorization 367 368 [OAuth2](../README.md#OAuth2) 369 370 ### HTTP request headers 371 372 - **Content-Type**: Not defined 373 - **Accept**: application/json 374 375 [[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) 376 377 # **UpdateConferencingInfo** 378 > GetConferencingInfoResponse UpdateConferencingInfo(ctx, accountId, extensionId, updateConferencingInfoRequest) 379 Update User Conferencing Settings 380 381 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 382 383 ### Required Parameters 384 385 Name | Type | Description | Notes 386 ------------- | ------------- | ------------- | ------------- 387 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 388 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 389 **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 ~] 390 **updateConferencingInfoRequest** | [**UpdateConferencingInfoRequest**](UpdateConferencingInfoRequest.md)| JSON body | 391 392 ### Return type 393 394 [**GetConferencingInfoResponse**](GetConferencingInfoResponse.md) 395 396 ### Authorization 397 398 [OAuth2](../README.md#OAuth2) 399 400 ### HTTP request headers 401 402 - **Content-Type**: application/json 403 - **Accept**: application/json 404 405 [[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) 406 407 # **UpdateExtension** 408 > GetExtensionInfoResponse UpdateExtension(ctx, accountId, extensionId, extensionUpdateRequest) 409 Update Extension 410 411 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 412 413 ### Required Parameters 414 415 Name | Type | Description | Notes 416 ------------- | ------------- | ------------- | ------------- 417 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 418 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 419 **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 ~] 420 **extensionUpdateRequest** | [**ExtensionUpdateRequest**](ExtensionUpdateRequest.md)| JSON body | 421 422 ### Return type 423 424 [**GetExtensionInfoResponse**](GetExtensionInfoResponse.md) 425 426 ### Authorization 427 428 [OAuth2](../README.md#OAuth2) 429 430 ### HTTP request headers 431 432 - **Content-Type**: application/json 433 - **Accept**: application/json 434 435 [[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) 436 437 # **UpdateExtensionCallerId** 438 > ExtensionCallerIdInfo UpdateExtensionCallerId(ctx, accountId, extensionId, extensionCallerIdInfo) 439 Update Extension Caller ID 440 441 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates outbound caller ID information of an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 442 443 ### Required Parameters 444 445 Name | Type | Description | Notes 446 ------------- | ------------- | ------------- | ------------- 447 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 448 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 449 **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 ~] 450 **extensionCallerIdInfo** | [**ExtensionCallerIdInfo**](ExtensionCallerIdInfo.md)| JSON body | 451 452 ### Return type 453 454 [**ExtensionCallerIdInfo**](ExtensionCallerIdInfo.md) 455 456 ### Authorization 457 458 [OAuth2](../README.md#OAuth2) 459 460 ### HTTP request headers 461 462 - **Content-Type**: application/json 463 - **Accept**: application/json 464 465 [[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) 466 467 # **UpdateExtensionUserCredentials** 468 > ExtensionUserCredentials UpdateExtensionUserCredentials(ctx, accountId, extensionId, extensionUserCredentailsRequest) 469 Update User Credentials 470 471 <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Updates extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 472 473 ### Required Parameters 474 475 Name | Type | Description | Notes 476 ------------- | ------------- | ------------- | ------------- 477 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 478 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 479 **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 ~] 480 **extensionUserCredentailsRequest** | [**ExtensionUserCredentailsRequest**](ExtensionUserCredentailsRequest.md)| JSON body | 481 482 ### Return type 483 484 [**ExtensionUserCredentials**](ExtensionUserCredentials.md) 485 486 ### Authorization 487 488 [OAuth2](../README.md#OAuth2) 489 490 ### HTTP request headers 491 492 - **Content-Type**: application/json 493 - **Accept**: application/json 494 495 [[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) 496 497 # **UpdateNotificationSettings** 498 > NotificationSettings UpdateNotificationSettings(ctx, accountId, extensionId, notificationSettingsUpdateRequest) 499 Update Notification Settings 500 501 <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Updates notification settings for the current extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 502 503 ### Required Parameters 504 505 Name | Type | Description | Notes 506 ------------- | ------------- | ------------- | ------------- 507 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 508 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 509 **extensionId** | **int32**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | 510 **notificationSettingsUpdateRequest** | [**NotificationSettingsUpdateRequest**](NotificationSettingsUpdateRequest.md)| | 511 512 ### Return type 513 514 [**NotificationSettings**](NotificationSettings.md) 515 516 ### Authorization 517 518 [OAuth2](../README.md#OAuth2) 519 520 ### HTTP request headers 521 522 - **Content-Type**: application/json 523 - **Accept**: application/json 524 525 [[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) 526 527 # **UploadImageByPostForm** 528 > Binary UploadImageByPostForm(ctx, extensionId, accountId, image) 529 Upload User Profile Image 530 531 <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 532 533 ### Required Parameters 534 535 Name | Type | Description | Notes 536 ------------- | ------------- | ------------- | ------------- 537 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 538 **extensionId** | **string**| | 539 **accountId** | **string**| | 540 **image** | ***os.File*****os.File**| | 541 542 ### Return type 543 544 [**Binary**](Binary.md) 545 546 ### Authorization 547 548 [OAuth2](../README.md#OAuth2) 549 550 ### HTTP request headers 551 552 - **Content-Type**: multipart/form-data 553 - **Accept**: application/json 554 555 [[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) 556 557 # **UploadImageByPutForm** 558 > Binary UploadImageByPutForm(ctx, extensionId, accountId, optional) 559 Update User Profile Image 560 561 <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Updates the extension profile image..</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 562 563 ### Required Parameters 564 565 Name | Type | Description | Notes 566 ------------- | ------------- | ------------- | ------------- 567 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 568 **extensionId** | **string**| | 569 **accountId** | **string**| | 570 **optional** | ***UploadImageByPutFormOpts** | optional parameters | nil if no parameters 571 572 ### Optional Parameters 573 Optional parameters are passed through a pointer to a UploadImageByPutFormOpts struct 574 575 Name | Type | Description | Notes 576 ------------- | ------------- | ------------- | ------------- 577 578 579 **image** | **optional.Interface of *os.File****optional.*os.File**| | 580 581 ### Return type 582 583 [**Binary**](Binary.md) 584 585 ### Authorization 586 587 [OAuth2](../README.md#OAuth2) 588 589 ### HTTP request headers 590 591 - **Content-Type**: multipart/form-data 592 - **Accept**: application/json 593 594 [[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) 595 596 # **ValidateExtensionUserCredentials** 597 > ValidateExtensionUserCredentials(ctx, accountId, extensionId, validateExtensionUserCredentials) 598 Validate User Credentials 599 600 <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Validates if extension user credentials specified can be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 601 602 ### Required Parameters 603 604 Name | Type | Description | Notes 605 ------------- | ------------- | ------------- | ------------- 606 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 607 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 608 **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 ~] 609 **validateExtensionUserCredentials** | [**ValidateExtensionUserCredentials**](ValidateExtensionUserCredentials.md)| JSON body | 610 611 ### Return type 612 613 (empty response body) 614 615 ### Authorization 616 617 [OAuth2](../README.md#OAuth2) 618 619 ### HTTP request headers 620 621 - **Content-Type**: application/json 622 - **Accept**: Not defined 623 624 [[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) 625 626 # **VerifyExtensionUserCredentials** 627 > VerifyExtensionUserCredentials(ctx, accountId, extensionId, verifyExtensionUserCredentials) 628 Verify Extension User Credentials 629 630 <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Verifies current extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 631 632 ### Required Parameters 633 634 Name | Type | Description | Notes 635 ------------- | ------------- | ------------- | ------------- 636 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 637 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 638 **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 ~] 639 **verifyExtensionUserCredentials** | [**VerifyExtensionUserCredentials**](VerifyExtensionUserCredentials.md)| JSON body | 640 641 ### Return type 642 643 (empty response body) 644 645 ### Authorization 646 647 [OAuth2](../README.md#OAuth2) 648 649 ### HTTP request headers 650 651 - **Content-Type**: application/json 652 - **Accept**: Not defined 653 654 [[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) 655