ForwardingInfoCreateRuleRequest
Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| notify_my_soft_phones | bool | ❌ | Specifies if the first ring on desktop/mobile apps is enabled. The default value is true |
| notify_admin_soft_phones | bool | ❌ | Deprecated parameter. Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is true. |
| soft_phones_ring_count | int | ❌ | Specifies delay between ring on apps and starting of a call forwarding. To activate this parameter use the value > 0, and turn off the softPhonesAlwaysRing setting. If the value is 1 or 0, the softPhonesAlwaysRing setting cannot be turned off |
| soft_phones_always_ring | bool | ❌ | Specifies 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_mode | ForwardingInfoCreateRuleRequestRingingMode | ❌ | Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially' |
| rules | List[ForwardingRuleCreateRequest] | ❌ | Information on a call forwarding rule |
| mobile_timeout | bool | ❌ | Deprecated parameter. Specifies if mobile timeout is activated for the rule |
ForwardingInfoCreateRuleRequestRingingMode
Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially'
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SEQUENTIALLY | str | ✅ | "Sequentially" |
| SIMULTANEOUSLY | str | ✅ | "Simultaneously" |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs