Skip to main content

UpdateAnsweringRuleRequest

Properties

NameTypeRequiredDescription
id_strIdentifier of an answering rule
forwardingForwardingInfoCreateRuleRequestForwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded
enabledboolSpecifies if the rule is active or inactive. The default value is true
namestrName of an answering rule specified by user
callersList[CallersInfoRequest]Answering rule will be applied when calls are received from the specified caller(s)
called_numbersList[CalledNumberInfo]Answering rules are applied when calling to selected number(s)
scheduleScheduleInfoSchedule when an answering rule should be applied
call_handling_actionUpdateAnsweringRuleRequestCallHandlingActionSpecifies how incoming calls are forwarded
type_UpdateAnsweringRuleRequestTypeType of an answering rule
unconditional_forwardingUnconditionalForwardingInfoUnconditional forwarding parameters. Returned if 'UnconditionalForwarding' value is specified for the callHandlingAction parameter
queueQueueInfoQueue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action
voicemailVoicemailInfoSpecifies whether to take a voicemail and who should do it
missed_callMissedCallInfoSpecifies behavior for the missed call scenario. Returned only if enabled parameter of a voicemail is set to 'false'
greetingsList[GreetingInfo]Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
screeningUpdateAnsweringRuleRequestScreeningCall 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'
show_inactive_numbersboolIndicates whether inactive numbers should be returned or not
transferTransferredExtensionInfo

UpdateAnsweringRuleRequestCallHandlingAction

Specifies how incoming calls are forwarded

Properties

NameTypeRequiredDescription
FORWARDCALLSstr"ForwardCalls"
UNCONDITIONALFORWARDINGstr"UnconditionalForwarding"
AGENTQUEUEstr"AgentQueue"
TRANSFERTOEXTENSIONstr"TransferToExtension"
TAKEMESSAGESONLYstr"TakeMessagesOnly"
PLAYANNOUNCEMENTONLYstr"PlayAnnouncementOnly"
SHAREDLINESstr"SharedLines"

UpdateAnsweringRuleRequestType

Type of an answering rule

Properties

NameTypeRequiredDescription
BUSINESSHOURSstr"BusinessHours"
AFTERHOURSstr"AfterHours"
CUSTOMstr"Custom"

UpdateAnsweringRuleRequestScreening

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'

Properties

NameTypeRequiredDescription
OFFstr"Off"
NOCALLERIDstr"NoCallerId"
UNKNOWNCALLERIDstr"UnknownCallerId"
ALWAYSstr"Always"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →