CallHandlingSettingsApi.md

\CallHandlingSettingsApi

All URIs are relative to https://platform.devtest.ringcentral.com

Method	HTTP request	Description
BlockNumber	Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number	Add Blocked Numbers
CreateAnsweringRuleInfo	Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule	Create Custom Call Handling Rules
CreateCompanyAnsweringRuleInfo	Post /restapi/v1.0/account/{accountId}/answering-rule	Create Company Call Handling Rule
CreateExtensionForwardingNumber	Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number	Create Forwarding Numbers
CreateGreeting	Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting	Create User Custom Greeting
CreateIVRMenu	Post /restapi/v1.0/account/{accountId}/ivr-menus	Create IVR Menu
CreatePrompts	Post /restapi/v1.0/account/{accountId}/ivr-prompts	Create IVR Prompt
DeleteAnsweringRule	Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}	Delete Call Handling Rule
DeleteExtensionForwardingNumber	Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}	Delete Forwarding Number
DeleteIVRPrompt	Delete /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}	Delete IVR Prompt
GetCompanyGreeting	Post /restapi/v1.0/account/{accountId}/greeting	Create Custom Company Greeting
GetForwardingNumber	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}	Get Forwarding Number
GetGreeting	Get /restapi/v1.0/dictionary/greeting/{greetingId}	Get Greeting Info
GetGreetingByID	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}	Get Custom Greeting Info
GetGreetings	Get /restapi/v1.0/dictionary/greeting	Get Standard Greetings
GetIVRMenuById	Get /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}	Get IVR Menu
GetIVRPrompt	Get /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}	Get IVR Prompt
GetIVRPromptContent	Get /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content	Get IVR Prompt Content
GetIVRPrompts	Get /restapi/v1.0/account/{accountId}/ivr-prompts	Get IVR Prompts
ListBlockedNumbers	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number	Get Blocked Numbers
ListCompanyAnsweringRule	Get /restapi/v1.0/account/{accountId}/answering-rule	Get Company Call Handling Rules
ListExtensionForwardingNumbers	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number	Get Forwarding Numbers
LoadAnsweringRuleInfo	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}	Get Call Handling Rule
LoadAnsweringRulesList	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule	Get Call Handling Rules
LoadBlockedNumber	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}	Get Blocked Number
LoadBusinesshoursInfo	Get /restapi/v1.0/account/{accountId}/business-hours	Get Company Business Hours
LoadCompanyAnsweringRuleInfo	Get /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}	Get Company Call Handling Rule
LoadUserBusinessHours	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours	Get User Business Hours
RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut	Put /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}	Update IVR Menu
UnblockNumber	Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}	Delete Blocked Number
UpdateAnsweringRuleInfo	Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}	Update Custom Call Handling Rule
UpdateBlockedNumber	Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}	Update Blocked Number
UpdateCompanyAnsweringRuleInfo	Put /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}	Update Company Call Handling Rule
UpdateCompanyBusinessHours	Put /restapi/v1.0/account/{accountId}/business-hours	Update Company Business Hours
UpdateExtensionForwardingNumber	Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}	Update Forwarding Numbers
UpdateUserBusinessHours	Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours	Update User Business Hours

BlockNumber

BlockedNumberInfo BlockNumber(ctx, accountId, extensionId, optional) Add Blocked Numbers

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
optional	*BlockNumberOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BlockNumberOpts struct

Name	Type	Description	Notes

blockedNumberInfo | optional.Interface of BlockedNumberInfo| |

Return type

BlockedNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAnsweringRuleInfo

AnsweringRuleInfo CreateAnsweringRuleInfo(ctx, accountId, extensionId, createAnsweringRuleRequest) Create Custom Call Handling Rules

Since 1.0.24 (Release 8.0)

Creates a custom answering rule for a particular caller ID.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
createAnsweringRuleRequest	CreateAnsweringRuleRequest	JSON body

Return type

AnsweringRuleInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCompanyAnsweringRuleInfo

CompanyAnsweringRuleInfo CreateCompanyAnsweringRuleInfo(ctx, accountId, companyAnsweringRuleRequest) Create Company Call Handling Rule

Since 1.0.31 (Release 9.2)

Creates a company answering rule for a particular caller ID.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)
EditAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
companyAnsweringRuleRequest	CompanyAnsweringRuleRequest	JSON body

Return type

CompanyAnsweringRuleInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateExtensionForwardingNumber

ForwardingNumberInfo CreateExtensionForwardingNumber(ctx, accountId, extensionId, createForwardingNumberRequest) Create Forwarding Numbers

Since 1.0.12 (Release 6.4)

Adds a new forwarding number to the forwarding number list.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
createForwardingNumberRequest	CreateForwardingNumberRequest	JSON body

Return type

ForwardingNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateGreeting

CustomCompanyGreetingInfo CreateGreeting(ctx, accountId, extensionId, optional) Create User Custom Greeting

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
optional	*CreateGreetingOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateGreetingOpts struct

Name	Type	Description	Notes

customGreetingRequest | optional.Interface of CustomGreetingRequest| |

Return type

CustomCompanyGreetingInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateIVRMenu

IvrMenuInfo CreateIVRMenu(ctx, accountId, ivrMenuInfo) Create IVR Menu

Since 1.0.32 (Release 9.3)

Creates a company IVR menu

Required Permissions

Permission	Description
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)

API Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
ivrMenuInfo	IvrMenuInfo	JSON body

Return type

IvrMenuInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreatePrompts

PromptInfo CreatePrompts(ctx, accountId, attachment, optional) Create IVR Prompt

Since 1.0.32 (Release 9.3)

Creates an IVR prompt.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
attachment	os.Fileos.File	Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported
optional	*CreatePromptsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreatePromptsOpts struct

Name	Type	Description	Notes

name | optional.String| Description of file contents. |

Return type

PromptInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAnsweringRule

DeleteAnsweringRule(ctx, accountId, extensionId, ruleId) Delete Call Handling Rule

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
ruleId	string	Internal identifier of an answering rule

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteExtensionForwardingNumber

DeleteExtensionForwardingNumber(ctx, accountId, extensionId, forwardingNumberId) Delete Forwarding Number

Since 1.0.24 (Release 8.0)

Deletes a forwarding number from the forwarding number list by its ID.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
forwardingNumberId	string	Internal identifier of a forwarding number

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteIVRPrompt

DeleteIVRPrompt(ctx, accountId, promptId) Delete IVR Prompt

Since 1.0.32 (Release 9.3)

Deletes an IVR prompt by ID

Required Permissions

Permission	Description
EditAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
promptId	string

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCompanyGreeting

CustomCompanyGreetingInfo GetCompanyGreeting(ctx, accountId, customCompanyGreetingRequest) Create Custom Company Greeting

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
customCompanyGreetingRequest	CustomCompanyGreetingRequest	JSON body

Return type

CustomCompanyGreetingInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetForwardingNumber

ForwardingNumberResource GetForwardingNumber(ctx, forwardingNumberId, extensionId, accountId) Get Forwarding Number

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
forwardingNumberId	string
extensionId	string
accountId	string

Return type

ForwardingNumberResource

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGreeting

DictionaryGreetingInfo GetGreeting(ctx, greetingId) Get Greeting Info

Since 8.2 (Release 1.0.26)

Returns a standard greeting by ID

Required Permissions

Permission	Description
ReadAccounts	View Greetings

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
greetingId	string

Return type

DictionaryGreetingInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGreetingByID

CustomCompanyGreetingInfo GetGreetingByID(ctx, accountId, extensionId, greetingId) Get Custom Greeting Info

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
greetingId	int32

Return type

CustomCompanyGreetingInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGreetings

DictionaryGreetingList GetGreetings(ctx, optional) Get Standard Greetings

Since 8.2 (Release 1.0.26)

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.

Required Permissions

Permission	Description
ReadAccounts	View Greetings

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetGreetingsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetGreetingsOpts struct

Name	Type	Description	Notes
page	optional.Int32	Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
perPage	optional.Int32	Indicates the page size (number of items). If not specified, the value is '100' by default
type_	optional.String	Type of a greeting, specifying the case when the greeting is played
usageType	optional.String	Usage type of a greeting, specifying if the greeting is applied for user extension or department extension

Return type

DictionaryGreetingList

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIVRMenuById

IvrMenuInfo GetIVRMenuById(ctx, accountId, ivrMenuId) Get IVR Menu

Since 1.0.32 (Release 9.3)

Returns a company IVR menu by ID

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
ivrMenuId	string

Return type

IvrMenuInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIVRPrompt

PromptInfo GetIVRPrompt(ctx, accountId, promptId) Get IVR Prompt

Since 1.0.32 (Release 9.3)

Returns an IVR prompt by ID

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
promptId	string

Return type

PromptInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIVRPromptContent

GetIVRPromptContent(ctx, accountId, promptId) Get IVR Prompt Content

Since 1.0.32 (Release 9.3)

Returns media content of an IVR prompt by its ID

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
promptId	string

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIVRPrompts

IvrPrompts GetIVRPrompts(ctx, accountId) Get IVR Prompts

Since 1.0.32 (Release 9.3)

Returns a list of IVR prompts.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string

Return type

IvrPrompts

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBlockedNumbers

BlockedNumbersList ListBlockedNumbers(ctx, accountId, extensionId) Get Blocked Numbers

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]

Return type

BlockedNumbersList

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCompanyAnsweringRule

CompanyAnsweringRuleList ListCompanyAnsweringRule(ctx, accountId) Get Company Call Handling Rules

Since 1.0.31 (Release 9.2)

Returns a list of company answering rules.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]

Return type

CompanyAnsweringRuleList

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListExtensionForwardingNumbers

GetExtensionForwardingNumberListResponse ListExtensionForwardingNumbers(ctx, accountId, extensionId, optional) Get Forwarding Numbers

Since 1.0.7 (Release 5.16)

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.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
optional	*ListExtensionForwardingNumbersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListExtensionForwardingNumbersOpts struct

Name	Type	Description	Notes

page | optional.Int32| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | perPage | optional.Int32| Indicates the page size (number of items). If not specified, the value is '100' by default |

Return type

GetExtensionForwardingNumberListResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadAnsweringRuleInfo

AnsweringRuleInfo LoadAnsweringRuleInfo(ctx, accountId, extensionId, ruleId) Get Call Handling Rule

Since 1.0.15 (Release 7.0)

Returns an answering rule by ID.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
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

Return type

AnsweringRuleInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadAnsweringRulesList

LoadAnsweringRulesList(ctx, accountId, extensionId, optional) Get Call Handling Rules

Since 1.0.15 (Release 7.0)

Returns the extension answering rules.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
optional	*LoadAnsweringRulesListOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a LoadAnsweringRulesListOpts struct

Name	Type	Description	Notes

page | optional.String| | [default to 1] perPage | optional.String| | [default to 100]

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadBlockedNumber

BlockedNumberInfo LoadBlockedNumber(ctx, accountId, extensionId, blockedNumberId) Get Blocked Number

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
blockedNumberId	int32	Internal identifiers of a blocked number list entry

Return type

BlockedNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadBusinesshoursInfo

CompanyBusinessHours LoadBusinesshoursInfo(ctx, accountId) Get Company Business Hours

Since 1.0.32 (Release 9.3)

Returns company hours when answering rules are to be applied.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]

Return type

CompanyBusinessHours

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadCompanyAnsweringRuleInfo

CompanyAnsweringRuleInfo LoadCompanyAnsweringRuleInfo(ctx, accountId, ruleId) Get Company Call Handling Rule

Since 1.0.31 (Release 9.2)

Returns a company answering rule by ID.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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

Return type

CompanyAnsweringRuleInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadUserBusinessHours

GetUserBusinessHoursResponse LoadUserBusinessHours(ctx, accountId, extensionId) Get User Business Hours

Since 1.0.15 (Release 7.0)

Returns the extension user hours when answering rules are to be applied.

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]

Return type

GetUserBusinessHoursResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut

IvrMenuInfo RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut(ctx, accountId, ivrMenuId, ivrMenuInfo) Update IVR Menu

Since 1.0.32 (Release 9.3)

Returns a company IVR menu by ID

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
ivrMenuId	string
ivrMenuInfo	IvrMenuInfo	JSON body

Return type

IvrMenuInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnblockNumber

UnblockNumber(ctx, accountId, extensionId, blockedNumberId) Delete Blocked Number

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
blockedNumberId	int32	Internal identifiers of a blocked number list entry

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAnsweringRuleInfo

AnsweringRuleInfo UpdateAnsweringRuleInfo(ctx, accountId, extensionId, ruleId, updateAnsweringRuleRequest) Update Custom Call Handling Rule

Since 1.0.24 (Release 8.0)

Updates a custom answering rule for a particular caller ID.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
ruleId	string	Internal identifier of an answering rule
updateAnsweringRuleRequest	UpdateAnsweringRuleRequest	JSON body

Return type

AnsweringRuleInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBlockedNumber

BlockedNumberInfo UpdateBlockedNumber(ctx, accountId, extensionId, blockedNumberId, optional) Update Blocked Number

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
blockedNumberId	int32	Internal identifier of a blocked number list entry
optional	*UpdateBlockedNumberOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateBlockedNumberOpts struct

Name	Type	Description	Notes

blockedNumberInfo | optional.Interface of BlockedNumberInfo| |

Return type

BlockedNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCompanyAnsweringRuleInfo

CompanyAnsweringRuleInfo UpdateCompanyAnsweringRuleInfo(ctx, accountId, ruleId, companyAnsweringRuleUpdate) Update Company Call Handling Rule

Since 1.0.31 (Release 9.2)

Updates a company answering rule.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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
companyAnsweringRuleUpdate	CompanyAnsweringRuleUpdate	JSON body

Return type

CompanyAnsweringRuleInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCompanyBusinessHours

CompanyBusinessHours UpdateCompanyBusinessHours(ctx, accountId, companyBusinessHoursUpdateRequest) Update Company Business Hours

Since 1.0.24 (Release 8.0)

Updates company hours when answering rules are to be applied.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
companyBusinessHoursUpdateRequest	CompanyBusinessHoursUpdateRequest	JSON body

Return type

CompanyBusinessHours

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateExtensionForwardingNumber

ForwardingNumberInfo UpdateExtensionForwardingNumber(ctx, accountId, extensionId, forwardingNumberId, updateForwardingNumberRequest) Update Forwarding Numbers

Since 1.0.24 (Release 8.0)

Updates an existent forwarding number from the forwarding number list.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
forwardingNumberId	string	Internal identifier of a forwarding number; returned in response in the id field
updateForwardingNumberRequest	UpdateForwardingNumberRequest	JSON body

Return type

ForwardingNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserBusinessHours

UserBusinessHoursUpdate UpdateUserBusinessHours(ctx, accountId, extensionId, userBusinessHoursUpdateRequest) Update User Business Hours

Since 1.0.28 (Release 8.4)

Updates the extension user hours when answering rules are to be applied.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
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 ~]
userBusinessHoursUpdateRequest	UserBusinessHoursUpdateRequest	JSON body

Return type

UserBusinessHoursUpdate

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]