Call Forward

The Call Forward component bridges a phone number or SIP endpoint into an active call.

​

Configuration parameters:

• From
• To
• General options
• Events

​

Options:

• From (required) Caller ID to display to the recipient of the forwarded call.
• To (required) List of recipients to bridge into the active call. The list can contain phone numbers and SIP endpoints, each separated by a comma. Based on the forwarding option selected, recipients are dialed sequentially or simultaneously. If an extension is configured it will be dialed when the call is answered.
• Ring timeout Time limit (in seconds) for the recipient to answer the call. The Failed state is triggered when the time limit is reached. The default value is 30 seconds.
• Forwarding options Forwarding is applicable when you provide multiple call recipients. The sequence option dials one recipient at a time and tries the next recipient once the ring timeout limit is reached. The parallel option dials all recipients simultaneously, and the first call that connects cancels all the other tries. The same ring timeout is applied to all the calls irrespective of the forwarding option selected.
• Call screening You can play a message before the recipient is connected to the call. The recipient must press the specified confirm key to accept the call.
• Record Audio This option is used to decide how the calls are recorded. Calls can be recorded dynamically by passing these values:

​

States:

The Call Forward component is set to Completed state when either party hangs up the call. Other states are No Answer, Busy/Rejected, and Failed.

​

Variables:

• uuid UUID of the forwarded call
• to Phone number or SIP endpoint to which the call is forwarded
• from Caller ID set on the forwarded call
• start_time UTC time when the call started
• answer_time UTC time when the call is answered
• end_time UTC time when the call ended
• direction The direction of the call is set to outbound
• from_iso2 ISO alpha-2 code of the country to which the phone number belongs
• from_country Country to which the phone number belongs
• leg The leg of the forwarded call is set to BLeg
• hangup_cause Code of the hangup cause corresponding to the reason for the hangup
• duration Duration (in seconds) of the call since the dial
• bill_duration Duration (in seconds) of the call that’s billed
• bill_rate Rate per unit applicable for the call
• bill_amount Amount billed for the call
• ring_status Set to true if the call rings. Allowed values: true, false
• parent_call_uuid UUID of the parent call that’s forwarded
• dial_status Status of the call. Allowed values: completed, busy, failed, no-answer