github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/AccountProvisioningApi.md (about) 1 # \AccountProvisioningApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**BulkAssign**](AccountProvisioningApi.md#BulkAssign) | **Post** /restapi/v1.0/account/{accountId}/department/bulk-assign | Edit Call Queue Members 8 [**CreateAccount**](AccountProvisioningApi.md#CreateAccount) | **Post** /restapi/v1.0/account | Create Account 9 [**CreateDeviceOrder**](AccountProvisioningApi.md#CreateDeviceOrder) | **Post** /restapi/v1.0/account/{accountId}/order | Create Device Order 10 [**CreateLicensesOrder**](AccountProvisioningApi.md#CreateLicensesOrder) | **Post** /restapi/v1.0/account/{accountId}/licenses/bulk-purchase | Order Licenses 11 [**DeleteLicense**](AccountProvisioningApi.md#DeleteLicense) | **Delete** /restapi/v1.0/account/{accountId}/licenses/{licenseId} | Delete License 12 [**DeletePhoneNumberById**](AccountProvisioningApi.md#DeletePhoneNumberById) | **Delete** /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId} | Delete Phone Number 13 [**GetBrandInfo**](AccountProvisioningApi.md#GetBrandInfo) | **Get** /restapi/v1.0/dictionary/brand/{brandId} | Get Brand Info 14 [**GetDeviceModels**](AccountProvisioningApi.md#GetDeviceModels) | **Get** /restapi/v1.0/dictionary/device | Get Device Catalog 15 [**GetExtensionFreeNumbers**](AccountProvisioningApi.md#GetExtensionFreeNumbers) | **Get** /restapi/v1.0/account/{accountId}/extension/free-numbers | Get Free Extension Numbers 16 [**GetPagingOnlyGroupDevices**](AccountProvisioningApi.md#GetPagingOnlyGroupDevices) | **Get** /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices | Get Paging Only Group Devices 17 [**GetPagingOnlyGroupUsers**](AccountProvisioningApi.md#GetPagingOnlyGroupUsers) | **Get** /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users | Get Paging Only Group Users 18 [**GetParkLocationUsers**](AccountProvisioningApi.md#GetParkLocationUsers) | **Get** /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/users | Get Park Location Users 19 [**GetServicePlanInfo**](AccountProvisioningApi.md#GetServicePlanInfo) | **Get** /restapi/v1.0/dictionary/service-plan/{servicePlanId} | Get Service Plan 20 [**ListAccountDevices**](AccountProvisioningApi.md#ListAccountDevices) | **Get** /restapi/v1.0/account/{accountId}/device | Get Account Devices 21 [**ListAccountPhoneNumbers**](AccountProvisioningApi.md#ListAccountPhoneNumbers) | **Get** /restapi/v1.0/account/{accountId}/phone-number | Get All Company Phone Numbers 22 [**ListDepartmentMembers**](AccountProvisioningApi.md#ListDepartmentMembers) | **Get** /restapi/v1.0/account/{accountId}/department/{departmentId}/members | Get Department Member List 23 [**ListExtensionDevices**](AccountProvisioningApi.md#ListExtensionDevices) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/device | Get User Device Info 24 [**ListLicenseTypes**](AccountProvisioningApi.md#ListLicenseTypes) | **Get** /restapi/v1.0/dictionary/license-types | Get License Types 25 [**ListLicenses**](AccountProvisioningApi.md#ListLicenses) | **Get** /restapi/v1.0/account/{accountId}/licenses | Get License List 26 [**ListShippingOptions**](AccountProvisioningApi.md#ListShippingOptions) | **Get** /restapi/v1.0/dictionary/shipping-options | Get Shipping Options 27 [**LoadAccountDevice**](AccountProvisioningApi.md#LoadAccountDevice) | **Get** /restapi/v1.0/account/{accountId}/device/{deviceId} | Get Device Info 28 [**LoadAccountPhoneNumber**](AccountProvisioningApi.md#LoadAccountPhoneNumber) | **Get** /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId} | Get Phone Number 29 [**LoadDeviceOrder**](AccountProvisioningApi.md#LoadDeviceOrder) | **Get** /restapi/v1.0/account/{accountId}/order/{orderId} | Get Device Order by ID 30 [**LoadLicense**](AccountProvisioningApi.md#LoadLicense) | **Get** /restapi/v1.0/account/{accountId}/licenses/{licenseId} | Get License 31 [**LookupPhoneNumbers**](AccountProvisioningApi.md#LookupPhoneNumbers) | **Post** /restapi/v1.0/number-pool/lookup | Get Numbers 32 [**ParsePhoneNumber**](AccountProvisioningApi.md#ParsePhoneNumber) | **Post** /restapi/v1.0/number-parser/parse | Parse Phone Number 33 [**ProvisionPhoneNumber**](AccountProvisioningApi.md#ProvisionPhoneNumber) | **Post** /restapi/v1.0/account/{accountId}/phone-number | Provision Phone Numbers 34 [**ReassignPhoneNumberById**](AccountProvisioningApi.md#ReassignPhoneNumberById) | **Put** /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId} | Reassign Phone Number 35 [**ReservePhoneNumbers**](AccountProvisioningApi.md#ReservePhoneNumbers) | **Post** /restapi/v1.0/number-pool/reserve | Reserve/ Un-reserve Numbers 36 [**UpdateDevice**](AccountProvisioningApi.md#UpdateDevice) | **Put** /restapi/v1.0/account/{accountId}/device/{deviceId} | Update Device 37 [**UpdatePagingOnlyGroupUsersAndDevices**](AccountProvisioningApi.md#UpdatePagingOnlyGroupUsersAndDevices) | **Post** /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign | Edit Paging Group Users & Devices 38 [**UpdateParkLocationUsers**](AccountProvisioningApi.md#UpdateParkLocationUsers) | **Post** /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/bulk-assign | Adds and/or removes park location users 39 40 41 # **BulkAssign** 42 > BulkAssign(ctx, accountId, optional) 43 Edit Call Queue Members 44 45 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes multiple call queue members.</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> 46 47 ### Required Parameters 48 49 Name | Type | Description | Notes 50 ------------- | ------------- | ------------- | ------------- 51 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 52 **accountId** | **string**| | [default to ~] 53 **optional** | ***BulkAssignOpts** | optional parameters | nil if no parameters 54 55 ### Optional Parameters 56 Optional parameters are passed through a pointer to a BulkAssignOpts struct 57 58 Name | Type | Description | Notes 59 ------------- | ------------- | ------------- | ------------- 60 61 **departmentBulkAssignResource** | [**optional.Interface of DepartmentBulkAssignResource**](DepartmentBulkAssignResource.md)| | 62 63 ### Return type 64 65 (empty response body) 66 67 ### Authorization 68 69 [OAuth2](../README.md#OAuth2) 70 71 ### HTTP request headers 72 73 - **Content-Type**: application/json 74 - **Accept**: Not defined 75 76 [[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) 77 78 # **CreateAccount** 79 > GetAccountInfoResponse CreateAccount(ctx, createAccountRequest) 80 Create Account 81 82 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Creates the account in Initial state.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Accounts</td><td>Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts</td></tr><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><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 83 84 ### Required Parameters 85 86 Name | Type | Description | Notes 87 ------------- | ------------- | ------------- | ------------- 88 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 89 **createAccountRequest** | [**CreateAccountRequest**](CreateAccountRequest.md)| JSON body | 90 91 ### Return type 92 93 [**GetAccountInfoResponse**](GetAccountInfoResponse.md) 94 95 ### Authorization 96 97 [OAuth2](../README.md#OAuth2) 98 99 ### HTTP request headers 100 101 - **Content-Type**: application/json 102 - **Accept**: application/json 103 104 [[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) 105 106 # **CreateDeviceOrder** 107 > DeviceOrderCreation CreateDeviceOrder(ctx, accountId, optional) 108 Create Device Order 109 110 <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'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><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>Heavy</p> 111 112 ### Required Parameters 113 114 Name | Type | Description | Notes 115 ------------- | ------------- | ------------- | ------------- 116 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 117 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 118 **optional** | ***CreateDeviceOrderOpts** | optional parameters | nil if no parameters 119 120 ### Optional Parameters 121 Optional parameters are passed through a pointer to a CreateDeviceOrderOpts struct 122 123 Name | Type | Description | Notes 124 ------------- | ------------- | ------------- | ------------- 125 126 **async** | **optional.Bool**| Specifies whether a client expects order details to be returned or not. If 'True' the server returns a link for tracking order status without waiting for it to be actually created. If 'False' the server returns order details once it is created - it may take some time depending on device count. The default value is 'False' | [default to false] 127 **deviceResource** | [**optional.Interface of DeviceResource**](DeviceResource.md)| | 128 129 ### Return type 130 131 [**DeviceOrderCreation**](DeviceOrderCreation.md) 132 133 ### Authorization 134 135 [OAuth2](../README.md#OAuth2) 136 137 ### HTTP request headers 138 139 - **Content-Type**: application/json 140 - **Accept**: application/json 141 142 [[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) 143 144 # **CreateLicensesOrder** 145 > CreateLicensesOrder(ctx, accountId, orderLicensesRequest) 146 Order Licenses 147 148 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Purchases licenses for add-on features: Rooms, Room Connector, Webinar, Live Reports, etc.</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><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><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>API Group</h4><p>Heavy</p> 149 150 ### Required Parameters 151 152 Name | Type | Description | Notes 153 ------------- | ------------- | ------------- | ------------- 154 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 155 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 156 **orderLicensesRequest** | [**OrderLicensesRequest**](OrderLicensesRequest.md)| JSON body | 157 158 ### Return type 159 160 (empty response body) 161 162 ### Authorization 163 164 [OAuth2](../README.md#OAuth2) 165 166 ### HTTP request headers 167 168 - **Content-Type**: application/json 169 - **Accept**: Not defined 170 171 [[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) 172 173 # **DeleteLicense** 174 > DeleteLicense(ctx, accountId, licenseId) 175 Delete License 176 177 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Removes a license for a specific user. Please note: It is not allowed to remove assigned licenses (only Webinars and Large Meetings can be assigned).</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><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><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>API Group</h4><p>Medium</p> 178 179 ### Required Parameters 180 181 Name | Type | Description | Notes 182 ------------- | ------------- | ------------- | ------------- 183 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 184 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 185 **licenseId** | **string**| Internal identifier of a license | 186 187 ### Return type 188 189 (empty response body) 190 191 ### Authorization 192 193 [OAuth2](../README.md#OAuth2) 194 195 ### HTTP request headers 196 197 - **Content-Type**: Not defined 198 - **Accept**: Not defined 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 # **DeletePhoneNumberById** 203 > DeletePhoneNumberById(ctx, phoneNumberId, accountId) 204 Delete Phone Number 205 206 <p style='font-style:italic;'>Since 1.0.11 (Release 6.3) </p><p>Deletes a phone number belonging to a certain account/extension.</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> 207 208 ### Required Parameters 209 210 Name | Type | Description | Notes 211 ------------- | ------------- | ------------- | ------------- 212 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 213 **phoneNumberId** | **int64**| | 214 **accountId** | **string**| | 215 216 ### Return type 217 218 (empty response body) 219 220 ### Authorization 221 222 [OAuth2](../README.md#OAuth2) 223 224 ### HTTP request headers 225 226 - **Content-Type**: Not defined 227 - **Accept**: Not defined 228 229 [[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) 230 231 # **GetBrandInfo** 232 > BrandResource GetBrandInfo(ctx, brandId) 233 Get Brand Info 234 235 ### Required Parameters 236 237 Name | Type | Description | Notes 238 ------------- | ------------- | ------------- | ------------- 239 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 240 **brandId** | **string**| | 241 242 ### Return type 243 244 [**BrandResource**](BrandResource.md) 245 246 ### Authorization 247 248 [OAuth2](../README.md#OAuth2) 249 250 ### HTTP request headers 251 252 - **Content-Type**: Not defined 253 - **Accept**: application/json 254 255 [[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) 256 257 # **GetDeviceModels** 258 > DeviceModelExtsResource GetDeviceModels(ctx, ) 259 Get Device Catalog 260 261 ### Required Parameters 262 This endpoint does not need any parameter. 263 264 ### Return type 265 266 [**DeviceModelExtsResource**](DeviceModelExtsResource.md) 267 268 ### Authorization 269 270 [OAuth2](../README.md#OAuth2) 271 272 ### HTTP request headers 273 274 - **Content-Type**: Not defined 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 279 # **GetExtensionFreeNumbers** 280 > BulkProvisionUnassignedExtensionsResponseResource GetExtensionFreeNumbers(ctx, accountId) 281 Get Free Extension Numbers 282 283 ### Required Parameters 284 285 Name | Type | Description | Notes 286 ------------- | ------------- | ------------- | ------------- 287 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 288 **accountId** | **string**| | 289 290 ### Return type 291 292 [**BulkProvisionUnassignedExtensionsResponseResource**](BulkProvisionUnassignedExtensionsResponseResource.md) 293 294 ### Authorization 295 296 [OAuth2](../README.md#OAuth2) 297 298 ### HTTP request headers 299 300 - **Content-Type**: Not defined 301 - **Accept**: application/json 302 303 [[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) 304 305 # **GetPagingOnlyGroupDevices** 306 > PagingOnlyGroupDevices GetPagingOnlyGroupDevices(ctx, accountId, pagingOnlyGroupId, optional) 307 Get Paging Only Group Devices 308 309 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of paging devices assigned to this group.</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> 310 311 ### Required Parameters 312 313 Name | Type | Description | Notes 314 ------------- | ------------- | ------------- | ------------- 315 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 316 **accountId** | **string**| | 317 **pagingOnlyGroupId** | **string**| | 318 **optional** | ***GetPagingOnlyGroupDevicesOpts** | optional parameters | nil if no parameters 319 320 ### Optional Parameters 321 Optional parameters are passed through a pointer to a GetPagingOnlyGroupDevicesOpts struct 322 323 Name | Type | Description | Notes 324 ------------- | ------------- | ------------- | ------------- 325 326 327 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 328 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 329 330 ### Return type 331 332 [**PagingOnlyGroupDevices**](PagingOnlyGroupDevices.md) 333 334 ### Authorization 335 336 [OAuth2](../README.md#OAuth2) 337 338 ### HTTP request headers 339 340 - **Content-Type**: Not defined 341 - **Accept**: application/json 342 343 [[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) 344 345 # **GetPagingOnlyGroupUsers** 346 > PagingOnlyGroupUsers GetPagingOnlyGroupUsers(ctx, accountId, pagingOnlyGroupId, optional) 347 Get Paging Only Group Users 348 349 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of users allowed to page this group.</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> 350 351 ### Required Parameters 352 353 Name | Type | Description | Notes 354 ------------- | ------------- | ------------- | ------------- 355 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 356 **accountId** | **string**| | 357 **pagingOnlyGroupId** | **string**| | 358 **optional** | ***GetPagingOnlyGroupUsersOpts** | optional parameters | nil if no parameters 359 360 ### Optional Parameters 361 Optional parameters are passed through a pointer to a GetPagingOnlyGroupUsersOpts struct 362 363 Name | Type | Description | Notes 364 ------------- | ------------- | ------------- | ------------- 365 366 367 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 368 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 369 370 ### Return type 371 372 [**PagingOnlyGroupUsers**](PagingOnlyGroupUsers.md) 373 374 ### Authorization 375 376 [OAuth2](../README.md#OAuth2) 377 378 ### HTTP request headers 379 380 - **Content-Type**: Not defined 381 - **Accept**: application/json 382 383 [[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) 384 385 # **GetParkLocationUsers** 386 > ParkLocationResponse GetParkLocationUsers(ctx, accountId, parkLocationId, optional) 387 Get Park Location Users 388 389 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of users allowed to park and unpark calls to/from the park location extension specified</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> 390 391 ### Required Parameters 392 393 Name | Type | Description | Notes 394 ------------- | ------------- | ------------- | ------------- 395 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 396 **accountId** | **string**| | 397 **parkLocationId** | **string**| | 398 **optional** | ***GetParkLocationUsersOpts** | optional parameters | nil if no parameters 399 400 ### Optional Parameters 401 Optional parameters are passed through a pointer to a GetParkLocationUsersOpts struct 402 403 Name | Type | Description | Notes 404 ------------- | ------------- | ------------- | ------------- 405 406 407 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 408 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 409 410 ### Return type 411 412 [**ParkLocationResponse**](ParkLocationResponse.md) 413 414 ### Authorization 415 416 [OAuth2](../README.md#OAuth2) 417 418 ### HTTP request headers 419 420 - **Content-Type**: Not defined 421 - **Accept**: application/json 422 423 [[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) 424 425 # **GetServicePlanInfo** 426 > ServicePlanResource GetServicePlanInfo(ctx, servicePlanId) 427 Get Service Plan 428 429 ### Required Parameters 430 431 Name | Type | Description | Notes 432 ------------- | ------------- | ------------- | ------------- 433 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 434 **servicePlanId** | **string**| | 435 436 ### Return type 437 438 [**ServicePlanResource**](ServicePlanResource.md) 439 440 ### Authorization 441 442 [OAuth2](../README.md#OAuth2) 443 444 ### HTTP request headers 445 446 - **Content-Type**: Not defined 447 - **Accept**: application/json 448 449 [[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) 450 451 # **ListAccountDevices** 452 > GetAccountDevicesResponse ListAccountDevices(ctx, accountId) 453 Get Account Devices 454 455 <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns all the devices for a particular 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> 456 457 ### Required Parameters 458 459 Name | Type | Description | Notes 460 ------------- | ------------- | ------------- | ------------- 461 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 462 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 463 464 ### Return type 465 466 [**GetAccountDevicesResponse**](GetAccountDevicesResponse.md) 467 468 ### Authorization 469 470 [OAuth2](../README.md#OAuth2) 471 472 ### HTTP request headers 473 474 - **Content-Type**: Not defined 475 - **Accept**: application/json 476 477 [[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) 478 479 # **ListAccountPhoneNumbers** 480 > AccountPhoneNumbers ListAccountPhoneNumbers(ctx, accountId, optional) 481 Get All Company Phone Numbers 482 483 <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'>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>Heavy</p> 484 485 ### Required Parameters 486 487 Name | Type | Description | Notes 488 ------------- | ------------- | ------------- | ------------- 489 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 490 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 491 **optional** | ***ListAccountPhoneNumbersOpts** | optional parameters | nil if no parameters 492 493 ### Optional Parameters 494 Optional parameters are passed through a pointer to a ListAccountPhoneNumbersOpts struct 495 496 Name | Type | Description | Notes 497 ------------- | ------------- | ------------- | ------------- 498 499 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 500 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 501 **usageType** | [**optional.Interface of []string**](string.md)| Usage type of the phone number | 502 503 ### Return type 504 505 [**AccountPhoneNumbers**](AccountPhoneNumbers.md) 506 507 ### Authorization 508 509 [OAuth2](../README.md#OAuth2) 510 511 ### HTTP request headers 512 513 - **Content-Type**: Not defined 514 - **Accept**: application/json 515 516 [[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) 517 518 # **ListDepartmentMembers** 519 > DepartmentMemberList ListDepartmentMembers(ctx, accountId, departmentId, optional) 520 Get Department Member List 521 522 <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'>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> 523 524 ### Required Parameters 525 526 Name | Type | Description | Notes 527 ------------- | ------------- | ------------- | ------------- 528 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 529 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 530 **departmentId** | **int32**| Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid) | 531 **optional** | ***ListDepartmentMembersOpts** | optional parameters | nil if no parameters 532 533 ### Optional Parameters 534 Optional parameters are passed through a pointer to a ListDepartmentMembersOpts struct 535 536 Name | Type | Description | Notes 537 ------------- | ------------- | ------------- | ------------- 538 539 540 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 541 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 542 543 ### Return type 544 545 [**DepartmentMemberList**](DepartmentMemberList.md) 546 547 ### Authorization 548 549 [OAuth2](../README.md#OAuth2) 550 551 ### HTTP request headers 552 553 - **Content-Type**: Not defined 554 - **Accept**: application/json 555 556 [[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) 557 558 # **ListExtensionDevices** 559 > GetExtensionDevicesResponse ListExtensionDevices(ctx, accountId, extensionId, optional) 560 Get User Device Info 561 562 <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns all the devices for extension(s) by extension ID(s). Batch request is supported, see Batch Requests for details.</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> 563 564 ### Required Parameters 565 566 Name | Type | Description | Notes 567 ------------- | ------------- | ------------- | ------------- 568 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 569 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 570 **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 ~] 571 **optional** | ***ListExtensionDevicesOpts** | optional parameters | nil if no parameters 572 573 ### Optional Parameters 574 Optional parameters are passed through a pointer to a ListExtensionDevicesOpts struct 575 576 Name | Type | Description | Notes 577 ------------- | ------------- | ------------- | ------------- 578 579 580 **linePooling** | **optional.String**| Pooling type of a device | 581 582 ### Return type 583 584 [**GetExtensionDevicesResponse**](GetExtensionDevicesResponse.md) 585 586 ### Authorization 587 588 [OAuth2](../README.md#OAuth2) 589 590 ### HTTP request headers 591 592 - **Content-Type**: Not defined 593 - **Accept**: application/json 594 595 [[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) 596 597 # **ListLicenseTypes** 598 > LicenseTypes ListLicenseTypes(ctx, ) 599 Get License Types 600 601 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns supported license types.</p><h4>API Group</h4><p>Light</p> 602 603 ### Required Parameters 604 This endpoint does not need any parameter. 605 606 ### Return type 607 608 [**LicenseTypes**](LicenseTypes.md) 609 610 ### Authorization 611 612 [OAuth2](../README.md#OAuth2) 613 614 ### HTTP request headers 615 616 - **Content-Type**: Not defined 617 - **Accept**: application/json 618 619 [[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) 620 621 # **ListLicenses** 622 > LicenseList ListLicenses(ctx, accountId, optional) 623 Get License List 624 625 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns list of licenses for a specific user.</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> 626 627 ### Required Parameters 628 629 Name | Type | Description | Notes 630 ------------- | ------------- | ------------- | ------------- 631 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 632 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 633 **optional** | ***ListLicensesOpts** | optional parameters | nil if no parameters 634 635 ### Optional Parameters 636 Optional parameters are passed through a pointer to a ListLicensesOpts struct 637 638 Name | Type | Description | Notes 639 ------------- | ------------- | ------------- | ------------- 640 641 **page** | **optional.Int64**| Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1' | 642 **perPage** | **optional.Int64**| Indicates the page size (number of items). If not specified, the value is '25' by default | 643 **typeId** | **optional.Int64**| Internal identifier of a license type. If not specified account licenses of all types are returned | 644 645 ### Return type 646 647 [**LicenseList**](LicenseList.md) 648 649 ### Authorization 650 651 [OAuth2](../README.md#OAuth2) 652 653 ### HTTP request headers 654 655 - **Content-Type**: Not defined 656 - **Accept**: application/json 657 658 [[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) 659 660 # **ListShippingOptions** 661 > DictionaryShippingOptions ListShippingOptions(ctx, optional) 662 Get Shipping Options 663 664 <p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Returns the list of device shipping options with their prices, according to brand, tier, number of ordered devices.</p><h4>Usage Plan Group</h4><p>Light</p> 665 666 ### Required Parameters 667 668 Name | Type | Description | Notes 669 ------------- | ------------- | ------------- | ------------- 670 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 671 **optional** | ***ListShippingOptionsOpts** | optional parameters | nil if no parameters 672 673 ### Optional Parameters 674 Optional parameters are passed through a pointer to a ListShippingOptionsOpts struct 675 676 Name | Type | Description | Notes 677 ------------- | ------------- | ------------- | ------------- 678 **servicePlanId** | **optional.Int32**| | 679 **brandId** | **optional.Int32**| | 680 **quantity** | **optional.Int32**| | 681 682 ### Return type 683 684 [**DictionaryShippingOptions**](DictionaryShippingOptions.md) 685 686 ### Authorization 687 688 [OAuth2](../README.md#OAuth2) 689 690 ### HTTP request headers 691 692 - **Content-Type**: Not defined 693 - **Accept**: application/json 694 695 [[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) 696 697 # **LoadAccountDevice** 698 > GetDeviceInfoResponse LoadAccountDevice(ctx, accountId, deviceId) 699 Get Device Info 700 701 <p style='font-style:italic;'>Since 1.0.9 (Release 6.1)</p><p>Returns account device(s) by their 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'>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> 702 703 ### Required Parameters 704 705 Name | Type | Description | Notes 706 ------------- | ------------- | ------------- | ------------- 707 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 708 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 709 **deviceId** | **string**| Internal identifier of a device | 710 711 ### Return type 712 713 [**GetDeviceInfoResponse**](GetDeviceInfoResponse.md) 714 715 ### Authorization 716 717 [OAuth2](../README.md#OAuth2) 718 719 ### HTTP request headers 720 721 - **Content-Type**: Not defined 722 - **Accept**: application/json 723 724 [[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) 725 726 # **LoadAccountPhoneNumber** 727 > PhoneNumberInfo LoadAccountPhoneNumber(ctx, accountId, phoneNumberId) 728 Get Phone Number 729 730 <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'>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> 731 732 ### Required Parameters 733 734 Name | Type | Description | Notes 735 ------------- | ------------- | ------------- | ------------- 736 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 737 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 738 **phoneNumberId** | **int32**| Internal identifier of a phone number | 739 740 ### Return type 741 742 [**PhoneNumberInfo**](PhoneNumberInfo.md) 743 744 ### Authorization 745 746 [OAuth2](../README.md#OAuth2) 747 748 ### HTTP request headers 749 750 - **Content-Type**: Not defined 751 - **Accept**: application/json 752 753 [[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) 754 755 # **LoadDeviceOrder** 756 > DeviceOrder LoadDeviceOrder(ctx, accountId, orderId) 757 Get Device Order by ID 758 759 <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'>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> 760 761 ### Required Parameters 762 763 Name | Type | Description | Notes 764 ------------- | ------------- | ------------- | ------------- 765 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 766 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 767 **orderId** | **int32**| Internal identifier of an order | 768 769 ### Return type 770 771 [**DeviceOrder**](DeviceOrder.md) 772 773 ### Authorization 774 775 [OAuth2](../README.md#OAuth2) 776 777 ### HTTP request headers 778 779 - **Content-Type**: Not defined 780 - **Accept**: application/json 781 782 [[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) 783 784 # **LoadLicense** 785 > LicenseInfo LoadLicense(ctx, accountId, licenseId) 786 Get License 787 788 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns license information by its ID.</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> 789 790 ### Required Parameters 791 792 Name | Type | Description | Notes 793 ------------- | ------------- | ------------- | ------------- 794 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 795 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 796 **licenseId** | **string**| Internal identifier of a license | 797 798 ### Return type 799 800 [**LicenseInfo**](LicenseInfo.md) 801 802 ### Authorization 803 804 [OAuth2](../README.md#OAuth2) 805 806 ### HTTP request headers 807 808 - **Content-Type**: Not defined 809 - **Accept**: application/json 810 811 [[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) 812 813 # **LookupPhoneNumbers** 814 > PhoneNumbers LookupPhoneNumbers(ctx, optional) 815 Get Numbers 816 817 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the required numbers filtered by criteria.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>NumberLookup</td><td>Looking-up and reserving available phone number</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 818 819 ### Required Parameters 820 821 Name | Type | Description | Notes 822 ------------- | ------------- | ------------- | ------------- 823 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 824 **optional** | ***LookupPhoneNumbersOpts** | optional parameters | nil if no parameters 825 826 ### Optional Parameters 827 Optional parameters are passed through a pointer to a LookupPhoneNumbersOpts struct 828 829 Name | Type | Description | Notes 830 ------------- | ------------- | ------------- | ------------- 831 **areaCode** | **optional.Int32**| Area code of the location | 832 **countryCode** | **optional.String**| Two-letter country code, complying with the ISO standard | 833 **countryId** | **optional.String**| Internal identifier of a country; '1'- the US; '39' - Canada; '224' - the UK. The default value is '1' | 834 **exclude** | **optional.String**| A string of digits (one and more) that should not appear among the last four digits (line part) of the phone numbers that will be returned. It is possible to specify severalT?exclude parameters. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified) | 835 **extendedSearch** | **optional.Bool**| If the value is 'False', then the returned numbers exactly correspond to the specified NXX, NPA and LINE or countryCode, areaCode and numberPattern parameters. If the value is 'True', then the resulting numbers are ranked and returned with the rank attribute values (1-10). The default value is 'False' | 836 **line** | **optional.String**| LINE pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 4 characters) | 837 **numberPattern** | **optional.String**| Phone number pattern (for wildcard or vanity search). For NANP countries (US, Canada) is concatenation of nxx (the first three digits) and line. If the first three characters are specified as not digits (e.g. 5** or CAT) then parameter extendedSearch will be ignored. | 838 **nxx** | **optional.String**| NXX pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 3 characters) | 839 **npa** | **optional.String**| Area code (mandatory). For example, 800, 844, 855, 866, 877, 888 for North America; and 647 for Canada | 840 **paymentType** | [**optional.Interface of []string**](string.md)| Payment type. Default is 'Local' (it should correlate with the npa provided) | 841 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '10' by default | 842 **providerId** | **optional.Int32**| Internal identifier of a phone number provider. Supported if brand is specified. If specified, area code and nxx are optional | 843 **smsEnabled** | **optional.Bool**| Specifies if SMS activation is available for the number. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified). If not specified, the value is null. | 844 845 ### Return type 846 847 [**PhoneNumbers**](PhoneNumbers.md) 848 849 ### Authorization 850 851 [OAuth2](../README.md#OAuth2) 852 853 ### HTTP request headers 854 855 - **Content-Type**: Not defined 856 - **Accept**: application/json 857 858 [[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) 859 860 # **ParsePhoneNumber** 861 > ParsePhoneNumberResponse ParsePhoneNumber(ctx, parsePhoneNumberRequest, optional) 862 Parse Phone Number 863 864 <p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns one or more parsed and/or formatted phone numbers that are passed as a string.</p><h4>Usage Plan Group</h4><p>Light</p> 865 866 ### Required Parameters 867 868 Name | Type | Description | Notes 869 ------------- | ------------- | ------------- | ------------- 870 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 871 **parsePhoneNumberRequest** | [**ParsePhoneNumberRequest**](ParsePhoneNumberRequest.md)| JSON body | 872 **optional** | ***ParsePhoneNumberOpts** | optional parameters | nil if no parameters 873 874 ### Optional Parameters 875 Optional parameters are passed through a pointer to a ParsePhoneNumberOpts struct 876 877 Name | Type | Description | Notes 878 ------------- | ------------- | ------------- | ------------- 879 880 **homeCountry** | **optional.String**| Internal identifier of a home country. The default value is ISO code (ISO 3166) of the user's home country or brand country, if the user is undefined | 881 **nationalAsPriority** | **optional.Bool**| The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority | 882 883 ### Return type 884 885 [**ParsePhoneNumberResponse**](ParsePhoneNumberResponse.md) 886 887 ### Authorization 888 889 [OAuth2](../README.md#OAuth2) 890 891 ### HTTP request headers 892 893 - **Content-Type**: application/json 894 - **Accept**: application/json 895 896 [[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) 897 898 # **ProvisionPhoneNumber** 899 > PhoneNumberInfo ProvisionPhoneNumber(ctx, accountId, provisionPhoneNumberRequest) 900 Provision Phone Numbers 901 902 <p style='font-style:italic;'>Since 1.0.11 (Release 6.3)</p><p>Provisions a phone number.</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><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> 903 904 ### Required Parameters 905 906 Name | Type | Description | Notes 907 ------------- | ------------- | ------------- | ------------- 908 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 909 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 910 **provisionPhoneNumberRequest** | [**ProvisionPhoneNumberRequest**](ProvisionPhoneNumberRequest.md)| JSON body | 911 912 ### Return type 913 914 [**PhoneNumberInfo**](PhoneNumberInfo.md) 915 916 ### Authorization 917 918 [OAuth2](../README.md#OAuth2) 919 920 ### HTTP request headers 921 922 - **Content-Type**: application/json 923 - **Accept**: application/json 924 925 [[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) 926 927 # **ReassignPhoneNumberById** 928 > PhoneNumberResource ReassignPhoneNumberById(ctx, phoneNumberId, accountId, optional) 929 Reassign Phone Number 930 931 <p style='font-style:italic;'>Since 1.0.11 (Release 6.3) </p><p>Reassigns the phone number belonging to a certain account/extension. This call reassigns a phone number, currently belonging to some other extension or company (Auto-Receptionist). Please note: numbers with certain usage types 'MainCompanyNumber', 'AdditionalCompanyNumber' and 'CompanyFaxNumber' cannot be reassigned</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> 932 933 ### Required Parameters 934 935 Name | Type | Description | Notes 936 ------------- | ------------- | ------------- | ------------- 937 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 938 **phoneNumberId** | **int64**| | 939 **accountId** | **string**| | 940 **optional** | ***ReassignPhoneNumberByIdOpts** | optional parameters | nil if no parameters 941 942 ### Optional Parameters 943 Optional parameters are passed through a pointer to a ReassignPhoneNumberByIdOpts struct 944 945 Name | Type | Description | Notes 946 ------------- | ------------- | ------------- | ------------- 947 948 949 **reassignPhoneNumberResource** | [**optional.Interface of ReassignPhoneNumberResource**](ReassignPhoneNumberResource.md)| | 950 951 ### Return type 952 953 [**PhoneNumberResource**](PhoneNumberResource.md) 954 955 ### Authorization 956 957 [OAuth2](../README.md#OAuth2) 958 959 ### HTTP request headers 960 961 - **Content-Type**: application/json 962 - **Accept**: application/json 963 964 [[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) 965 966 # **ReservePhoneNumbers** 967 > ReservePhoneNumbersRecordsResource ReservePhoneNumbers(ctx, numberPoolPhoneNumberRequest) 968 Reserve/ Un-reserve Numbers 969 970 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</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'>NumberLookup</td><td>Looking-up and reserving available phone number</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 971 972 ### Required Parameters 973 974 Name | Type | Description | Notes 975 ------------- | ------------- | ------------- | ------------- 976 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 977 **numberPoolPhoneNumberRequest** | [**NumberPoolPhoneNumberRequest**](NumberPoolPhoneNumberRequest.md)| JSON body | 978 979 ### Return type 980 981 [**ReservePhoneNumbersRecordsResource**](ReservePhoneNumbersRecordsResource.md) 982 983 ### Authorization 984 985 [OAuth2](../README.md#OAuth2) 986 987 ### HTTP request headers 988 989 - **Content-Type**: application/json 990 - **Accept**: application/json 991 992 [[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) 993 994 # **UpdateDevice** 995 > DeviceResource UpdateDevice(ctx, accountId, deviceId, accountDeviceUpdate) 996 Update Device 997 998 ### Required Parameters 999 1000 Name | Type | Description | Notes 1001 ------------- | ------------- | ------------- | ------------- 1002 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1003 **accountId** | **string**| | 1004 **deviceId** | **string**| | 1005 **accountDeviceUpdate** | [**AccountDeviceUpdate**](AccountDeviceUpdate.md)| | 1006 1007 ### Return type 1008 1009 [**DeviceResource**](DeviceResource.md) 1010 1011 ### Authorization 1012 1013 [OAuth2](../README.md#OAuth2) 1014 1015 ### HTTP request headers 1016 1017 - **Content-Type**: application/json 1018 - **Accept**: application/json 1019 1020 [[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) 1021 1022 # **UpdatePagingOnlyGroupUsersAndDevices** 1023 > UpdatePagingOnlyGroupUsersAndDevices(ctx, accountId, pagingOnlyGroupId, optional) 1024 Edit Paging Group Users & Devices 1025 1026 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes paging group users and devices.</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> 1027 1028 ### Required Parameters 1029 1030 Name | Type | Description | Notes 1031 ------------- | ------------- | ------------- | ------------- 1032 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1033 **accountId** | **string**| | 1034 **pagingOnlyGroupId** | **string**| | 1035 **optional** | ***UpdatePagingOnlyGroupUsersAndDevicesOpts** | optional parameters | nil if no parameters 1036 1037 ### Optional Parameters 1038 Optional parameters are passed through a pointer to a UpdatePagingOnlyGroupUsersAndDevicesOpts struct 1039 1040 Name | Type | Description | Notes 1041 ------------- | ------------- | ------------- | ------------- 1042 1043 1044 **editPagingGroupRequest** | [**optional.Interface of EditPagingGroupRequest**](EditPagingGroupRequest.md)| | 1045 1046 ### Return type 1047 1048 (empty response body) 1049 1050 ### Authorization 1051 1052 [OAuth2](../README.md#OAuth2) 1053 1054 ### HTTP request headers 1055 1056 - **Content-Type**: application/json 1057 - **Accept**: Not defined 1058 1059 [[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) 1060 1061 # **UpdateParkLocationUsers** 1062 > UpdateParkLocationUsers(ctx, accountId, parkLocationId, optional) 1063 Adds and/or removes park location users 1064 1065 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes park location users.</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> 1066 1067 ### Required Parameters 1068 1069 Name | Type | Description | Notes 1070 ------------- | ------------- | ------------- | ------------- 1071 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1072 **accountId** | **string**| | 1073 **parkLocationId** | **string**| | 1074 **optional** | ***UpdateParkLocationUsersOpts** | optional parameters | nil if no parameters 1075 1076 ### Optional Parameters 1077 Optional parameters are passed through a pointer to a UpdateParkLocationUsersOpts struct 1078 1079 Name | Type | Description | Notes 1080 ------------- | ------------- | ------------- | ------------- 1081 1082 1083 **editParkLocationRequest** | [**optional.Interface of EditParkLocationRequest**](EditParkLocationRequest.md)| | 1084 1085 ### Return type 1086 1087 (empty response body) 1088 1089 ### Authorization 1090 1091 [OAuth2](../README.md#OAuth2) 1092 1093 ### HTTP request headers 1094 1095 - **Content-Type**: application/json 1096 - **Accept**: Not defined 1097 1098 [[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) 1099