Skip to main content

ForwardingInfo

Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded

Properties

NameTypeRequiredDescription
notify_my_soft_phonesboolSpecifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
notify_admin_soft_phonesboolDeprecated parameter. Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is false
soft_phones_ring_countintNumber of rings before forwarding starts
soft_phones_always_ringboolSpecifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to true then softPhonesRingCount is ignored
ringing_modeForwardingInfoRingingModeSpecifies the order in which the forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time
rulesList[ForwardingRuleInfo]Information on a call forwarding rule
soft_phones_position_topboolSpecifies if desktop and mobile applications of the user are notified before (true) or after (false) forwarding the incoming call to desk phones and forwarding numbers. Applicable only if notifyMySoftPhones parameter is set to true
mobile_timeoutboolDeprecated parameter. Specifies if mobile timeout is activated for the rule

ForwardingInfoRingingMode

Specifies the order in which the forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time

Properties

NameTypeRequiredDescription
SEQUENTIALLYstr"Sequentially"
SIMULTANEOUSLYstr"Simultaneously"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →