github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/CallHandlingSettingsApi.md (about) 1 # \CallHandlingSettingsApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**BlockNumber**](CallHandlingSettingsApi.md#BlockNumber) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number | Add Blocked Numbers 8 [**CreateAnsweringRuleInfo**](CallHandlingSettingsApi.md#CreateAnsweringRuleInfo) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule | Create Custom Call Handling Rules 9 [**CreateCompanyAnsweringRuleInfo**](CallHandlingSettingsApi.md#CreateCompanyAnsweringRuleInfo) | **Post** /restapi/v1.0/account/{accountId}/answering-rule | Create Company Call Handling Rule 10 [**CreateExtensionForwardingNumber**](CallHandlingSettingsApi.md#CreateExtensionForwardingNumber) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number | Create Forwarding Numbers 11 [**CreateGreeting**](CallHandlingSettingsApi.md#CreateGreeting) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting | Create User Custom Greeting 12 [**CreateIVRMenu**](CallHandlingSettingsApi.md#CreateIVRMenu) | **Post** /restapi/v1.0/account/{accountId}/ivr-menus | Create IVR Menu 13 [**CreatePrompts**](CallHandlingSettingsApi.md#CreatePrompts) | **Post** /restapi/v1.0/account/{accountId}/ivr-prompts | Create IVR Prompt 14 [**DeleteAnsweringRule**](CallHandlingSettingsApi.md#DeleteAnsweringRule) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} | Delete Call Handling Rule 15 [**DeleteExtensionForwardingNumber**](CallHandlingSettingsApi.md#DeleteExtensionForwardingNumber) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} | Delete Forwarding Number 16 [**DeleteIVRPrompt**](CallHandlingSettingsApi.md#DeleteIVRPrompt) | **Delete** /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId} | Delete IVR Prompt 17 [**GetCompanyGreeting**](CallHandlingSettingsApi.md#GetCompanyGreeting) | **Post** /restapi/v1.0/account/{accountId}/greeting | Create Custom Company Greeting 18 [**GetForwardingNumber**](CallHandlingSettingsApi.md#GetForwardingNumber) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} | Get Forwarding Number 19 [**GetGreeting**](CallHandlingSettingsApi.md#GetGreeting) | **Get** /restapi/v1.0/dictionary/greeting/{greetingId} | Get Greeting Info 20 [**GetGreetingByID**](CallHandlingSettingsApi.md#GetGreetingByID) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId} | Get Custom Greeting Info 21 [**GetGreetings**](CallHandlingSettingsApi.md#GetGreetings) | **Get** /restapi/v1.0/dictionary/greeting | Get Standard Greetings 22 [**GetIVRMenuById**](CallHandlingSettingsApi.md#GetIVRMenuById) | **Get** /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId} | Get IVR Menu 23 [**GetIVRPrompt**](CallHandlingSettingsApi.md#GetIVRPrompt) | **Get** /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId} | Get IVR Prompt 24 [**GetIVRPromptContent**](CallHandlingSettingsApi.md#GetIVRPromptContent) | **Get** /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content | Get IVR Prompt Content 25 [**GetIVRPrompts**](CallHandlingSettingsApi.md#GetIVRPrompts) | **Get** /restapi/v1.0/account/{accountId}/ivr-prompts | Get IVR Prompts 26 [**ListBlockedNumbers**](CallHandlingSettingsApi.md#ListBlockedNumbers) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number | Get Blocked Numbers 27 [**ListCompanyAnsweringRule**](CallHandlingSettingsApi.md#ListCompanyAnsweringRule) | **Get** /restapi/v1.0/account/{accountId}/answering-rule | Get Company Call Handling Rules 28 [**ListExtensionForwardingNumbers**](CallHandlingSettingsApi.md#ListExtensionForwardingNumbers) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number | Get Forwarding Numbers 29 [**LoadAnsweringRuleInfo**](CallHandlingSettingsApi.md#LoadAnsweringRuleInfo) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} | Get Call Handling Rule 30 [**LoadAnsweringRulesList**](CallHandlingSettingsApi.md#LoadAnsweringRulesList) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule | Get Call Handling Rules 31 [**LoadBlockedNumber**](CallHandlingSettingsApi.md#LoadBlockedNumber) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId} | Get Blocked Number 32 [**LoadBusinesshoursInfo**](CallHandlingSettingsApi.md#LoadBusinesshoursInfo) | **Get** /restapi/v1.0/account/{accountId}/business-hours | Get Company Business Hours 33 [**LoadCompanyAnsweringRuleInfo**](CallHandlingSettingsApi.md#LoadCompanyAnsweringRuleInfo) | **Get** /restapi/v1.0/account/{accountId}/answering-rule/{ruleId} | Get Company Call Handling Rule 34 [**LoadUserBusinessHours**](CallHandlingSettingsApi.md#LoadUserBusinessHours) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours | Get User Business Hours 35 [**RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut**](CallHandlingSettingsApi.md#RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut) | **Put** /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId} | Update IVR Menu 36 [**UnblockNumber**](CallHandlingSettingsApi.md#UnblockNumber) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId} | Delete Blocked Number 37 [**UpdateAnsweringRuleInfo**](CallHandlingSettingsApi.md#UpdateAnsweringRuleInfo) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} | Update Custom Call Handling Rule 38 [**UpdateBlockedNumber**](CallHandlingSettingsApi.md#UpdateBlockedNumber) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId} | Update Blocked Number 39 [**UpdateCompanyAnsweringRuleInfo**](CallHandlingSettingsApi.md#UpdateCompanyAnsweringRuleInfo) | **Put** /restapi/v1.0/account/{accountId}/answering-rule/{ruleId} | Update Company Call Handling Rule 40 [**UpdateCompanyBusinessHours**](CallHandlingSettingsApi.md#UpdateCompanyBusinessHours) | **Put** /restapi/v1.0/account/{accountId}/business-hours | Update Company Business Hours 41 [**UpdateExtensionForwardingNumber**](CallHandlingSettingsApi.md#UpdateExtensionForwardingNumber) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} | Update Forwarding Numbers 42 [**UpdateUserBusinessHours**](CallHandlingSettingsApi.md#UpdateUserBusinessHours) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours | Update User Business Hours 43 44 45 # **BlockNumber** 46 > BlockedNumberInfo BlockNumber(ctx, accountId, extensionId, optional) 47 Add Blocked Numbers 48 49 <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> 50 51 ### Required Parameters 52 53 Name | Type | Description | Notes 54 ------------- | ------------- | ------------- | ------------- 55 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 56 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 57 **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 ~] 58 **optional** | ***BlockNumberOpts** | optional parameters | nil if no parameters 59 60 ### Optional Parameters 61 Optional parameters are passed through a pointer to a BlockNumberOpts struct 62 63 Name | Type | Description | Notes 64 ------------- | ------------- | ------------- | ------------- 65 66 67 **blockedNumberInfo** | [**optional.Interface of BlockedNumberInfo**](BlockedNumberInfo.md)| | 68 69 ### Return type 70 71 [**BlockedNumberInfo**](BlockedNumberInfo.md) 72 73 ### Authorization 74 75 [OAuth2](../README.md#OAuth2) 76 77 ### HTTP request headers 78 79 - **Content-Type**: application/json 80 - **Accept**: application/json 81 82 [[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) 83 84 # **CreateAnsweringRuleInfo** 85 > AnsweringRuleInfo CreateAnsweringRuleInfo(ctx, accountId, extensionId, createAnsweringRuleRequest) 86 Create Custom Call Handling Rules 87 88 <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Creates a custom answering rule for a particular caller ID.</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> 89 90 ### Required Parameters 91 92 Name | Type | Description | Notes 93 ------------- | ------------- | ------------- | ------------- 94 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 95 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 96 **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 ~] 97 **createAnsweringRuleRequest** | [**CreateAnsweringRuleRequest**](CreateAnsweringRuleRequest.md)| JSON body | 98 99 ### Return type 100 101 [**AnsweringRuleInfo**](AnsweringRuleInfo.md) 102 103 ### Authorization 104 105 [OAuth2](../README.md#OAuth2) 106 107 ### HTTP request headers 108 109 - **Content-Type**: application/json 110 - **Accept**: application/json 111 112 [[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) 113 114 # **CreateCompanyAnsweringRuleInfo** 115 > CompanyAnsweringRuleInfo CreateCompanyAnsweringRuleInfo(ctx, accountId, companyAnsweringRuleRequest) 116 Create Company Call Handling Rule 117 118 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Creates a company answering rule for a particular caller 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><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 user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 119 120 ### Required Parameters 121 122 Name | Type | Description | Notes 123 ------------- | ------------- | ------------- | ------------- 124 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 125 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 126 **companyAnsweringRuleRequest** | [**CompanyAnsweringRuleRequest**](CompanyAnsweringRuleRequest.md)| JSON body | 127 128 ### Return type 129 130 [**CompanyAnsweringRuleInfo**](CompanyAnsweringRuleInfo.md) 131 132 ### Authorization 133 134 [OAuth2](../README.md#OAuth2) 135 136 ### HTTP request headers 137 138 - **Content-Type**: application/json 139 - **Accept**: application/json 140 141 [[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) 142 143 # **CreateExtensionForwardingNumber** 144 > ForwardingNumberInfo CreateExtensionForwardingNumber(ctx, accountId, extensionId, createForwardingNumberRequest) 145 Create Forwarding Numbers 146 147 <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Adds a new forwarding number to the forwarding number list.</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 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> 148 149 ### Required Parameters 150 151 Name | Type | Description | Notes 152 ------------- | ------------- | ------------- | ------------- 153 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 154 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 155 **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 ~] 156 **createForwardingNumberRequest** | [**CreateForwardingNumberRequest**](CreateForwardingNumberRequest.md)| JSON body | 157 158 ### Return type 159 160 [**ForwardingNumberInfo**](ForwardingNumberInfo.md) 161 162 ### Authorization 163 164 [OAuth2](../README.md#OAuth2) 165 166 ### HTTP request headers 167 168 - **Content-Type**: application/json 169 - **Accept**: application/json 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 # **CreateGreeting** 174 > CustomCompanyGreetingInfo CreateGreeting(ctx, accountId, extensionId, optional) 175 Create User Custom Greeting 176 177 ### Required Parameters 178 179 Name | Type | Description | Notes 180 ------------- | ------------- | ------------- | ------------- 181 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 182 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 183 **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 ~] 184 **optional** | ***CreateGreetingOpts** | optional parameters | nil if no parameters 185 186 ### Optional Parameters 187 Optional parameters are passed through a pointer to a CreateGreetingOpts struct 188 189 Name | Type | Description | Notes 190 ------------- | ------------- | ------------- | ------------- 191 192 193 **customGreetingRequest** | [**optional.Interface of CustomGreetingRequest**](CustomGreetingRequest.md)| | 194 195 ### Return type 196 197 [**CustomCompanyGreetingInfo**](CustomCompanyGreetingInfo.md) 198 199 ### Authorization 200 201 [OAuth2](../README.md#OAuth2) 202 203 ### HTTP request headers 204 205 - **Content-Type**: application/json 206 - **Accept**: application/json 207 208 [[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) 209 210 # **CreateIVRMenu** 211 > IvrMenuInfo CreateIVRMenu(ctx, accountId, ivrMenuInfo) 212 Create IVR Menu 213 214 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates a company IVR menu</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>API Group</h4><p>Heavy</p> 215 216 ### Required Parameters 217 218 Name | Type | Description | Notes 219 ------------- | ------------- | ------------- | ------------- 220 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 221 **accountId** | **string**| | 222 **ivrMenuInfo** | [**IvrMenuInfo**](IvrMenuInfo.md)| JSON body | 223 224 ### Return type 225 226 [**IvrMenuInfo**](IVRMenuInfo.md) 227 228 ### Authorization 229 230 [OAuth2](../README.md#OAuth2) 231 232 ### HTTP request headers 233 234 - **Content-Type**: application/json 235 - **Accept**: application/json 236 237 [[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) 238 239 # **CreatePrompts** 240 > PromptInfo CreatePrompts(ctx, accountId, attachment, optional) 241 Create IVR Prompt 242 243 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates an IVR prompt.</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>Heavy</p> 244 245 ### Required Parameters 246 247 Name | Type | Description | Notes 248 ------------- | ------------- | ------------- | ------------- 249 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 250 **accountId** | **string**| | 251 **attachment** | ***os.File*****os.File**| Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported | 252 **optional** | ***CreatePromptsOpts** | optional parameters | nil if no parameters 253 254 ### Optional Parameters 255 Optional parameters are passed through a pointer to a CreatePromptsOpts struct 256 257 Name | Type | Description | Notes 258 ------------- | ------------- | ------------- | ------------- 259 260 261 **name** | **optional.String**| Description of file contents. | 262 263 ### Return type 264 265 [**PromptInfo**](PromptInfo.md) 266 267 ### Authorization 268 269 [OAuth2](../README.md#OAuth2) 270 271 ### HTTP request headers 272 273 - **Content-Type**: multipart/form-data 274 - **Accept**: application/json 275 276 [[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) 277 278 # **DeleteAnsweringRule** 279 > DeleteAnsweringRule(ctx, accountId, extensionId, ruleId) 280 Delete Call Handling Rule 281 282 ### Required Parameters 283 284 Name | Type | Description | Notes 285 ------------- | ------------- | ------------- | ------------- 286 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 287 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 288 **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 ~] 289 **ruleId** | **string**| Internal identifier of an answering rule | 290 291 ### Return type 292 293 (empty response body) 294 295 ### Authorization 296 297 [OAuth2](../README.md#OAuth2) 298 299 ### HTTP request headers 300 301 - **Content-Type**: Not defined 302 - **Accept**: Not defined 303 304 [[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) 305 306 # **DeleteExtensionForwardingNumber** 307 > DeleteExtensionForwardingNumber(ctx, accountId, extensionId, forwardingNumberId) 308 Delete Forwarding Number 309 310 <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Deletes a forwarding number from the forwarding number list 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'>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> 311 312 ### Required Parameters 313 314 Name | Type | Description | Notes 315 ------------- | ------------- | ------------- | ------------- 316 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 317 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 318 **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 ~] 319 **forwardingNumberId** | **string**| Internal identifier of a forwarding number | 320 321 ### Return type 322 323 (empty response body) 324 325 ### Authorization 326 327 [OAuth2](../README.md#OAuth2) 328 329 ### HTTP request headers 330 331 - **Content-Type**: Not defined 332 - **Accept**: Not defined 333 334 [[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) 335 336 # **DeleteIVRPrompt** 337 > DeleteIVRPrompt(ctx, accountId, promptId) 338 Delete IVR Prompt 339 340 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Deletes an IVR prompt by ID</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 user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p> 341 342 ### Required Parameters 343 344 Name | Type | Description | Notes 345 ------------- | ------------- | ------------- | ------------- 346 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 347 **accountId** | **string**| | 348 **promptId** | **string**| | 349 350 ### Return type 351 352 (empty response body) 353 354 ### Authorization 355 356 [OAuth2](../README.md#OAuth2) 357 358 ### HTTP request headers 359 360 - **Content-Type**: Not defined 361 - **Accept**: Not defined 362 363 [[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) 364 365 # **GetCompanyGreeting** 366 > CustomCompanyGreetingInfo GetCompanyGreeting(ctx, accountId, customCompanyGreetingRequest) 367 Create Custom Company Greeting 368 369 ### Required Parameters 370 371 Name | Type | Description | Notes 372 ------------- | ------------- | ------------- | ------------- 373 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 374 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 375 **customCompanyGreetingRequest** | [**CustomCompanyGreetingRequest**](CustomCompanyGreetingRequest.md)| JSON body | 376 377 ### Return type 378 379 [**CustomCompanyGreetingInfo**](CustomCompanyGreetingInfo.md) 380 381 ### Authorization 382 383 [OAuth2](../README.md#OAuth2) 384 385 ### HTTP request headers 386 387 - **Content-Type**: application/json 388 - **Accept**: application/json 389 390 [[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) 391 392 # **GetForwardingNumber** 393 > ForwardingNumberResource GetForwardingNumber(ctx, forwardingNumberId, extensionId, accountId) 394 Get Forwarding Number 395 396 ### Required Parameters 397 398 Name | Type | Description | Notes 399 ------------- | ------------- | ------------- | ------------- 400 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 401 **forwardingNumberId** | **string**| | 402 **extensionId** | **string**| | 403 **accountId** | **string**| | 404 405 ### Return type 406 407 [**ForwardingNumberResource**](ForwardingNumberResource.md) 408 409 ### Authorization 410 411 [OAuth2](../README.md#OAuth2) 412 413 ### HTTP request headers 414 415 - **Content-Type**: Not defined 416 - **Accept**: application/json 417 418 [[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) 419 420 # **GetGreeting** 421 > DictionaryGreetingInfo GetGreeting(ctx, greetingId) 422 Get Greeting Info 423 424 <p style='font-style:italic;'>Since 8.2 (Release 1.0.26)</p><p>Returns a standard greeting by 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>View Greetings</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 425 426 ### Required Parameters 427 428 Name | Type | Description | Notes 429 ------------- | ------------- | ------------- | ------------- 430 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 431 **greetingId** | **string**| | 432 433 ### Return type 434 435 [**DictionaryGreetingInfo**](DictionaryGreetingInfo.md) 436 437 ### Authorization 438 439 [OAuth2](../README.md#OAuth2) 440 441 ### HTTP request headers 442 443 - **Content-Type**: Not defined 444 - **Accept**: application/json 445 446 [[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) 447 448 # **GetGreetingByID** 449 > CustomCompanyGreetingInfo GetGreetingByID(ctx, accountId, extensionId, greetingId) 450 Get Custom Greeting Info 451 452 ### Required Parameters 453 454 Name | Type | Description | Notes 455 ------------- | ------------- | ------------- | ------------- 456 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 457 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 458 **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 ~] 459 **greetingId** | **int32**| | 460 461 ### Return type 462 463 [**CustomCompanyGreetingInfo**](CustomCompanyGreetingInfo.md) 464 465 ### Authorization 466 467 [OAuth2](../README.md#OAuth2) 468 469 ### HTTP request headers 470 471 - **Content-Type**: Not defined 472 - **Accept**: application/json 473 474 [[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) 475 476 # **GetGreetings** 477 > DictionaryGreetingList GetGreetings(ctx, optional) 478 Get Standard Greetings 479 480 <p style='font-style:italic;'>Since 8.2 (Release 1.0.26)</p><p>Returns a list of predefined standard greetings. Please note: Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings.</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>View Greetings</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 481 482 ### Required Parameters 483 484 Name | Type | Description | Notes 485 ------------- | ------------- | ------------- | ------------- 486 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 487 **optional** | ***GetGreetingsOpts** | optional parameters | nil if no parameters 488 489 ### Optional Parameters 490 Optional parameters are passed through a pointer to a GetGreetingsOpts struct 491 492 Name | Type | Description | Notes 493 ------------- | ------------- | ------------- | ------------- 494 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 495 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 496 **type_** | **optional.String**| Type of a greeting, specifying the case when the greeting is played | 497 **usageType** | **optional.String**| Usage type of a greeting, specifying if the greeting is applied for user extension or department extension | 498 499 ### Return type 500 501 [**DictionaryGreetingList**](DictionaryGreetingList.md) 502 503 ### Authorization 504 505 [OAuth2](../README.md#OAuth2) 506 507 ### HTTP request headers 508 509 - **Content-Type**: Not defined 510 - **Accept**: application/json 511 512 [[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) 513 514 # **GetIVRMenuById** 515 > IvrMenuInfo GetIVRMenuById(ctx, accountId, ivrMenuId) 516 Get IVR Menu 517 518 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a company IVR menu by 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>Medium</p> 519 520 ### Required Parameters 521 522 Name | Type | Description | Notes 523 ------------- | ------------- | ------------- | ------------- 524 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 525 **accountId** | **string**| | 526 **ivrMenuId** | **string**| | 527 528 ### Return type 529 530 [**IvrMenuInfo**](IVRMenuInfo.md) 531 532 ### Authorization 533 534 [OAuth2](../README.md#OAuth2) 535 536 ### HTTP request headers 537 538 - **Content-Type**: Not defined 539 - **Accept**: application/json 540 541 [[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) 542 543 # **GetIVRPrompt** 544 > PromptInfo GetIVRPrompt(ctx, accountId, promptId) 545 Get IVR Prompt 546 547 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns an IVR prompt by 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>Medium</p> 548 549 ### Required Parameters 550 551 Name | Type | Description | Notes 552 ------------- | ------------- | ------------- | ------------- 553 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 554 **accountId** | **string**| | 555 **promptId** | **string**| | 556 557 ### Return type 558 559 [**PromptInfo**](PromptInfo.md) 560 561 ### Authorization 562 563 [OAuth2](../README.md#OAuth2) 564 565 ### HTTP request headers 566 567 - **Content-Type**: Not defined 568 - **Accept**: application/json 569 570 [[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) 571 572 # **GetIVRPromptContent** 573 > GetIVRPromptContent(ctx, accountId, promptId) 574 Get IVR Prompt Content 575 576 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns media content of an IVR prompt 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>Medium</p> 577 578 ### Required Parameters 579 580 Name | Type | Description | Notes 581 ------------- | ------------- | ------------- | ------------- 582 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 583 **accountId** | **string**| | 584 **promptId** | **string**| | 585 586 ### Return type 587 588 (empty response body) 589 590 ### Authorization 591 592 [OAuth2](../README.md#OAuth2) 593 594 ### HTTP request headers 595 596 - **Content-Type**: Not defined 597 - **Accept**: Not defined 598 599 [[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) 600 601 # **GetIVRPrompts** 602 > IvrPrompts GetIVRPrompts(ctx, accountId) 603 Get IVR Prompts 604 605 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a list of IVR prompts.</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> 606 607 ### Required Parameters 608 609 Name | Type | Description | Notes 610 ------------- | ------------- | ------------- | ------------- 611 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 612 **accountId** | **string**| | 613 614 ### Return type 615 616 [**IvrPrompts**](IVRPrompts.md) 617 618 ### Authorization 619 620 [OAuth2](../README.md#OAuth2) 621 622 ### HTTP request headers 623 624 - **Content-Type**: Not defined 625 - **Accept**: application/json 626 627 [[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) 628 629 # **ListBlockedNumbers** 630 > BlockedNumbersList ListBlockedNumbers(ctx, accountId, extensionId) 631 Get Blocked Numbers 632 633 <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> 634 635 ### Required Parameters 636 637 Name | Type | Description | Notes 638 ------------- | ------------- | ------------- | ------------- 639 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 640 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 641 **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 ~] 642 643 ### Return type 644 645 [**BlockedNumbersList**](BlockedNumbersList.md) 646 647 ### Authorization 648 649 [OAuth2](../README.md#OAuth2) 650 651 ### HTTP request headers 652 653 - **Content-Type**: Not defined 654 - **Accept**: application/json 655 656 [[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) 657 658 # **ListCompanyAnsweringRule** 659 > CompanyAnsweringRuleList ListCompanyAnsweringRule(ctx, accountId) 660 Get Company Call Handling Rules 661 662 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a list of company answering rules.</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> 663 664 ### Required Parameters 665 666 Name | Type | Description | Notes 667 ------------- | ------------- | ------------- | ------------- 668 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 669 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 670 671 ### Return type 672 673 [**CompanyAnsweringRuleList**](CompanyAnsweringRuleList.md) 674 675 ### Authorization 676 677 [OAuth2](../README.md#OAuth2) 678 679 ### HTTP request headers 680 681 - **Content-Type**: Not defined 682 - **Accept**: application/json 683 684 [[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) 685 686 # **ListExtensionForwardingNumbers** 687 > GetExtensionForwardingNumberListResponse ListExtensionForwardingNumbers(ctx, accountId, extensionId, optional) 688 Get Forwarding Numbers 689 690 <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers that are used for call forwarding and call flip.</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> 691 692 ### Required Parameters 693 694 Name | Type | Description | Notes 695 ------------- | ------------- | ------------- | ------------- 696 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 697 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 698 **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 ~] 699 **optional** | ***ListExtensionForwardingNumbersOpts** | optional parameters | nil if no parameters 700 701 ### Optional Parameters 702 Optional parameters are passed through a pointer to a ListExtensionForwardingNumbersOpts struct 703 704 Name | Type | Description | Notes 705 ------------- | ------------- | ------------- | ------------- 706 707 708 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 709 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 710 711 ### Return type 712 713 [**GetExtensionForwardingNumberListResponse**](GetExtensionForwardingNumberListResponse.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 # **LoadAnsweringRuleInfo** 727 > AnsweringRuleInfo LoadAnsweringRuleInfo(ctx, accountId, extensionId, ruleId) 728 Get Call Handling Rule 729 730 <p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns an answering rule by 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>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 **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 ~] 739 **ruleId** | **string**| Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule | 740 741 ### Return type 742 743 [**AnsweringRuleInfo**](AnsweringRuleInfo.md) 744 745 ### Authorization 746 747 [OAuth2](../README.md#OAuth2) 748 749 ### HTTP request headers 750 751 - **Content-Type**: Not defined 752 - **Accept**: application/json 753 754 [[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) 755 756 # **LoadAnsweringRulesList** 757 > LoadAnsweringRulesList(ctx, accountId, extensionId, optional) 758 Get Call Handling Rules 759 760 <p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns the extension answering rules.</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> 761 762 ### Required Parameters 763 764 Name | Type | Description | Notes 765 ------------- | ------------- | ------------- | ------------- 766 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 767 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 768 **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 ~] 769 **optional** | ***LoadAnsweringRulesListOpts** | optional parameters | nil if no parameters 770 771 ### Optional Parameters 772 Optional parameters are passed through a pointer to a LoadAnsweringRulesListOpts struct 773 774 Name | Type | Description | Notes 775 ------------- | ------------- | ------------- | ------------- 776 777 778 **page** | **optional.String**| | [default to 1] 779 **perPage** | **optional.String**| | [default to 100] 780 781 ### Return type 782 783 (empty response body) 784 785 ### Authorization 786 787 [OAuth2](../README.md#OAuth2) 788 789 ### HTTP request headers 790 791 - **Content-Type**: Not defined 792 - **Accept**: Not defined 793 794 [[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) 795 796 # **LoadBlockedNumber** 797 > BlockedNumberInfo LoadBlockedNumber(ctx, accountId, extensionId, blockedNumberId) 798 Get Blocked Number 799 800 <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> 801 802 ### Required Parameters 803 804 Name | Type | Description | Notes 805 ------------- | ------------- | ------------- | ------------- 806 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 807 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 808 **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 ~] 809 **blockedNumberId** | **int32**| Internal identifiers of a blocked number list entry | 810 811 ### Return type 812 813 [**BlockedNumberInfo**](BlockedNumberInfo.md) 814 815 ### Authorization 816 817 [OAuth2](../README.md#OAuth2) 818 819 ### HTTP request headers 820 821 - **Content-Type**: Not defined 822 - **Accept**: application/json 823 824 [[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) 825 826 # **LoadBusinesshoursInfo** 827 > CompanyBusinessHours LoadBusinesshoursInfo(ctx, accountId) 828 Get Company Business Hours 829 830 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns company hours when answering rules are to 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'>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> 831 832 ### Required Parameters 833 834 Name | Type | Description | Notes 835 ------------- | ------------- | ------------- | ------------- 836 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 837 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 838 839 ### Return type 840 841 [**CompanyBusinessHours**](CompanyBusinessHours.md) 842 843 ### Authorization 844 845 [OAuth2](../README.md#OAuth2) 846 847 ### HTTP request headers 848 849 - **Content-Type**: Not defined 850 - **Accept**: application/json 851 852 [[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) 853 854 # **LoadCompanyAnsweringRuleInfo** 855 > CompanyAnsweringRuleInfo LoadCompanyAnsweringRuleInfo(ctx, accountId, ruleId) 856 Get Company Call Handling Rule 857 858 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a company answering rule by 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> 859 860 ### Required Parameters 861 862 Name | Type | Description | Notes 863 ------------- | ------------- | ------------- | ------------- 864 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 865 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 866 **ruleId** | **string**| Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule | 867 868 ### Return type 869 870 [**CompanyAnsweringRuleInfo**](CompanyAnsweringRuleInfo.md) 871 872 ### Authorization 873 874 [OAuth2](../README.md#OAuth2) 875 876 ### HTTP request headers 877 878 - **Content-Type**: Not defined 879 - **Accept**: application/json 880 881 [[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) 882 883 # **LoadUserBusinessHours** 884 > GetUserBusinessHoursResponse LoadUserBusinessHours(ctx, accountId, extensionId) 885 Get User Business Hours 886 887 <p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns the extension user hours when answering rules are to be applied.</p><h4>Usage Plan Group</h4><p>Light</p> 888 889 ### Required Parameters 890 891 Name | Type | Description | Notes 892 ------------- | ------------- | ------------- | ------------- 893 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 894 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 895 **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 ~] 896 897 ### Return type 898 899 [**GetUserBusinessHoursResponse**](GetUserBusinessHoursResponse.md) 900 901 ### Authorization 902 903 [OAuth2](../README.md#OAuth2) 904 905 ### HTTP request headers 906 907 - **Content-Type**: Not defined 908 - **Accept**: application/json 909 910 [[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) 911 912 # **RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut** 913 > IvrMenuInfo RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut(ctx, accountId, ivrMenuId, ivrMenuInfo) 914 Update IVR Menu 915 916 <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a company IVR menu by 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>Medium</p> 917 918 ### Required Parameters 919 920 Name | Type | Description | Notes 921 ------------- | ------------- | ------------- | ------------- 922 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 923 **accountId** | **string**| | 924 **ivrMenuId** | **string**| | 925 **ivrMenuInfo** | [**IvrMenuInfo**](IvrMenuInfo.md)| JSON body | 926 927 ### Return type 928 929 [**IvrMenuInfo**](IVRMenuInfo.md) 930 931 ### Authorization 932 933 [OAuth2](../README.md#OAuth2) 934 935 ### HTTP request headers 936 937 - **Content-Type**: application/json 938 - **Accept**: application/json 939 940 [[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) 941 942 # **UnblockNumber** 943 > UnblockNumber(ctx, accountId, extensionId, blockedNumberId) 944 Delete Blocked Number 945 946 <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> 947 948 ### Required Parameters 949 950 Name | Type | Description | Notes 951 ------------- | ------------- | ------------- | ------------- 952 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 953 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 954 **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 ~] 955 **blockedNumberId** | **int32**| Internal identifiers of a blocked number list entry | 956 957 ### Return type 958 959 (empty response body) 960 961 ### Authorization 962 963 [OAuth2](../README.md#OAuth2) 964 965 ### HTTP request headers 966 967 - **Content-Type**: Not defined 968 - **Accept**: Not defined 969 970 [[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) 971 972 # **UpdateAnsweringRuleInfo** 973 > AnsweringRuleInfo UpdateAnsweringRuleInfo(ctx, accountId, extensionId, ruleId, updateAnsweringRuleRequest) 974 Update Custom Call Handling Rule 975 976 <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates a custom answering rule for a particular caller ID.</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> 977 978 ### Required Parameters 979 980 Name | Type | Description | Notes 981 ------------- | ------------- | ------------- | ------------- 982 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 983 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 984 **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 ~] 985 **ruleId** | **string**| Internal identifier of an answering rule | 986 **updateAnsweringRuleRequest** | [**UpdateAnsweringRuleRequest**](UpdateAnsweringRuleRequest.md)| JSON body | 987 988 ### Return type 989 990 [**AnsweringRuleInfo**](AnsweringRuleInfo.md) 991 992 ### Authorization 993 994 [OAuth2](../README.md#OAuth2) 995 996 ### HTTP request headers 997 998 - **Content-Type**: application/json 999 - **Accept**: application/json 1000 1001 [[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) 1002 1003 # **UpdateBlockedNumber** 1004 > BlockedNumberInfo UpdateBlockedNumber(ctx, accountId, extensionId, blockedNumberId, optional) 1005 Update Blocked Number 1006 1007 <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> 1008 1009 ### Required Parameters 1010 1011 Name | Type | Description | Notes 1012 ------------- | ------------- | ------------- | ------------- 1013 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1014 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 1015 **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 ~] 1016 **blockedNumberId** | **int32**| Internal identifier of a blocked number list entry | 1017 **optional** | ***UpdateBlockedNumberOpts** | optional parameters | nil if no parameters 1018 1019 ### Optional Parameters 1020 Optional parameters are passed through a pointer to a UpdateBlockedNumberOpts struct 1021 1022 Name | Type | Description | Notes 1023 ------------- | ------------- | ------------- | ------------- 1024 1025 1026 1027 **blockedNumberInfo** | [**optional.Interface of BlockedNumberInfo**](BlockedNumberInfo.md)| | 1028 1029 ### Return type 1030 1031 [**BlockedNumberInfo**](BlockedNumberInfo.md) 1032 1033 ### Authorization 1034 1035 [OAuth2](../README.md#OAuth2) 1036 1037 ### HTTP request headers 1038 1039 - **Content-Type**: application/json 1040 - **Accept**: application/json 1041 1042 [[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) 1043 1044 # **UpdateCompanyAnsweringRuleInfo** 1045 > CompanyAnsweringRuleInfo UpdateCompanyAnsweringRuleInfo(ctx, accountId, ruleId, companyAnsweringRuleUpdate) 1046 Update Company Call Handling Rule 1047 1048 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Updates a company answering rule.</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> 1049 1050 ### Required Parameters 1051 1052 Name | Type | Description | Notes 1053 ------------- | ------------- | ------------- | ------------- 1054 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1055 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 1056 **ruleId** | **string**| Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule | 1057 **companyAnsweringRuleUpdate** | [**CompanyAnsweringRuleUpdate**](CompanyAnsweringRuleUpdate.md)| JSON body | 1058 1059 ### Return type 1060 1061 [**CompanyAnsweringRuleInfo**](CompanyAnsweringRuleInfo.md) 1062 1063 ### Authorization 1064 1065 [OAuth2](../README.md#OAuth2) 1066 1067 ### HTTP request headers 1068 1069 - **Content-Type**: application/json 1070 - **Accept**: application/json 1071 1072 [[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) 1073 1074 # **UpdateCompanyBusinessHours** 1075 > CompanyBusinessHours UpdateCompanyBusinessHours(ctx, accountId, companyBusinessHoursUpdateRequest) 1076 Update Company Business Hours 1077 1078 <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates company hours when answering rules are to 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>Usage Plan Group</h4><p>Medium</p> 1079 1080 ### Required Parameters 1081 1082 Name | Type | Description | Notes 1083 ------------- | ------------- | ------------- | ------------- 1084 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1085 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 1086 **companyBusinessHoursUpdateRequest** | [**CompanyBusinessHoursUpdateRequest**](CompanyBusinessHoursUpdateRequest.md)| JSON body | 1087 1088 ### Return type 1089 1090 [**CompanyBusinessHours**](CompanyBusinessHours.md) 1091 1092 ### Authorization 1093 1094 [OAuth2](../README.md#OAuth2) 1095 1096 ### HTTP request headers 1097 1098 - **Content-Type**: application/json 1099 - **Accept**: application/json 1100 1101 [[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) 1102 1103 # **UpdateExtensionForwardingNumber** 1104 > ForwardingNumberInfo UpdateExtensionForwardingNumber(ctx, accountId, extensionId, forwardingNumberId, updateForwardingNumberRequest) 1105 Update Forwarding Numbers 1106 1107 <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates an existent forwarding number from the forwarding number list.</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 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> 1108 1109 ### Required Parameters 1110 1111 Name | Type | Description | Notes 1112 ------------- | ------------- | ------------- | ------------- 1113 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1114 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 1115 **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 ~] 1116 **forwardingNumberId** | **string**| Internal identifier of a forwarding number; returned in response in the id field | 1117 **updateForwardingNumberRequest** | [**UpdateForwardingNumberRequest**](UpdateForwardingNumberRequest.md)| JSON body | 1118 1119 ### Return type 1120 1121 [**ForwardingNumberInfo**](ForwardingNumberInfo.md) 1122 1123 ### Authorization 1124 1125 [OAuth2](../README.md#OAuth2) 1126 1127 ### HTTP request headers 1128 1129 - **Content-Type**: application/json 1130 - **Accept**: application/json 1131 1132 [[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) 1133 1134 # **UpdateUserBusinessHours** 1135 > UserBusinessHoursUpdate UpdateUserBusinessHours(ctx, accountId, extensionId, userBusinessHoursUpdateRequest) 1136 Update User Business Hours 1137 1138 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates the extension user hours when answering rules are to 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 user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 1139 1140 ### Required Parameters 1141 1142 Name | Type | Description | Notes 1143 ------------- | ------------- | ------------- | ------------- 1144 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1145 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 1146 **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 ~] 1147 **userBusinessHoursUpdateRequest** | [**UserBusinessHoursUpdateRequest**](UserBusinessHoursUpdateRequest.md)| JSON body | 1148 1149 ### Return type 1150 1151 [**UserBusinessHoursUpdate**](UserBusinessHoursUpdate.md) 1152 1153 ### Authorization 1154 1155 [OAuth2](../README.md#OAuth2) 1156 1157 ### HTTP request headers 1158 1159 - **Content-Type**: application/json 1160 - **Accept**: application/json 1161 1162 [[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) 1163