The Initiate Call component makes a single call or bulk outbound calls to phone numbers or SIP endpoints.

​
Configuration parameters:

  • From
  • To
  • Settings
  • Record Calls
  • Events

​
Options:

  • From (required) Caller ID to display to the recipient of the call
  • To (required) List of phone numbers and SIP endpoints that need to be dialed
  • Call Settings Ring timeout is the time period (in seconds) for which an unanswered call should ring before hanging up
  • Record Audio This option is used to decide how calls are recorded. Calls can be recorded dynamically by passing these values:
Recording = TrueRecording = False
Any integer

0

True
Case insensitive		False
Case insensitive
Object, String

Empty

Null

​
States:

Component is set to Answered state. Other states are No Answer, Busy/Rejected, and Failed. When a machine is detected, the component is set to Voicemail state.

​
Variables:

  • uuid Unique identifier for the outbound call
  • to Phone numbers or SIP endpoints to call
  • from Caller ID to set on the 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 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 ALeg
  • 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
  • voicemail_detected Set to true if machine is detected in the call
  • call_status Status of the call — set to in-progress