Package com.ringcentral.definitions

Class CreateAnsweringRuleRequest

java.lang.Object

com.ringcentral.definitions.CreateAnsweringRuleRequest

public class CreateAnsweringRuleRequest
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
CalledNumberInfo[]	calledNumbers	Answering rules are applied when calling to selected number(s)
CallersInfoRequest[]	callers	Answering rule will be applied when calls are received from the specified caller(s)
String	callHandlingAction	Specifies how incoming calls are forwarded Enum: ForwardCalls, UnconditionalForwarding, AgentQueue, TransferToExtension, TakeMessagesOnly, PlayAnnouncementOnly, SharedLines
Boolean	enabled	Specifies if the rule is active or inactive.
ForwardingInfo	forwarding
GreetingInfo[]	greetings	Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
MissedCallInfo	missedCall
String	name	Name of an answering rule specified by user Required
QueueInfo	queue
ScheduleInfo	schedule
String	screening	Call screening status.
TransferredExtensionInfo	transfer
String	type	Type of an answering rule.
UnconditionalForwardingInfo	unconditionalForwarding
VoicemailInfo	voicemail

Constructor Summary

Constructors

Constructor	Description
CreateAnsweringRuleRequest()

Method Summary

Modifier and Type	Method	Description
CreateAnsweringRuleRequest	calledNumbers(CalledNumberInfo[] calledNumbers)
CreateAnsweringRuleRequest	callers(CallersInfoRequest[] callers)
CreateAnsweringRuleRequest	callHandlingAction(String callHandlingAction)
CreateAnsweringRuleRequest	enabled(Boolean enabled)
CreateAnsweringRuleRequest	forwarding(ForwardingInfo forwarding)
CreateAnsweringRuleRequest	greetings(GreetingInfo[] greetings)
CreateAnsweringRuleRequest	missedCall(MissedCallInfo missedCall)
CreateAnsweringRuleRequest	name(String name)
CreateAnsweringRuleRequest	queue(QueueInfo queue)
CreateAnsweringRuleRequest	schedule(ScheduleInfo schedule)
CreateAnsweringRuleRequest	screening(String screening)
CreateAnsweringRuleRequest	transfer(TransferredExtensionInfo transfer)
CreateAnsweringRuleRequest	type(String type)
CreateAnsweringRuleRequest	unconditionalForwarding(UnconditionalForwardingInfo unconditionalForwarding)
CreateAnsweringRuleRequest	voicemail(VoicemailInfo voicemail)

Methods inherited from class java.lang.Object

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

Field Details

enabled

public Boolean enabled

Specifies if the rule is active or inactive. The default value is `true`

type

public String type

Type of an answering rule. The 'Custom' value should be specified Required

name

public String name

Name of an answering rule specified by user Required

callers

public CallersInfoRequest[] callers

Answering rule will be applied when calls are received from the specified caller(s)

calledNumbers

public CalledNumberInfo[] calledNumbers

Answering rules are applied when calling to selected number(s)

schedule

public ScheduleInfo schedule

callHandlingAction

public String callHandlingAction

Specifies how incoming calls are forwarded Enum: ForwardCalls, UnconditionalForwarding, AgentQueue, TransferToExtension, TakeMessagesOnly, PlayAnnouncementOnly, SharedLines

forwarding

public ForwardingInfo forwarding

unconditionalForwarding

public UnconditionalForwardingInfo unconditionalForwarding

queue

public QueueInfo queue

transfer

public TransferredExtensionInfo transfer

voicemail

public VoicemailInfo voicemail

missedCall

public MissedCallInfo missedCall

greetings

public GreetingInfo[] greetings

Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List

screening

public String screening

Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' Default: Off Enum: Off, NoCallerId, UnknownCallerId, Always

Constructor Details

CreateAnsweringRuleRequest

public CreateAnsweringRuleRequest()

Method Details

enabled

public CreateAnsweringRuleRequest enabled(Boolean enabled)

type

public CreateAnsweringRuleRequest type(String type)

name

public CreateAnsweringRuleRequest name(String name)

callers

public CreateAnsweringRuleRequest callers(CallersInfoRequest[] callers)

calledNumbers

public CreateAnsweringRuleRequest calledNumbers(CalledNumberInfo[] calledNumbers)

schedule

public CreateAnsweringRuleRequest schedule(ScheduleInfo schedule)

callHandlingAction

public CreateAnsweringRuleRequest callHandlingAction(String callHandlingAction)

forwarding

public CreateAnsweringRuleRequest forwarding(ForwardingInfo forwarding)

unconditionalForwarding

public CreateAnsweringRuleRequest unconditionalForwarding(UnconditionalForwardingInfo unconditionalForwarding)

queue

public CreateAnsweringRuleRequest queue(QueueInfo queue)

transfer

public CreateAnsweringRuleRequest transfer(TransferredExtensionInfo transfer)

voicemail

public CreateAnsweringRuleRequest voicemail(VoicemailInfo voicemail)

missedCall

public CreateAnsweringRuleRequest missedCall(MissedCallInfo missedCall)

greetings

public CreateAnsweringRuleRequest greetings(GreetingInfo[] greetings)

screening

public CreateAnsweringRuleRequest screening(String screening)