Skip to main content

CustomAnsweringRuleInfo

Properties

NameTypeRequiredDescription
uristrCanonical URI to an answering rule resource
id_strInternal identifier of an answering rule
type_CustomAnsweringRuleInfoTypeType of an answering rule
namestrName of an answering rule specified by user
enabledboolSpecifies if an answering rule is active or inactive
scheduleScheduleInfoSchedule when an answering rule should be applied
called_numbersList[CalledNumberInfo]Answering rules are applied when calling to selected number(s)
callersList[CallersInfo]Answering rules are applied when calls are received from specified caller(s)
call_handling_actionCustomAnsweringRuleInfoCallHandlingActionSpecifies how incoming calls are forwarded
forwardingForwardingInfoForwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded
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
transferTransferredExtensionInfo
voicemailVoicemailInfoSpecifies whether to take a voicemail and who should do it
greetingsList[GreetingInfo]Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
screeningCustomAnsweringRuleInfoScreeningCall 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'
shared_linesSharedLinesInfoSharedLines call handling action settings

CustomAnsweringRuleInfoType

Type of an answering rule

Properties

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

CustomAnsweringRuleInfoCallHandlingAction

Specifies how incoming calls are forwarded

Properties

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

CustomAnsweringRuleInfoScreening

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 →