OutDial.md

Freeclimb::OutDial

Properties

Name	Type	Description	Notes
action_url	String	URL to which FreeClimb sends an HTTP POST request.
call_connect_url	String	URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial.
calling_number	String	he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb.
destination	String	E.164 representation of the phone number to Call.
if_machine	IfMachine		[optional]
if_machine_url	String	When the `ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes a POST request when an answering machine or a fax machine is detected. This URL is required if the `ifMachine` flag is set to `redirect`. Otherwise, it should not be included.	[optional]
send_digits	String	DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension.	[optional]
status_callback_url	String	When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored.	[optional]
timeout	Integer	Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`.	[optional]
privacy_mode	Boolean	Parameter `privacyMode` will not log the `text` as required by PCI compliance.	[optional]

Example

require 'freeclimb'

instance = Freeclimb::OutDial.new(
  action_url: null,
  call_connect_url: null,
  calling_number: null,
  destination: null,
  if_machine: null,
  if_machine_url: null,
  send_digits: null,
  status_callback_url: null,
  timeout: null,
  privacy_mode: null
)