Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.94 KB

File metadata and controls

23 lines (15 loc) · 1.94 KB

OutDial

The OutDial command is used to call a phone number

Properties

Name Type Description Notes
actionUrl URI URL to which FreeClimb sends an HTTP POST request.
callConnectUrl URI URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial.
callingNumber 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.
ifMachine IfMachine [optional]
ifMachineUrl URI 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]
sendDigits String DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. [optional]
statusCallbackUrl URI 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]
privacyMode Boolean Parameter `privacyMode` will not log the `text` as required by PCI compliance. [optional]