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

Class Index

java.lang.Object

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

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	ruleId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String ruleId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes the extension's interaction rule by ID specified in URL.
CommInteractionRuleResource	get()	Returns the extension's interaction rule by ID specified in URL.
CommInteractionRulesResource	list()
CommInteractionRulesResource	list(ListVoiceInteractionRulesParameters queryParams)	Returns a list of extension's interaction rules with the detailed information on each rule.
CommInteractionRuleResource	patch(CommInteractionRuleUpdateRequest commInteractionRuleUpdateRequest)	Updates the extension's interaction rule by ID specified in URL.
String	path()
String	path(Boolean withParameter)
CommInteractionRuleResource	post(CommInteractionRuleCreateRequest commInteractionRuleCreateRequest)	Creates the extension's interaction rule.

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

ruleId

public String ruleId

Constructor Details

Index

public Index(Index parent,
 String ruleId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public CommInteractionRulesResource list(ListVoiceInteractionRulesParameters queryParams)
                                  throws RestException,
IOException

Returns a list of extension's interaction rules with the detailed information on each rule.

*Interaction* rule is a call handling rule, managing voice call on the basis of the user's **contact** or a **phone number** which is calling and/or being called.

**Please note:** Interaction 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/interaction-rules Rate Limit Group: Medium App Permission: ReadAccounts

Throws:

RestException

IOException

list

public CommInteractionRulesResource list()
                                  throws RestException,
IOException

Throws:

RestException

IOException

post

public CommInteractionRuleResource post(CommInteractionRuleCreateRequest commInteractionRuleCreateRequest)
                                 throws RestException,
IOException

Creates the extension's interaction rule.

*Interaction* rule is a call handling rule, managing voice call on the basis of the user's **contact** or a **phone number** which is calling and/or being called.

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

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

Throws:

RestException

IOException

get

public CommInteractionRuleResource get()
                                throws RestException,
IOException

Returns the extension's interaction rule by ID specified in URL.

*Interaction* rule is a call handling rule, managing voice call on the basis of the user's **contact** or a **phone number** which is calling and/or being called.

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

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes the extension's interaction rule by ID specified in URL. HTTP Method: delete Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/comm-handling/voice/interaction-rules/{ruleId} Rate Limit Group: Medium App Permission: EditExtensions

Throws:

RestException

IOException

patch

public CommInteractionRuleResource patch(CommInteractionRuleUpdateRequest commInteractionRuleUpdateRequest)
                                  throws RestException,
IOException

Updates the extension's interaction rule by ID specified in URL. HTTP Method: patch Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/comm-handling/voice/interaction-rules/{ruleId} Rate Limit Group: Medium App Permission: EditExtensions

Throws:

RestException

IOException