Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 2.86 KB

GetDigitsAllOf.md

File metadata and controls

18 lines (14 loc) · 2.86 KB

freeclimb.Model.GetDigitsAllOf

Properties

Name Type Description Notes
ActionUrl string When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL.
DigitTimeoutMs int Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered. [optional]
FinishOnKey string Digit that causes the input sequence to be deemed complete. This attribute defers to the `timeout` attribute – so, if a `timeout` occurs, then the command terminates regardless of the value of `finishOnKey`. [optional]
FlushBuffer bool If set to true, the FreeClimb platform starts with an empty DTMF buffer to store the digits entered by the caller. If set to false, FreeClimb will append the user inputs to the end of the existing digits buffer and will return digits from the start of the digits buffer. [optional]
InitialTimeoutMs string Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a `timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed. [optional]
MaxDigits int Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. [optional]
MinDigits int Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. [optional]
Prompts List<PerclCommand> JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. [optional]
PrivacyMode bool Parameter `privacyMode` will not log the `text` as required by PCI compliance. [optional]

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