By using the Aculab site, you agree with our use of cookies.

digit input options

Defines which digits can be input on a call, how the digit input is completed and a timeout for successive digit entry.

Used by action get input

language wrappers and examples

It contains the following properties:

PropertyRequired/OptionalDefaultDescription
digit countoptional0The number of digits to enter. 0 signifies an unlimited number of digits, in which case end digit must be set. The maximum is 32.
end digitoptional"#"A single digit that, when pressed, will indicate the end of the number. An empty string signifies no end digit, in which case digit count must not be zero. Valid digits are 0123456789ABCD#*.
valid digitsoptional"0123456789"A string that represents the set of digits that are deemed to be valid. Note that the help digit and end digit are also valid entries in addition to those set here. Any valid Dual Tone Multi Frequency (DTMF) digit can be included in this string. Valid digits are 0123456789ABCD#*.

  • Examples:


    •     {
      		"digit_count" : 11,
      		"valid_digits" : "123456789"
      	}
      
  • DigitInputOptions Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    A class representing the options available to control digit input during a get input action.

    public class DigitInputOptions 
    {
        // Constructors
        public DigitInputOptions(int digitCount);
        public DigitInputOptions(char endDigit);
        public DigitInputOptions(int digitCount, char endDigit, string validDigits);
    
        // Members
        public int? DigitCount;
        public char? EndDigit;
        public string ValidDigits;
    }
    

    Examples:

    • Configure digit input options:

      var digitInputOptions = new DigitInputOptions(11)
      {
          ValidDigits = "123456789"
      };
      
  • DigitInputOptions Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    A class representing the options available to control digit input during a get input action.

    Public Class DigitInputOptions
        ' Constructors
        Public Sub New (digitCount As Integer)
        Public Sub New (endDigit As Char)
        Public Sub New (digitCount As Integer, endDigit As Char, validDigits As String)
    
        ' Members
        Public Property DigitCount As Integer?
        Public Property EndDigit As Char?
        Public Property ValidDigits As String
    End Class
    

    Examples:

    • Configure digit input options

      Dim digitInputOptions = New DigitInputOptions(11)
      digitInputOptions.ValidDigits = "123456789"
      
  • class DigitInputOptions extends JSONElement

    Represents the Digit Input Options support class.

    Class synopsis:

    // Constructors:
    public DigitInputOptions()
    public DigitInputOptions(int digitCount)
    public DigitInputOptions(char endDigit)
    public DigitInputOptions(int digitCount, char endDigit, String validDigits)
    
    // Members:
    public void setDigitCount(int digitCount)
    public void setEndDigit(char endDigit)
    public void setValidDigits(String validDigits)
    

    Examples:

    • Configure digit input options:

      DigitInputOptions digitInputOpts = new DigitInputOptions(11);
      digitInputOpts.setValidDigits("123456789");
      
  • class DigitInputOptions

    Represents the Digit Input Options support class.

    Class synopsis:

    # DigitInputOptions object:
    DigitInputOptions()
    
    # Instance methods:
    DigitInputOptions.set_valid_digits(valid_digits)
    DigitInputOptions.set_digit_count(digit_count)
    DigitInputOptions.set_end_digit(end_digit)
    

    Examples:


    • digit_input_opts = DigitInputOptions()
      digit_input_opts.set_digit_count(11)
      digit_input_opts.set_valid_digits("123456789")
      
  • The DigitInputOptions class

    Introduction

    Represents the digit input options.

    Class synopsis

    class DigitInputOptions {
    
        /* methods */
        public __construct()
        public self setDigitCount(int $count)
        public self setEndDigit(string $digit)
        public self setValidDigits(string $digits)
    }
    

    Examples:

    • Configure digit input options:

      $digit_input_options = new \Aculab\TelephonyRestAPI\DigitInputOptions();
      $digit_input_options->setDigitCount(11)
          ->setValidDigits("123456789");