6.1.1.8. TIMEOUT(digit) (dialplan function) - NEW
1. TIMEOUT(digit) - this function allows you to limit the time interval between digits when the user is typing an extension.
NOTE:Information about the Asterisk functions could be obtained by typing the show functions command.
Information about a particular function could be obtained by typing the show function <function name> on the Asterisk CLI command.
NOTE: In Asterisk versions 1.2 and up there are several applications which are mark as deprecated and which are no longer supported.
These applications will now become functions and these functions will be used in combination with the Set application.
You have to know that their functionality will be the same, but with a different syntax.
The TIMEOUT(digit) function is one of those new functions which will replace the old applications. In this tutorial we will show you its syntax and possible usage.
Check out the old syntax of the DigitTimeout application here
Syntax:
List of the possible options
Purpose and usage
Prerequisites
Asterisk PBX configurations
iax.conf Configurations
extensions.conf Configurations
2. Screenshots of what you could see on the CLI of the Asterisk PBX
3. Additional information
4. Uploaded files
TIMEOUT_digit.tar - configuration files
5. Similar dialplan functions
NOTE:Information about the Asterisk functions could be obtained by typing the show functions command.
Information about a particular function could be obtained by typing the show function <function name> on the Asterisk CLI command.
NOTE: In Asterisk versions 1.2 and up there are several applications which are mark as deprecated and which are no longer supported.
These applications will now become functions and these functions will be used in combination with the Set application.
You have to know that their functionality will be the same, but with a different syntax.
The TIMEOUT(digit) function is one of those new functions which will replace the old applications. In this tutorial we will show you its syntax and possible usage.
Check out the old syntax of the DigitTimeout application here
Syntax:
Set(TIMEOUT(digit)=value)
List of the possible options
value - The interval in seconds.
Purpose and usage
With the help of this function you could limit the time, which the users have, to type the digits from an extension. If the timeout expire while the user is typing the extension, then the Asterisk PBX will consider the extension as complete and it will try to interpret it.
Below, we will give you an example.
Below, we will give you an example.
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. We are using Asterisk version1.2.1.
To see how the application works we recommend you to use our IAX softphone Idefisk. You could 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 you to use our IAX softphone Idefisk. You could download it from here. Please also read our tutorial to learn how to configure it to work with Asterisk PBX.
Asterisk PBX configurations
iax.conf Configurations
We need to create one user in the 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 could see our extensions.conf file.
In this example, when somebody dials 100, the call will be answered by the Answer application.
Then we will limit the interval between the digits, thanks to the TIMEOUT(digit) function.
So the next executed extension will be the one, which contains the Set application. As arguments in its brackets we have set the following - TIMEOUT(digit)=5. By default it is also 5. Now, with this function the caller has maximum time of 5 seconds to type a digit and also between the digits when he enters an extension. If the timeout expires the system will consider the extension completed and it will try to call this extension.
Here we have a specific moment. If you have typed a valid number the Asterisk PBX will interpreted it immediately and no timeout will be waited. However if there is a timeout executed this very probably means, that the typed number is invalid. In this way the execution will be transferred to an invalid extension. If such extension does not exist the next step will be the transfer of the call to a timeout extension. If even such extension does not exist then the call will be hung up.
Invalid and Timeout are special predefined extension names such as start.
An example for Invalid extension is:
The extension with the next priority contains the Dial application. this application will allow you to connect the user user1 through the IAX2 channel.
NOTE: The function TIMEOUT(digit) is case sensitive. You always have to write it in your dialplans as you see it in our tutorial.
In order to be sure that the Asterisk PBX will hang up the line, when the conversation is over, it is a good idea to use the Hangup application.
In this example, when somebody dials 100, the call will be answered by the Answer application.
Then we will limit the interval between the digits, thanks to the TIMEOUT(digit) function.
So the next executed extension will be the one, which contains the Set application. As arguments in its brackets we have set the following - TIMEOUT(digit)=5. By default it is also 5. Now, with this function the caller has maximum time of 5 seconds to type a digit and also between the digits when he enters an extension. If the timeout expires the system will consider the extension completed and it will try to call this extension.
Here we have a specific moment. If you have typed a valid number the Asterisk PBX will interpreted it immediately and no timeout will be waited. However if there is a timeout executed this very probably means, that the typed number is invalid. In this way the execution will be transferred to an invalid extension. If such extension does not exist the next step will be the transfer of the call to a timeout extension. If even such extension does not exist then the call will be hung up.
Invalid and Timeout are special predefined extension names such as start.
An example for Invalid extension is:
exten => i,1,Answer()
exten => i,2,Playback(pbx-invalid)
exten => i,3,Hangup()
exten => i,2,Playback(pbx-invalid)
exten => i,3,Hangup()
The extension with the next priority contains the Dial application. this application will allow you to connect the user user1 through the IAX2 channel.
NOTE: The function TIMEOUT(digit) is case sensitive. You always have to write it in your dialplans as you see it in our tutorial.
In order to be sure that the Asterisk PBX will hang up the line, when the conversation is over, it is a good idea to use the Hangup application.
2. Screenshots of what you could see 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
More information about the Set application could be found 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
More information about the Set application could be found here
4. Uploaded files
TIMEOUT_digit.tar - configuration files
5. Similar dialplan functions
| Add Comment |
Latest Headlines:
-
T.38 faxing with Zoiper 2.15 is now easier than ever
section: voip software
-
Asterisk 1.4.21 Released
section: Asterisk
-
Asterisk 1.4.20 Released
section: Asterisk
-
Asterisk 1.4.20-rc2 Released
section: Asterisk
-
Asterisk 1.4.20-rc1 Now Available
section: Asterisk
- News Archives (older news)
Latest Tutorials:
-
VMAuthenticate (dialplan application)
added 01/Mar/2008 15:57
-
Siptronic ST-530
added 06/Nov/2007 17:57
-
Siemens C455 IP hardphone
added 05/Nov/2007 10:24
-
Zoiper
added 22/Oct/2007 17:53
-
Grandstream GXP-2020
added 15/Oct/2007 18:17
Latest Comments:
-
<a href="http://www.9l9l.com/site/catego...
section: Asterisk
-
<a href="http://www.hawaaclub.com/thread...
section: Asterisk
-
<a href="http://games.9l9l.com/">ا...
section: Asterisk
-
<a href="http://games.9l9l.com/">ا...
section: Asterisk
-
mpingi is total fraud. dont get into the...
tutorial: Grandstream HandyTone-486 - SIP Analog Telephone Adapter (ATA)