The purpose of this application is to read a specified number of digits in a specified variable. The application has many features, including timeout and possibility to play a sound file.

Below, we will give you an example, how to use this application.

To use this application you need a working Asterisk PBX with registered users in iax.conf, sip.conf or mgcp.conf(It depends on which protocol you would like to use) and made extensions.

To see how the application works we recommend to use our IAX softphone Idefisk. You can download it from here. Please also read our tutorial to learn how to configure it to work with Asterisk PBX.

NOTE: This is only an example of what for you can use this application. Of course you can use it and for other things.

We need one registered user in iax.conf file. This is because we are going to use the IAX2 protocol. If you want to use other protocol such as SIP or MGCP, you have to do the configurations below respectively in sip.conf or mgcp.conf.

So, we have registered the user user1

Type=friend means that this user can make and receive calls. Host=dynamic means that the IP is not static but dynamic through a DHCP server. Allow=all means that the line which this user will use, could support all audio codecs. Context=test - this shows that this user is working with the extensions in this context of the configuration file extensions.conf.

Now lets take a look at the extensions.conf file.

On the picture above you can see our extensions.conf file.

When somebody dials 1111, the call will be answered by the Answer application. The next executed extension will be the one which contains the Read application. As arguments in its brackets we have set the following: test|attention-required|4|skip|2|15.


The next executed extension will be the one with the SendText application. Thanks to it, a message will be displayed on the caller’s screen. The message will contain the value of the test variable. In other words it will show us what we have entered with the Read application.

NOTE: Please, pay attention, that when you set the test variable in the Read application, you have to write it without the ${} characters. However, when you call the same variable in the SendText application, you have to write it with the ${} characters

Finally, in order to be sure that the Asterisk PBX will hang up the line after the conversation is over, it is a good idea to make an extension for hanging up the line.

So when somebody dials 1111, the call will be answered by the Answer application. Then, hanks to the Read application, the caller will hear the sound file attention-required, then he/she could enter some digits, but no more than 4. If the caller does not enter anything within 15 seconds, then he/she could try one more time. If the user enters some digits, then a message will appear on its screen. The message will contain the entered digits. The last thing to happen is the closing of the line thanks to the Hangup application.