Package com.ringcentral.paths.restapi.v2.accounts.extensions.commhandling.voice.staterules

Class Index

java.lang.Object

com.ringcentral.paths.restapi.v2.accounts.extensions.commhandling.voice.staterules.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	stateId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String stateId)

Method Summary

Modifier and Type	Method	Description
CommStateBasedRuleResource	get()	Returns the extension's voice state-based rule by ID specified in URL.
CommStateBasedRulesResource	list()
CommStateBasedRulesResource	list(ListVoiceStateBasedRulesParameters queryParams)	Returns a list of extension's voice state-based rules.
CommStateBasedRuleResource	patch(CommStateBasedRuleUpdateRequest commStateBasedRuleUpdateRequest)	Updates the extension's voice state-based rule.
String	path()
String	path(Boolean withParameter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

stateId

public String stateId

Constructor Details

Index

public Index(Index parent,
 String stateId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public CommStateBasedRulesResource list(ListVoiceStateBasedRulesParameters queryParams)
                                 throws RestException,
IOException

Returns a list of extension's voice state-based rules.

*State-base rule* is a call handling rule, managing voice calls on the basis of the user's **state (status)**: *Forward all calls (FAC), Do not disturb (DND), Work Hours (WH), After Hours (AH), Agent*.

**Please note:** State-based rules are applicable to the User extension types only: User, DigitalUser, FaxUser, VirtualUser.

HTTP Method: get Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/comm-handling/voice/state-rules Rate Limit Group: Medium App Permission: ReadAccounts

Throws:

RestException

IOException

list

public CommStateBasedRulesResource list()
                                 throws RestException,
IOException

Throws:

RestException

IOException

get

public CommStateBasedRuleResource get()
                               throws RestException,
IOException

Returns the extension's voice state-based rule by ID specified in URL. Each state is assigned with the predefined ID.

*State-base rule* is a call handling rule, managing voice calls on the basis of the user's **state (status)**:

*Forward all calls (FAC), Do not disturb (DND), Work Hours (WH), After Hours (AH), Agent*.

HTTP Method: get Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/comm-handling/voice/state-rules/{stateId} Rate Limit Group: Medium App Permission: ReadAccounts

Throws:

RestException

IOException

patch

public CommStateBasedRuleResource patch(CommStateBasedRuleUpdateRequest commStateBasedRuleUpdateRequest)
                                 throws RestException,
IOException

Updates the extension's voice state-based rule.

**Please note:** When updating any of objects: `enabled`, `displayName`, `dispatching`, `condition`, etc. all of object parameters should be passed (as in PUT method) - if a parameter is not specified, its value will be set back to default, if any, or deleted.

HTTP Method: patch Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/comm-handling/voice/state-rules/{stateId} Rate Limit Group: Medium App Permission: EditExtensions

Throws:

RestException

IOException