6.1.2.64. Read (dialplan application)
1. Read - this application allows you to read a variable.
NOTE: This application is valid for Asterisk version 1.0.9 and above.
Syntax:
List with the possible options
Purpose and usage
Prerequisites
Asterisk PBX configurations
iax.conf Configurations
extensions.conf Configurations
2. Screenshots of what you can see on your Idefisk and on the CLI of the Asterisk PBX
3. Additional information
4. Uploaded files
5. Similar dialplan applications
NOTE: This application is valid for Asterisk version 1.0.9 and above.
Syntax:
Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])
List with the possible options
variable - the variable, which has to be read
filename - with this parameter you can specify a sound file, which you would like to be played, before the reading. The sound file has to be in the directory /var/lib/asterisk/sounds.
maxdigits - with this argument, you can set the maximum number of digits, which the user could enter. After the maximum is reached, the reading will stop.
option - there are two possible options:
attempts - here you can specify the desired number of attempts, the user has in case of no data is entered.
timeout - with this parameter, you specify the number of second, which the user has, to enter some data. By default the timeout is set to zero.
filename - with this parameter you can specify a sound file, which you would like to be played, before the reading. The sound file has to be in the directory /var/lib/asterisk/sounds.
maxdigits - with this argument, you can set the maximum number of digits, which the user could enter. After the maximum is reached, the reading will stop.
option - there are two possible options:
skip - if this one is specified, the application will return immediately, if the line is not up.
noanswer - if this one is specified, then the application will read the digits even if the line is not up
noanswer - if this one is specified, then the application will read the digits even if the line is not up
attempts - here you can specify the desired number of attempts, the user has in case of no data is entered.
timeout - with this parameter, you specify the number of second, which the user has, to enter some data. By default the timeout is set to zero.
Purpose and usage
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.
Below, we will give you an example, how to use this application.
Prerequisites
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.
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.
Asterisk PBX configurations
NOTE: This is only an example of what for you can use this application. Of course you can use it and for other things.
iax.conf Configurations
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.
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.
extensions.conf Configurations
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 callers 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.
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.
test - the variable which will be read. In other words, this variable will store the digits, which we will enter.
attention-required - the sound file, which we would like the caller to hear. The file will be played before the reading of the digits. The sound file has to be in the directory /var/lib/asterisk/sounds. This is the default directory. You can change it in the asterisk.conf file.
4 - the maximum number of digits the caller could enter.
skip - this means, that the application will return immediately if the line is not up.
2 - this is the maximum number of attempts, the call has, to enter a data.
15 - is the timeout. The caller has 15 seconds to enter a data. If the time expires and there is no data entered and the number of the attempts is greater than 1, then the caller will hear again the sound file and it could try again to enter some digits.
attention-required - the sound file, which we would like the caller to hear. The file will be played before the reading of the digits. The sound file has to be in the directory /var/lib/asterisk/sounds. This is the default directory. You can change it in the asterisk.conf file.
4 - the maximum number of digits the caller could enter.
skip - this means, that the application will return immediately if the line is not up.
2 - this is the maximum number of attempts, the call has, to enter a data.
15 - is the timeout. The caller has 15 seconds to enter a data. If the time expires and there is no data entered and the number of the attempts is greater than 1, then the caller will hear again the sound file and it could try again to enter some digits.
The next executed extension will be the one with the SendText application. Thanks to it, a message will be displayed on the callers 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.
2. Screenshots of what you can see on your Idefisk and on the CLI of the Asterisk PBX
3. Additional information
For more information about extensions.conf you can check here.
For more information about iax.conf you can check here.
This application is tested with our IAX softphone Idefisk. You can download it from here. For more information about this softphone please read our tutorial.
If you would like to test this application with the SIP channel you can read our tutorials about the SIP Softphones to learn how to configure them to work with Asterisk PBX
For more information about iax.conf you can check here.
This application is tested with our IAX softphone Idefisk. You can download it from here. For more information about this softphone please read our tutorial.
If you would like to test this application with the SIP channel you can read our tutorials about the SIP Softphones to learn how to configure them to work with Asterisk PBX
4. Uploaded files
5. Similar dialplan applications