The SendDigits
command plays DTMF tones on a live Call. This is useful for navigating through IVR menus or dialing extensions.
Nesting Rules
You cannot nest any actions within the SendDigits
command and the SendDigits
command cannot be nested in any other command. However, it is possible to specify sendDigits
as an attribute of the dial command when it applies to a phone number (see OutDial ).
Example
Code for the above example scenario is shown below.
[
{
"SendDigits" : {
"digits" : "12{2}34{4}#"
}
}
]
Command Attributes
SendDigits
supports the following attributes that modify its behavior:
Attribute | Description |
---|---|
digits | String containing the digits to be played. |
pauseMs | Pause between digits in milliseconds. |
privacyMode | Indicates if the request contains sensitive information which should be hidden. |
digits
REQUIREDType: string
String containing the digits to be played. The string cannot be empty and can include any digit, plus #, or *, and allows embedding specification for delay or pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as 1234# will play in 2 seconds (because of 4 standard pauses implied within the string).
pauseMs
OPTIONALType: integer between 100-1000
Default: 500 (ms)
Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. Once this duration is specified, a custom pause is specified as a positive integer {n} within the digits string. This evaluates a pause equaling n units of the default or the overridden pause time. A digits string such as “12{2}34{4}#” will be rendered as follows:
- Play digit 1, wait 0.5 seconds
- Play digit 2, wait 1 second
- Play digit 3, wait 0.5 seconds
- Play digit 4, wait 2 seconds
- Play digit #
Custom pause times cannot exceed 3000 ms.
privacyMode
OPTIONALType: boolean
Default: false
Indicates if the request contains sensitive information which should be hidden. When set to true
, the contents of the digits
attribute will be replaced with the string "xxxxx" in the logs. It's important to note that privacyMode
is set at the command level, meaning it will not be inherited by any nested commands.