Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.56 KB

File metadata and controls

39 lines (30 loc) · 2.56 KB

OutDial

The OutDial command is used to call a phone number

Properties

Name Type Description Notes
action_url str URL to which FreeClimb sends an HTTP POST request.
call_connect_url str URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial.
calling_number str 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 str E.164 representation of the phone number to Call.
if_machine IfMachine [optional]
if_machine_url str 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 str 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 str 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 int 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 bool Parameter `privacyMode` will not log the `text` as required by PCI compliance. [optional]

Example

from freeclimb.models.out_dial import OutDial

# TODO update the JSON string below
json = "{}"
# create an instance of OutDial from a JSON string
out_dial_instance = OutDial.from_json(json)
# print the JSON string representation of the object
print(OutDial.to_json())

# convert the object into a dict
out_dial_dict = out_dial_instance.to_dict()
# create an instance of OutDial from a dict
out_dial_from_dict = OutDial.from_dict(out_dial_dict)

[Back to Model list] [Back to API list] [Back to README]