Sends a signal through the DTMF interface, allowing users to use the telephone numeric keypad to perform some action during the telephone call.

Starting from IBM RPA 23.0.3, this command is removed from the product. For more information, see Removed.

Important:As a result from the command's removal on IBM RPA 23.0.3, it no longer works on newer IBM RPA client versions.

Command availability: IBM RPA SaaS and IBM RPA on premises

Script syntax

IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.

ivrSendDtmf --value(String) (String)=value

Input parameter

The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.

Designer mode label Script mode name Required Accepted variable types Description
Value value Required Text Dialing number thas should be sent by the DTMF.

Output parameter

Designer mode label Script mode name Accepted variable types Description
Sucess value Text Returns True if successful sending DTMF signal, or False otherwise.


When determining the digit "1" for the bill of exchange duplicate request and digit "2" to terminate the call, the Send DTMF command, in this context, is used to send the digit "1" if the value entered by the user is "1".

defVar --name voiceEngine --type SpeechEngine
defVar --name languageEnglish --type Language
defVar --name userName --type String
defVar --name digitUser --type Numeric
// Create the vocalization and language that will be used by the IVR.
googleEngine --culture "en-US" --voice "en-US-Standard-D" voiceEngine=value
createLanguage --culture "en-US" --speech ${voiceEngine} languageEnglish=value
botConnect --type "Ivr" --language ${languageEnglish} --timeout "00:02:00"
	botAskName --beep  --text "Hello,what\'s your name?" --textformat "0" --timeout "00:02:00"
	botAskNumber --beep  --text "${userName}, to request the duplicate of your ticket, press key 1. Or, to end the call, press key 2." --textformat "0" --timeout "00:02:00" digitUser=first
	// Analyze if the number sent by the user is "1" or "2", and for "1" a DTMF signal is sent.
	if --left "${digitUser}" --operator "Equal_To" --right 1
		ivrSendDtmf --value 1
		botSay --language ${languageEnglish} --text "\"${userName}, thanks for contacting us! We\'ll send the bill to youre-mailsoon." --textformat "0"
		if --left "${digitUser}" --operator "Equal_To" --right 2
			botSay --text "${userName}, we are finalizing our contact, thanks!" --textformat "0"
Note:When you run this command using IVR type, you get prompted by a window to call the IVR. This window might show a phone number or the Zoiper QR code to calls via the Zoiper application. You see this window in debug mode in the IBM RPA Studio.

Starting from IBM RPA 23.0.3, this window isn't available due to the IVR removal. For more information, see Removed.