{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The FON Script API is provided free of charge, but ","type":"text"},{"text":"not","type":"text","marks":[{"type":"strong"}]},{"text":" covered by Fonality Support. Fonality ","type":"text"},{"text":"Support","type":"text","marks":[{"type":"em"}]},{"text":" Engineers will ","type":"text"},{"text":"not","type":"text","marks":[{"type":"em"}]},{"text":" assist you with writing, modifying, or troubleshooting custom AGIs that you write or commission a 3rd party to write for you. Please do not contact ","type":"text"},{"text":"Support ","type":"text","marks":[{"type":"em"}]},{"text":"for any reason relating to the information on this page (even questions) or AGIs in general.","type":"text"}]},{"type":"paragraph"},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"outline":{"value":"false"},"style":{"value":"none"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"49eb8ed8-1622-4834-90e4-20da88e32d6f"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"9a18a8c2-2827-4af0-a0a7-4af7adea594e"}},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Fon Script Interface Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The FON Script Interface allows software developers and system integrators to extend the functionality of their PBXtra CCE systems by allowing them to create customized extensions to the PBXtra system using a standardized API. This facility allows the creation of custom IVR applications that will impress your friends, and probably get you promoted ;-).","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example Application","type":"text"}]},{"type":"paragraph","content":[{"text":"One example of a FON Script application is a store locater. This program would prompt the caller to key in his zip code, and look up a list of stores in a cross reference table of a database. Once the correct store is identified the caller is then automatically connected with the correct store.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prerequisite","type":"text"}]},{"type":"paragraph","content":[{"text":"You must have the PBXtra Call Center Edition of the Fonality software in order to use this feature. In CCE it will be shown in your call menu as \"Run Script\".","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"How To Configure Run Script","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log into your PBXtra Admin Web Interface using your administrative username and password.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on the ","type":"text"},{"text":"AutoAnswer","type":"text","marks":[{"type":"strong"}]},{"text":" tab.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on the ","type":"text"},{"text":"call menu","type":"text","marks":[{"type":"strong"}]},{"text":" tab.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a new ","type":"text"},{"text":"Call Sequence","type":"text","marks":[{"type":"strong"}]},{"text":" named ","type":"text"},{"text":"Run Script","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Specify the path to the script in your ","type":"text"},{"text":"/var/lib/asterisk/agi-bin/","type":"text","marks":[{"type":"strong"}]},{"text":" directory.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"my_script.agi","type":"text"}]},{"type":"paragraph","content":[{"text":"Example for a script listening on a port:","type":"text"}]},{"type":"codeBlock","content":[{"text":"fon://ip.add.re.ss:port","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: If you are running PBXtra Core version 1.2.14-fon-o or newer, you can also pass HTTP style arguments to the script like this:","type":"text"}]},{"type":"codeBlock","content":[{"text":"my_script.agi?extension=${EXTEN}","type":"text"}]},{"type":"paragraph","content":[{"text":"You can look for them in your script using the environment variables.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Calling Your Script","type":"text"}]},{"type":"paragraph","content":[{"text":"If you have connected your FON Interface Script to your call menu, you can dial \"0\" from any of your extensions to reach your main menu, and subsequently reach the AGI for testing. You may also dial in from an external line.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example Script","type":"text"}]},{"type":"paragraph","content":[{"text":"This example Perl script is available under the ","type":"text"},{"text":"GNU GPLv2 or higher License","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.gnu.org/licenses/gpl-2.0.html"}}]},{"text":". It demonstrates basic interaction with the PBXtra Core software from your server using the STDOUT file handle. It also shows how to get digit input from your callers.","type":"text"}]},{"type":"codeBlock","content":[{"text":"#!/usr/bin/perl\nuse strict; # Load the strict pragma to enforce good program form\nuse Socket; # Load the socket library to let us speak TCP/IP\nuse Carp; # Load an error handling library\nuse IO::Handle; # Overload the I/O functions with more appropriate ones\n\nmy $port = 4573; # TCP Port number to listen on\n\n$|=1; # Activate auto-flush to disable text buffering in perl\n\n# Setup Variables\nmy %AGI; # Init a hash structure to be used for AGI environment\nmy $tests = 0; # A counter for the number of tests that have been run\nmy $fail = 0; # A counter for failure conditions\nmy $pass = 0; # A counter for success conditions\n\n##############################################################################\n# checkresult: A function to check the return status of a command to \n# detect any errors.\n#\n# Arguments: $res = A result from an AGI command\n# Returns: none, sets $pass and $fail counters\n##############################################################################\nsub checkresult {\n my ($res) = @_;\n my $retval;\n $tests++;\n chomp $res;\n if ($res =~ /^200/) {\n $res =~ /result=(-?\\d+)/;\n if (!length($1)) {\n print STDERR \"FAIL ($res)\\n\";\n $fail++;\n } else {\n print STDERR \"PASS ($1)\\n\";\n $pass++;\n }\n } else {\n print STDERR \"FAIL (unexpected result '$res')\\n\";\n $fail++;\n }\n}\n\n# Set up a TCP/IP socket, and bind/listen to it for new connections\n# from the PXBtra Core software (the client)\nsocket(SERVER, PF_INET, SOCK_STREAM, 0);\nsetsockopt(SERVER, SOL_SOCKET, SO_REUSEADDR, pack(\"l\", 1));\nbind(SERVER, sockaddr_in($port, INADDR_ANY)) || die(\"can't bind\\n\");\nlisten(SERVER, SOMAXCONN);\n\n# Start the FastAGI/FON request loop\nfor(;;) {\n # We will wait for a connection. The accept() call will block until\n # a connection arrives. While processing, connections line up.\n my $raddr = accept(CLIENT, SERVER); # Get the next connection\n my ($s, $p) = sockaddr_in($raddr); # \n CLIENT->autoflush(1); # Disable text buffering client connection\n while() { # Read all the text sent from the client to the server\n chomp; # Eliminate any newlines on the end of the text\n last unless length($_); # If the line is empty, stop reading\n if (/^agi_(\\w+)\\:\\s+(.*)$/) { # Look for variables starting with agi_\n # Set AGI hash keyed by variable name to the value found\n $AGI{$1} = $2; # $1 is match from first set of parens above\n # $2 is match from second set of parens...\n }\n }\n # Print out a summary of the AGI environment. \n # Visible in asterisk -r console.\n print STDERR \"AGI Environment Dump from $s:$p --\\n\";\n foreach my $i (sort keys %AGI) {\n print STDERR \" -- $i = $AGI{$i}\\n\";\n }\n\n # Begin the first test. This plays a sound file, checks the result, and\n # counts the result.\n print STDERR \"1. Testing 'sendfile'...\";\n # Tell PBXtra Core (client) to play a sound file to the caller\n print CLIENT \"STREAM FILE beep \\\"\\\"\\n\"; \n my $result = ; # Read data from the PBXtra Core (client)\n &checkresult($result); # Check the output for success/failure\n\n # Ask PBXtra Core to read a number to the caller\n print STDERR \"2. Testing 'saynumber'...\";\n print CLIENT \"SAY NUMBER 192837465 \\\"\\\"\\n\";\n my $result = ;\n &checkresult($result);\n\n # Ask PBXtra Core to read a number to wait 1 second for a digit\n print STDERR \"3. Testing 'waitdtmf'...\";\n print CLIENT \"WAIT FOR DIGIT 1000\\n\"; # Wait 1 sec (1000 ms) for digit\n my $result = ;\n &checkresult($result);\n\n # Ask PBXtra Core to record sound in a file\n print STDERR \"4. Testing 'record'...\";\n print CLIENT \"RECORD FILE testagi gsm 1234 3000\\n\";\n my $result = ;\n &checkresult($result);\n\n # Play back the file we recorded\n print STDERR \"5. Testing 'record' playback...\";\n print CLIENT \"STREAM FILE testagi \\\"\\\"\\n\";\n my $result = ;\n &checkresult($result);\n close(CLIENT);\n \n print STDERR \"================== Complete ======================\\n\";\n print STDERR \"$tests tests completed, $pass passed, $fail failed\\n\";\n print STDERR \"==================================================\\n\";\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Compatibility","type":"text"}]},{"type":"paragraph","content":[{"text":"The FON interface is 100% interface compatible with FastAGI. You can use any FastAGI development library you wish. The FON Interface for PBXtra Core improves efficiency over AGI, and allows for continued execution of your call menu if you ever have a problem with your FON Interface Script.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Languages","type":"text"}]},{"type":"paragraph","content":[{"text":"You may write FON Interface Scripts in any language you wish. They must be able to read input on STDIN, write output on STDOUT, and must be able to implement a simple request loop. See the sample script above for a working implementation. Technically speaking the FON Interface Script is a TCP/IP server program. Here are some other programming aids:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Erlang","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"ErlAst","type":"text","marks":[{"type":"link","attrs":{"href":"http://tools.assembla.com/erlast"}}]},{"text":" - A multi-threaded FastAGI server written in Erlang which lets you do your call control in Erlang.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"StarPy","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.vrplumber.com/programming/starpy/"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Java","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Asterisk-java","type":"text","marks":[{"type":"link","attrs":{"href":"http://asterisk-java.org/"}}]},{"text":" FastAGI server allows you to write your AGI scripts in Java.","type":"text"}]},{"type":"paragraph","content":[{"text":"Jast Agi","type":"text","marks":[{"type":"link","attrs":{"href":"http://tanesha.net/Wiki/JastAgi.html"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Perl","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Asterisk::FastAGI","type":"text","marks":[{"type":"link","attrs":{"href":"http://search.cpan.org/perldoc?Asterisk%3A%3AFastAGI"}}]},{"text":" Allows you to easily write FastAGI scripts in Perl.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Programming Tips","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that each call will occupy your FastAGI server for its duration until you set a context and priority sequence number and exit, allowing the call to continue to flow through your system as indicated. To support multiple callers at once you will want to employ a pre-fork multi-process server or a multi-threaded server to allow multiple calls at once. For Perl, consider the Net::Server::Prefork library.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you decide to multi-thread, and you will have a high call volume, be careful. The default stack size is set to 2MB, and you may quickly soak up a lot of memory, and waste a lot of system resources allocating new threads. Consider using a thread pool so you can create all the threads you need at startup.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"NOTE","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"For performance and stability reasons, please do not consider loading MySQL or any other database engine on the PBXtra server directly. If your application will use a database, then run it on a separate server and connect to it over a socket connection. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Environment Variables","type":"text"}]},{"type":"paragraph","content":[{"text":"The following environment variables will be available to your FON Interface Script upon execution. Note that the values will be set dynamically based on the channel information on your inbound call.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accountcode =","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"callerid = \"Fonality\" <8773662548>","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"channel = Zap/1-1","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"context = icoming","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dnid = unknown","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"enhanced = 0.0","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"extension = s","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"language = en","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"network = yes","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"priority = 1","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rdnis = unknown","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"request = agi://127.0.0.1","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type = Zap","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"uniqueid = 1096425459.28","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"FON Interface API Reference","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ANSWER","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Answer channel if not already in answer state.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns -1 on channel failure, or 0 if successful.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"AUTOHANGUP ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Cause the channel to automatically hangup at seconds in the future. If is 0 then the auto-hangup feature is disabled on this channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns 0","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"paragraph","content":[{"text":"If the channel is hungup prior to seconds, this setting has no effect.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"CHANNEL STATUS []","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Return the status of the specified channel. If no channel name is specified, return the status of the current channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns -1 There is no channel that matches the given 0 Channel is down and available 1 Channel is down, but reserved 2 Channel is off hook 3 Digits (or equivalent) have been dialed 4 Line is ringing 5 Remote end is ringing 6 Line is up 7 Line is busy","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Examples CHANNEL STATUS Return the status of the current channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"CHANNEL STATUS Zap/9-1 Return the status of channel Zap/9-1","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"paragraph","content":[{"text":"The to use is the same as the channel names reported by the Asterisk console 'show channels' command.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"EXEC ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Executes the specified Asterisk with given .","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Whatever the application returns, or -2 on failure to find the application.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following list details all of the applications that can be invoked within the PBXtra Core software using the EXEC interface command.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"AbsoluteTimeout: Set absolute maximum time of call","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'AbsoluteTimeout' -- \n \n [Synopsis]\n Set absolute maximum time of call\n \n [Description]\n AbsoluteTimeout(seconds): This application will set the absolute maximum\n amount of time permitted for a call. A setting of 0 disables the timeout.\n AbsoluteTimeout has been deprecated in favor of Set(TIMEOUT(absolute)=timeout)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"AddQueueMember: Dynamically adds queue members","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'AddQueueMember' -- \n \n [Synopsis]\n Dynamically adds queue members\n \n [Description]\n AddQueueMember(queuename[|interface[|penalty[|options]]]):\n Dynamically adds interface to an existing queue.\n If the interface is already in the queue and there exists an n+101 priority\n then it will then jump to this priority. Otherwise it will return an error\n The option string may contain zero or more of the following characters:\n 'j' -- jump to +101 priority when appropriate.\n This application sets the following channel variable upon completion:\n AQMSTATUS The status of the attempt to add a queue member as a \n text string, one of\n ADDED | MEMBERALREADY | NOSUCHQUEUE \n Example: AddQueueMember(techsupport|SIP/3000)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ADSIProg: Load Asterisk ADSI Scripts into phone","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'ADSIProg' -- \n \n [Synopsis]\n Load Asterisk ADSI Scripts into phone\n \n [Description]\n ADSIProg(script): This application programs an ADSI Phone with the given\n script. If nothing is specified, the default script (asterisk.adsi) is used.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"AGI: Executes an AGI compliant application","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'AGI' -- \n \n [Synopsis]\n Executes an AGI compliant application\n \n [Description]\n [E|Dead]AGI(command|args): Executes an Asterisk Gateway Interface compliant\n program on a channel. AGI allows Asterisk to launch external programs\n written in any language to control a telephony channel, play audio,\n read DTMF digits, etc. by communicating with the AGI protocol on stdin\n and stdout.\n Returns -1 on hangup (except for DeadAGI) or if application requested\n hangup, or 0 on non-hangup exit. \n Using 'EAGI' provides enhanced AGI, with incoming audio available out of band\n on file descriptor 3\n \n Use the CLI command 'show agi' to list available agi commands","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"AlarmReceiver: Provide support for receving alarm reports from a burglar or fire alarm panel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'AlarmReceiver' -- \n \n [Synopsis]\n Provide support for receving alarm reports from a burglar or fire alarm panel\n \n [Description]\n AlarmReceiver(): Only 1 signalling format is supported at this time: Ademco\n Contact ID. This application should be called whenever there is an alarm\n panel calling in to dump its events. The application will handshake with the\n alarm panel, and receive events, validate them, handshake them, and store them\n until the panel hangs up. Once the panel hangs up, the application will run the\n system command specified by the eventcmd setting in alarmreceiver.conf and pipe\n the events to the standard input of the application. The configuration file also\n contains settings for DTMF timing, and for the loudness of the acknowledgement\n tones.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Answer: Answer a channel if ringing","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'Answer' -- \n \n [Synopsis]\n Answer a channel if ringing\n \n [Description]\n Answer([delay]): If the call has not been answered, this application will\n answer it. Otherwise, it has no effect on the call. If a delay is specified,\n Asterisk will wait this number of milliseconds before answering the call.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"AppendCDRUserField: Append to the CDR user field","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'AppendCDRUserField' -- \n \n [Synopsis]\n Append to the CDR user field\n \n [Description]\n [Synopsis]\n AppendCDRUserField(value)\n \n [Description]\n AppendCDRUserField(value): Append value to the CDR user field\n The Call Data Record (CDR) user field is an extra field you\n can use for data not stored anywhere else in the record.\n CDR records can be used for billing or storing other arbitrary data\n (I.E. telephone survey responses)\n Also see SetCDRUserField().","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Authenticate: Authenticate a user","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'Authenticate' -- \n \n [Synopsis]\n Authenticate a user\n \n [Description]\n Authenticate(password[|options]): This application asks the caller to enter a\n given password in order to continue dialplan execution. If the password begins\n with the '/' character, it is interpreted as a file which contains a list of\n valid passwords, listed 1 password per line in the file.\n When using a database key, the value associated with the key can be anything.\n Users have three attempts to authenticate before the channel is hung up. If the\n passsword is invalid, the 'j' option is specified, and priority n+101 exists,\n dialplan execution will continnue at this location.\n Options:\n a - Set the channels' account code to the password that is entered\n d - Interpret the given path as database key, not a literal file\n j - Support jumping to n+101 if authentication fails\n m - Interpret the given path as a file which contains a list of account\n codes and password hashes delimited with ':', listed one per line in\n the file. When one of the passwords is matched, the channel will have\n its account code set to the corresponding account code in the file.\n r - Remove the database key upon successful entry (valid with 'd' only)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"BackGround: Play a file while awaiting extension","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'BackGround' -- \n \n [Synopsis]\n Play a file while awaiting extension\n \n [Description]\n Background(filename1[&filename2...][|options[|langoverride][|context]]):\n This application will play the given list of files while waiting for an\n extension to be dialed by the calling channel. To continue waiting for digits\n after this application has finished playing files, the WaitExten application\n should be used. The 'langoverride' option explicity specifies which language\n to attempt to use for the requested sound files. If a 'context' is specified,\n this is the dialplan context that this application will use when exiting to a\n dialed extension. If one of the requested sound files does not exist, call\nprocessing will be\n terminated.\n Options:\n s - causes the playback of the message to be skipped\n if the channel is not in the 'up' state (i.e. it\n hasn't been answered yet.) If this happens, the\n application will return immediately.\n n - don't answer the channel before playing the files\n m - only break if a digit hit matches a one digit\n extension in the destination context","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"BackgroundDetect: Background a file with talk detect","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'BackgroundDetect' -- \n \n [Synopsis]\n Background a file with talk detect\n \n [Description]\n BackgroundDetect(filename[|sil[|min|[max]]]): Plays back a given\n filename, waiting for interruption from a given digit (the digit must\n start the beginning of a valid extension, or it will be ignored).\n During the playback of the file, audio is monitored in the receive\n direction, and if a period of non-silence which is greater than 'min' ms\n yet less than 'max' ms is followed by silence for at least 'sil' ms then\n the audio playback is aborted and processing jumps to the 'talk' extension\n if available. If unspecified, sil, min, and max default to 1000, 100, and\n infinity respectively.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Busy: Indicate the Busy condition","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Busy' -- \n \n [Synopsis]\n Indicate the Busy condition\n \n [Description]\n Busy([timeout]): This application will indicate the busy condition to\n the calling channel. If the optional timeout is specified, the calling channel\n will be hung up after the specified number of seconds. Otherwise, this\n application will wait until the calling channel hangs up.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ChangeMonitor: Change monitoring filename of a channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ChangeMonitor' -- \n \n [Synopsis]\n Change monitoring filename of a channel\n \n [Description]\n ChangeMonitor(filename_base)\n Changes monitoring filename of a channel. Has no effect if the channel is not\nmonitored\n The argument is the new filename base to use for monitoring this channel.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ChanInUse: Checks to see if channel is in use","type":"text"}]},{"type":"codeBlock","content":[{"text":" -= Info about application 'ChanInUse' =-\n\n [Synopsis]\n Checks to see if channel is on a call.\n\n [Description]\n ChanInUse(Location[|[!]Context]):\n Checks to see if the specific channel is on a call, or optionally\n on a call in a specific Context.\n If Context is negated with \"!\", checks if the channel is on a call\n *not* in the specified Context.\n Jumps to n+101 priority if it is on a call as specified.\n Returns -1 if there is an error.\n Example: ChanInUse(SIP/0004F2123456|neoagent)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ChanIsAvail: Check channel availability","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ChanIsAvail' -- \n \n [Synopsis]\n Check channel availability\n \n [Description]\n ChanIsAvail(Technology/resource[&Technology2/resource2...][|options]): \n This application will check to see if any of the specified channels are\n available. The following variables will be set by this application:\n ${AVAILCHAN} - the name of the available channel, if one exists\n ${AVAILORIGCHAN} - the canonical channel name that was used to create the channel\n ${AVAILSTATUS} - the status code for the available channel\n Options:\n s - Consider the channel unavailable if the channel is in use at all\n j - Support jumping to priority n+101 if no channel is available","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ChanSpy: Listen to the audio of an active channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ChanSpy' -- \n \n [Synopsis]\n Listen to the audio of an active channel\n \n \n [Description]\n ChanSpy([chanprefix][|options]): This application is used to listen to the\n audio from an active Asterisk channel. This includes the audio coming in and\n out of the channel being spied on. If the 'chanprefix' parameter is specified,\n only channels beginning with this string will be spied upon.\n While Spying, the following actions may be performed:\n - Dialing # cycles the volume level.\n - Dialing * will stop spying and look for another channel to spy on.\n - Dialing a series of digits followed by # builds a channel name to append\n to 'chanprefix'. For example, executing ChanSpy(Agent) and then dialing\n the digits '1234#' while spying will begin spying on the channel,\n 'Agent/1234'.\n Options:\n b - Only spy on channels involved in a bridged call.\n g(grp) - Match only channels where their ${SPYGROUP} variable is set to\n 'grp'.\n q - Don't play a beep when beginning to spy on a channel.\n r[(basename)] - Record the session to the monitor spool directory. An\n optional base for the filename may be specified. The\n default is 'chanspy'.\n v([value]) - Adjust the initial volume in the range from -4 to 4. A\n negative value refers to a quieter setting.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"CheckGroup: Check the channel count of a group against a limit","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'CheckGroup' -- \n \n [Synopsis]\n Check the channel count of a group against a limit\n \n [Description]\n Usage: CheckGroup(max[@category][|options])\n Checks that the current number of total channels in the\n current channel's group does not exceed 'max'. If the number\n does not exceed 'max', we continue to the next step. \n The option string may contain zero of the following character:\n 'j' -- jump to n+101 priority if the number does in fact exceed max,\n and priority n+101 exists. Execuation then continues at that\n step, otherwise -1 is returned.\n This application sets the following channel variable upon successful completion:\n CHECKGROUPSTATUS The status of the check that the current channel's\n group does not exceed 'max'. It's value is one of\n OK | OVERMAX ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Congestion: Indicate the Congestion condition","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'Congestion' -- \n \n [Synopsis]\n Indicate the Congestion condition\n \n [Description]\n Congestion([timeout]): This application will indicate the congenstion\n condition to the calling channel. If the optional timeout is specified, the\n calling channel will be hung up after the specified number of seconds.\n Otherwise, this application will wait until the calling channel hangs up.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ControlPlayback: Play a file with fast forward and rewind","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ControlPlayback' -- \n \n [Synopsis]\n Play a file with fast forward and rewind\n \n [Description]\n ControlPlayback(file[|skipms[|ff[|rew[|stop[|pause[|restart|options]]]]]]]):\n This application will play back the given filename. By default, the '*' key\n can be used to rewind, and the '#' key can be used to fast-forward.\n Parameters:\n skipms - This is number of milliseconds to skip when rewinding or\n fast-forwarding.\n ff - Fast-forward when this DTMF digit is received.\n rew - Rewind when this DTMF digit is received.\n stop - Stop playback when this DTMF digit is received.\n pause - Pause playback when this DTMF digit is received.\n restart - Restart playback when this DTMF digit is received.\n Options:\n j - Jump to priority n+101 if the requested file is not found.\n This application sets the following channel variable upon completion:\n CPLAYBACKSTATUS - This variable contains the status of the attempt as a text\n string, one of: SUCCESS | USERSTOPPED | ERROR","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Curl: Load an external URL","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Curl' -- \n \n [Synopsis]\n Load an external URL\n \n [Description]\n Curl(URL[|postdata]): This application will request the specified URL.\n It is mainly used for signalling external applications of an event.\n Parameters:\n URL - This is the external URL to request.\n postdata - This information will be treated as POST data.\n This application will set the following variable:\n CURL - This variable will contain the resulting page.\n This application has been deprecated in favor of the CURL function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Cut: Splits a variable's contents using the specified delimiter","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Cut' -- \n \n [Synopsis]\n Splits a variable's contents using the specified delimiter\n \n [Description]\n Cut(newvar=varname,delimiter,fieldspec): This applicaiton will split the\n contents of a variable based on the given delimeter and store the result in\n a new variable.\n Parameters:\n newvar - new variable created from result string\n varname - variable you want cut\n delimiter - defaults to '-'\n fieldspec - number of the field you want (1-based offset)\n may also be specified as a range (with -)\n or group of ranges and fields (with &)\n This application has been deprecated in favor of the CUT function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DateTime: Says a specified time in a custom format","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DateTime' -- \n \n [Synopsis]\n Says a specified time in a custom format\n \n [Description]\n DateTime([unixtime][|[timezone][|format]])\n unixtime: time, in seconds since Jan 1, 1970. May be negative.\n defaults to now.\n timezone: timezone, see /usr/share/zoneinfo for a list.\n defaults to machine default.\n format: a format the time is to be said in. See voicemail.conf.\n defaults to \"ABdY 'digits/at' IMp\"","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DBdel: Delete a key from the database","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DBdel' -- \n \n [Synopsis]\n Delete a key from the database\n \n [Description]\n DBdel(family/key): This applicaiton will delete a key from the Asterisk\n database.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DBdeltree: Delete a family or keytree from the database","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DBdeltree' -- \n \n [Synopsis]\n Delete a family or keytree from the database\n \n [Description]\n DBdeltree(family[/keytree]): This application will delete a family or keytree\n from the Asterisk database","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DBget: Retrieve a value from the database","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DBget' -- \n \n [Synopsis]\n Retrieve a value from the database\n \n [Description]\n DBget(varname=family/key[|options]): This application will retrieve a value\n from the Asterisk database and store it in the given variable.\n Options:\n j - Jump to priority n+101 if the requested family/key isn't found.\n This application sets the following channel variable upon completion:\n DBGETSTATUS - This variable will contain the status of the attempt\n FOUND | NOTFOUND \n This application has been deprecated in favor of the DB function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DBput: Store a value in the database","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DBput' -- \n \n [Synopsis]\n Store a value in the database\n \n [Description]\n DBput(family/key=value): This application will store the given value in the\n specified location in the Asterisk database.\n This application has been deprecated in favor of the DB function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DeadAGI: Executes AGI on a hungup channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DeadAGI' -- \n \n [Synopsis]\n Executes AGI on a hungup channel\n \n [Description]\n [E|Dead]AGI(command|args): Executes an Asterisk Gateway Interface compliant\n program on a channel. AGI allows Asterisk to launch external programs\n written in any language to control a telephony channel, play audio,\n read DTMF digits, etc. by communicating with the AGI protocol on stdin\n and stdout.\n Returns -1 on hangup (except for DeadAGI) or if application requested\n hangup, or 0 on non-hangup exit. \n Using 'EAGI' provides enhanced AGI, with incoming audio available out of band\n on file descriptor 3\n \n Use the CLI command 'show agi' to list available agi commands\n ]","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Dial: Place a call and connect to the current channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Dial' -- \n \n [Synopsis]\n Place a call and connect to the current channel\n \n [Description]\n Dial(Technology/resource[&Tech2/resource2...][|timeout][|options][|URL]):\n This applicaiton will place calls to one or more specified channels. As soon\n as one of the requested channels answers, the originating channel will be\n answered, if it has not already been answered. These two channels will then\n be active in a bridged call. All other channels that were requested will then\n be hung up.\n Unless there is a timeout specified, the Dial application will wait\n indefinitely until one of the called channels answers, the user hangs up, or\n if all of the called channels are busy or unavailable. Dialplan executing will\n continue if no requested channels can be called, or if the timeout expires.\n \n This application sets the following channel variables upon completion:\n DIALEDTIME - This is the time from dialing a channel until when it\n is disconnected.\n ANSWEREDTIME - This is the amount of time for actual call.\n DIALSTATUS - This is the status of the call:\n CHANUNAVAIL | CONGESTION | NOANSWER | BUSY | ANSWER | CANCEL\n DONTCALL | TORTURE\n For the Privacy and Screening Modes, the DIALSTATUS variable will be set to\n DONTCALL if the called party chooses to send the calling party to the 'Go Away'\n script. The DIALSTATUS variable will be set to TORTURE if the called party\n wants to send the caller to the 'torture' script.\n This application will report normal termination if the originating channel\n hangs up, or if the call is bridged and either of the parties in the bridge\n ends the call.\n The optional URL will be sent to the called party if the channel supports it.\n If the OUTBOUND_GROUP variable is set, all peer channels created by this\n application will be put into that group (as in Set(GROUP()=...).\n \n Options:\n A(x) - Play an announcement to the called party, using 'x' as the file.\n C - Reset the CDR for this call.\n d - Allow the calling user to dial a 1 digit extension while waiting for\n a call to be answered. Exit to that extension if it exists in the\n current context, or the context defined in the EXITCONTEXT variable,\n if it exists.\n D([called][:calling]) - Send the specified DTMF strings *after* the called\n party has answered, but before the call gets bridged. The 'called'\n DTMF string is sent to the called party, and the 'calling' DTMF\n string is sent to the calling party. Both parameters can be used\n alone.\n f - Force the callerid of the *calling* channel to be set as the\n extension associated with the channel using a dialplan 'hint'.\n For example, some PSTNs do not allow CallerID to be set to anything\n other than the number assigned to the caller.\n g - Proceed with dialplan execution at the current extension if the\n destination channel hangs up.\n G(context^exten^pri) - If the call is answered, transfer the calling party to\n the specified priority and the called party to the specified priority+1.\n Optionally, an extension, or extension and context may be specified. \n Otherwise, the current extension is used. You cannot use any additional\n action post answer options in conjunction with this option.\n h - Allow the called party to hang up by sending the '*' DTMF digit.\n H - Allow the calling party to hang up by hitting the '*' DTMF digit.\n j - Jump to priority n+101 if all of the requested channels were busy.\n L(x[:y][:z]) - Limit the call to 'x' ms. Play a warning when 'y' ms are\n left. Repeat the warning every 'z' ms. The following special\n variables can be used with this option:\n * LIMIT_PLAYAUDIO_CALLER yes|no (default yes)\n Play sounds to the caller.\n * LIMIT_PLAYAUDIO_CALLEE yes|no\n Play sounds to the callee.\n * LIMIT_TIMEOUT_FILE File to play when time is up.\n * LIMIT_CONNECT_FILE File to play when call begins.\n * LIMIT_WARNING_FILE File to play as warning if 'y' is defined.\n The default is to say the time remaining.\n m([class]) - Provide hold music to the calling party until a requested\n channel answers. A specific MusicOnHold class can be\n specified.\n M(x[^arg]) - Execute the Macro for the *called* channel before connecting\n to the calling channel. Arguments can be specified to the Macro\n using '^' as a delimeter. The Macro can set the variable\n MACRO_RESULT to specify the following actions after the Macro is\n finished executing.\n * ABORT Hangup both legs of the call.\n * CONGESTION Behave as if line congestion was encountered.\n * BUSY Behave as if a busy signal was encountered. This will also\n have the application jump to priority n+101 if the\n 'j' option is set.\n * CONTINUE Hangup the called party and allow the calling party\n to continue dialplan execution at the next priority.\n * GOTO:^^ - Transfer the call to the\n specified priority. Optionally, an extension, or\n extension and priority can be specified.\n You cannot use any additional action post answer options in conjunction\n with this option.\n n - This option is a modifier for the screen/privacy mode. It specifies\n that no introductions are to be saved in the priv-callerintros\n directory.\n N - This option is a modifier for the screen/privacy mode. It specifies\n that if callerID is present, do not screen the call.\n o - Specify that the CallerID that was present on the *calling* channel\n be set as the CallerID on the *called* channel. This was the\n behavior of Asterisk 1.0 and earlier.\n p - This option enables screening mode. This is basically Privacy mode\n without memory.\n P([x]) - Enable privacy mode. Use 'x' as the family/key in the database if\n it is provided. The current extension is used if a database\n family/key is not specified.\n r - Indicate ringing to the calling party. Pass no audio to the calling\n party until the called channel has answered.\n S(x) - Hang up the call after 'x' seconds *after* the called party has\n answered the call.\n t - Allow the called party to transfer the calling party by sending the\n DTMF sequence defined in features.conf.\n T - Allow the calling party to transfer the called party by sending the\n DTMF sequence defined in features.conf.\n w - Allow the called party to enable recording of the call by sending\n the DTMF sequence defined for one-touch recording in features.conf.\n W - Allow the calling party to enable recording of the call by sending\n the DTMF sequence defined for one-touch recording in features.conf.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Dictate: Virtual Dictation Machine","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Dictate' -- \n \n [Synopsis]\n Virtual Dictation Machine\n \n [Description]\n Dictate([])\n Start dictation machine using optional base dir for files.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DigitTimeout: Set maximum timeout between digits","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DigitTimeout' -- \n \n [Synopsis]\n Set maximum timeout between digits\n \n [Description]\n DigitTimeout(seconds): Set the maximum amount of time permitted between\n digits when the user is typing in an extension. When this timeout expires,\n after the user has started to type in an extension, the extension will be\n considered complete, and will be interpreted. Note that if an extension\n typed in is valid, it will not have to timeout to be tested, so typically\n at the expiry of this timeout, the extension will be considered invalid\n (and thus control would be passed to the 'i' extension, or if it doesn't\n exist the call would be terminated). The default timeout is 5 seconds.\n DigitTimeout has been deprecated in favor of Set(TIMEOUT(digit)=timeout)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directory: Provide directory of voicemail extensions","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Directory' -- \n \n [Synopsis]\n Provide directory of voicemail extensions\n \n [Description]\n Directory(vm-context[|dial-context[|options]]): This application will present\n the calling channel with a directory of extensions from which they can search\n by name. The list of names and corresponding extensions is retrieved from the\n voicemail configuration file, voicemail.conf.\n This applicaiton will immediate exit if one of the following DTMF digits are\n received and the extension to jump to exists:\n 0 - Jump to the 'o' extension, if it exists.\n * - Jump to the 'a' extension, if it exists.\n \n Parameters:\n vm-context - This is the context within voicemail.conf to use for the\n Directory.\n dial-context - This is the dialplan context to use when looking for an\n extension that the user has selected, or when jumping to the\n 'o' or 'a' extension.\n \n Options:\n f - Allow the caller to enter the first name of a user in the directory\n instead of using the last name.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DISA: DISA (Direct Inward System Access)","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DISA' -- \n \n [Synopsis]\n DISA (Direct Inward System Access)\n \n [Description]\n DISA([|]) or disa()\n The DISA, Direct Inward System Access, application allows someone from \n outside the telephone switch (PBX) to obtain an \"internal\" system \n dialtone and to place calls from it as if they were placing a call from \n within the switch.\n DISA plays a dialtone. The user enters their numeric passcode, followed by\n the pound sign (#). If the passcode is correct, the user is then given\n system dialtone on which a call may be placed. Obviously, this type\n of access has SERIOUS security implications, and GREAT care must be\n taken NOT to compromise your security.\n \n There is a possibility of accessing DISA without password. Simply\n exchange your password with \"no-password\".\n \n Example: exten => s,1,DISA(no-password|local)\n \n Be aware that using this compromises the security of your PBX.\n \n The arguments to this application (in extensions.conf) allow either\n specification of a single global passcode (that everyone uses), or\n individual passcodes contained in a file. It also allow specification\n of the context on which the user will be dialing. If no context is\n specified, the DISA application defaults the context to \"disa\".\n Presumably a normal system will have a special context set up\n for DISA use with some or a lot of restrictions. \n \n The file that contains the passcodes (if used) allows specification\n of either just a passcode (defaulting to the \"disa\" context, or\n passcode|context on each line of the file. The file may contain blank\n lines, or comments starting with \"#\" or \";\". In addition, the\n above arguments may have |new-callerid-string appended to them, to\n specify a new (different) callerid to be used for this call, for\n example: numeric-passcode|context|\"My Phone\" <(234) 123-4567> or \n full-pathname-of-passcode-file|\"My Phone\" <(234) 123-4567>. Last\n but not least, |mailbox[@context] may be appended, which will cause\n a stutter-dialtone (indication \"dialrecall\") to be used, if the\n specified mailbox contains any new messages, for example:\n numeric-passcode|context||1234 (w/a changing callerid). Note that\n in the case of specifying the numeric-passcode, the context must be\n specified if the callerid is specified also.\n \n If login is successful, the application looks up the dialed number in\n the specified (or default) context, and executes it if found.\n If the user enters an invalid extension and extension \"i\" (invalid) \n exists in the context, it will be used.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DumpChan: Dump Info About The Calling Channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DumpChan' -- \n \n [Synopsis]\n Dump Info About The Calling Channel\n \n [Description]\n DumpChan([])\n Displays information on channel and listing of all channel\n variables. If min_verbose_level is specified, output is only\n displayed when the verbose level is currently set to that number\n or greater. ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DUNDiLookup: Look up a number with DUNDi","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'DUNDiLookup' -- \n \n [Synopsis]\n Look up a number with DUNDi\n \n [Description]\n DUNDiLookup(number[|context[|options]])\n Looks up a given number in the global context specified or in\n the reserved 'e164' context if not specified. Returns -1 if the channel\n is hungup during the lookup or 0 otherwise. On completion, the variable\n ${DUNDTECH} and ${DUNDDEST} will contain the technology and destination\n of the appropriate technology and destination to access the number. If no\n answer was found, and the priority n + 101 exists, execution will continue\n at that location. Note that this will only occur if the global priority\n jumping option is enabled in extensions.conf. If the 'b' option is specified,\n the internal DUNDi cache will by bypassed.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"EAGI: Executes an EAGI compliant application","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'EAGI' -- \n \n [Synopsis]\n Executes an EAGI compliant application\n \n [Description]\n [E|Dead]AGI(command|args): Executes an Asterisk Gateway Interface compliant\n program on a channel. AGI allows Asterisk to launch external programs\n written in any language to control a telephony channel, play audio,\n read DTMF digits, etc. by communicating with the AGI protocol on stdin\n and stdout.\n Returns -1 on hangup (except for DeadAGI) or if application requested\n hangup, or 0 on non-hangup exit. \n Using 'EAGI' provides enhanced AGI, with incoming audio available out of band\n on file descriptor 3\n \n Use the CLI command 'show agi' to list available agi commands","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Echo: Echo audio read back to the user","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Echo' -- \n \n [Synopsis]\n Echo audio read back to the user\n \n [Description]\n Echo(): Echo audio read from channel back to the channel. \n User can exit the application by either pressing the '#' key, \n or hanging up.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"EndWhile: End A While Loop","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'EndWhile' -- \n \n [Synopsis]\n End A While Loop\n \n [Description]\n Usage: EndWhile()\n Return to the previous called While","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"EnumLookup: Lookup number in ENUM","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'EnumLookup' -- \n \n [Synopsis]\n Lookup number in ENUM\n \n [Description]\n EnumLookup(exten[|option]): Looks up an extension via ENUM and sets\n the variable 'ENUM'. For VoIP URIs this variable will \n look like 'TECHNOLOGY/URI' with the appropriate technology.\n Currently, the enumservices SIP, H323, IAX, IAX2 and TEL are recognized. \n \n Returns status in the ENUMSTATUS channel variable:\n ERROR Failed to do a lookup\n Technology of the successful lookup: SIP, H323, IAX, IAX2 or TEL\n BADURI Got URI Asterisk does not understand.\n The option string may contain zero or the following character:\n 'j' -- jump to +101 priority if the lookup isn't successful.\n and jump to +51 priority on a TEL entry.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Eval: Evaluates a string","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Eval' -- \n \n [Synopsis]\n Evaluates a string\n \n [Description]\n Usage: Eval(newvar=somestring)\n Normally Asterisk evaluates variables inline. But what if you want to\n store variable offsets in a database, to be evaluated later? Eval is\n the answer, by allowing a string to be evaluated twice in the dialplan,\n the first time as part of the normal dialplan, and the second using Eval.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Exec: Executes internal application","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Exec' -- \n \n [Synopsis]\n Executes internal application\n \n [Description]\n Usage: Exec(appname(arguments))\n Allows an arbitrary application to be invoked even when not\n hardcoded into the dialplan. To invoke external applications\n see the application System. Returns whatever value the\n app returns or a non-zero value if the app cannot be found.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ExecIf: Conditional exec","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ExecIf' -- \n \n [Synopsis]\n Conditional exec\n \n [Description]\n Usage: ExecIF (||)\n If is true, execute and return the result of ().\n If is true, but is not found, then the application\n will return a non-zero value.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ExecIfTime: Conditional application execution based on the current time","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ExecIfTime' -- \n \n [Synopsis]\n Conditional application execution based on the current time\n \n [Description]\n ExecIfTime(|||?appname[|appargs]):\n This application will execute the specified dialplan application, with optional\n arguments, if the current time matches the given time specification. Further\n information on the time speicification can be found in examples illustrating\n how to do time-based context includes in the dialplan.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ExternalIVR: Interfaces with an external IVR application","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ExternalIVR' -- \n \n [Synopsis]\n Interfaces with an external IVR application\n \n [Description]\n ExternalIVR(command[|arg[|arg...]]): Forks an process to run the supplied command,\n and starts a generator on the channel. The generator's play list is\n controlled by the external application, which can add and clear entries\n via simple commands issued over its stdout. The external application\n will receive all DTMF events received on the channel, and notification\n if the channel is hung up. The application will not be forcibly terminated\n when the channel is hung up.\n See doc/README.externalivr for a protocol specification.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Festival: Say text to the user","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Festival' -- \n \n [Synopsis]\n Say text to the user\n \n [Description]\n Festival(text[|intkeys]): Connect to Festival, send the argument, get back the\nwaveform,play it to the user, allowing any given interrupt keys to immediately\nterminate and return\n the value, or 'any' to allow any number back (useful in dialplan)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Flash: Flashes a Zap Trunk","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Flash' -- \n \n [Synopsis]\n Flashes a Zap Trunk\n \n [Description]\n Flash(): Sends a flash on a zap trunk. This is only a hack for\n people who want to perform transfers and such via AGI and is generally\n quite useless oths application will only work on Zap trunks.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"FlushQueueStats: Flushes stats for specified queue","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'FlushQueueStats' -- \n \n [Synopsis]\n Flushes stats for specified queue\n \n [Description]\n FlushQueueStats(queuename):\n Flushes the stats for specified queue.\n Returns -1 if there is an error.\n Example: FlushQueueStats(techsupport)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ForkCDR: Forks the Call Data Record","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ForkCDR' -- \n \n [Synopsis]\n Forks the Call Data Record\n \n [Description]\n ForkCDR([options]): Causes the Call Data Record to fork an additional\n cdr record starting from the time of the fork call\n If the option 'v' is passed all cdr variables will be passed along also.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"GetCPEID: Get ADSI CPE ID","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'GetCPEID' -- \n \n [Synopsis]\n Get ADSI CPE ID\n \n [Description]\n GetCPEID: Obtains and displays ADSI CPE ID and other information in order\n to properly setup zapata.conf for on-hook operations.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"GetGroupCount: Get the channel count of a group","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'GetGroupCount' -- \n \n [Synopsis]\n Get the channel count of a group\n \n [Description]\n Usage: GetGroupCount([groupname][@category])\n Calculates the group count for the specified group, or uses\n the current channel's group if not specifed (and non-empty).\n Stores result in GROUPCOUNT. \n Note: This application has been deprecated, please use the function\n GROUP_COUNT.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"GetGroupMatchCount: Get the channel count of all groups that match a pattern","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'GetGroupMatchCount' -- \n \n [Synopsis]\n Get the channel count of all groups that match a pattern\n \n [Description]\n Usage: GetGroupMatchCount(groupmatch[@category])\n Calculates the group count for all groups that match the specified\n pattern. Uses standard regular expression matching (see regex(7)).\n Stores result in GROUPCOUNT. Always returns 0.\n Note: This application has been deprecated, please use the function\n GROUP_MATCH_COUNT.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Gosub: Jump to label, saving return address","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Gosub' -- \n \n [Synopsis]\n Jump to label, saving return address\n \n [Description]\n Gosub([[context|]exten|]priority)\n Jumps to the label specified, saving the return address.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"GosubIf: Jump to label, saving return address","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'GosubIf' -- \n \n [Synopsis]\n Jump to label, saving return address\n \n [Description]\n GosubIf(condition?labeliftrue[:labeliffalse])\n If the condition is true, then jump to labeliftrue. If false, jumps to\n labeliffalse, if specified. In either case, a jump saves the return point\n in the dialplan, to be returned to with a Return.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Goto: Jump to a particular priority, extension, or context","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Goto' -- \n \n [Synopsis]\n Jump to a particular priority, extension, or context\n \n [Description]\n Goto([[context|]extension|]priority): This application will cause the\n calling channel to continue dialplan execution at the specified priority.\n If no specific extension, or extension and context, are specified, then this\n application will jump to the specified priority of the current extension.\n If the attempt to jump to another location in the dialplan is not successful,\n then the channel will continue at the next priority of the current extension.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"GotoIf: Conditional goto","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'GotoIf' -- \n \n [Synopsis]\n Conditional goto\n \n [Description]\n GotoIf(condition?[labeliftrue]:[labeliffalse]): This application will cause\n the calling channel to jump to the specified location in the dialplan based on\n the evaluation of the given condition. The channel will continue at\n 'labeliftrue' if the condition is true, or 'labeliffalse' if the condition is\n false. The labels are specified with the same syntax as used within the Goto\n application. If the label chosen by the condition is omitted, no jump is\n performed, but execution continues with the next priority in the dialplan.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"GotoIfTime: Conditional Goto based on the current time","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'GotoIfTime' -- \n \n [Synopsis]\n Conditional Goto based on the current time\n \n [Description]\n GotoIfTime(|||?[[context|]exten|]priority):\n This application will have the calling channel jump to the speicified location\n int the dialplan if the current time matches the given time specification.\n Further information on the time specification can be found in examples\n illustrating how to do time-based context includes in the dialplan.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Hangup: Hang up the calling channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Hangup' -- \n \n [Synopsis]\n Hang up the calling channel\n \n [Description]\n Hangup(): This application will hang up the calling channel.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HasNewVoicemail: Conditionally branches to priority + 101 with the right options set","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'HasNewVoicemail' -- \n \n [Synopsis]\n Conditionally branches to priority + 101 with the right options set\n \n [Description]\n HasNewVoicemail(vmbox[/folder][@context][|varname[|options]])\n Assumes folder 'INBOX' if folder is not specified. Optionally sets to the\nnumber of messages\n in that folder.\n The option string may contain zero of the following character:\n 'j' -- jump to priority n+101, if there is new voicemail in folder 'folder' or INBOX\n This application sets the following channel variable upon completion:\n HASVMSTATUS The result of the new voicemail check returned as a text string as\nfollows\n <# of messages in the folder, 0 for NONE>","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HasVoicemail: Conditionally branches to priority + 101 with the right options set","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'HasVoicemail' -- \n \n [Synopsis]\n Conditionally branches to priority + 101 with the right options set\n \n [Description]\n HasVoicemail(vmbox[/folder][@context][|varname[|options]])\n Optionally sets to the number of messages in that folder. Assumes\nfolder of INBOX if not specified.\n The option string may contain zero or the following character:\n 'j' -- jump to priority n+101, if there is voicemail in the folder indicated.\n This application sets the following channel variable upon completion:\n HASVMSTATUS The result of the voicemail check returned as a text string as follows\n <# of messages in the folder, 0 for NONE>","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"IAX2Provision: Provision a calling IAXy with a given template","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'IAX2Provision' -- \n \n [Synopsis]\n Provision a calling IAXy with a given template\n \n [Description]\n IAX2Provision([template]): Provisions the calling IAXy (assuming\n the calling entity is in fact an IAXy) with the given template or\n default if one is not specified. Returns -1 on error or 0 on success.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ICES: Encode and stream using 'ices'","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ICES' -- \n \n [Synopsis]\n Encode and stream using 'ices'\n \n [Description]\n ICES(config.xml) Streams to an icecast server using ices\n (available separately). A configuration file must be supplied\n for ices (see examples/asterisk-ices.conf). ","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ImportVar: Import a variable from a channel into a new variable","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ImportVar' -- \n \n [Synopsis]\n Import a variable from a channel into a new variable\n \n [Description]\n ImportVar(newvar=channelname|variable): This application imports a variable\n from the specified channel (as opposed to the current one) and stores it as\n a variable in the current channel (the channel that is calling this\n application). Variables created by this application have the same inheritance\n properties as those created with the Set application. See the documentation for\n Set for more information.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LookupBlacklist: Look up Caller*ID name/number from blacklist database","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'LookupBlacklist' -- \n \n [Synopsis]\n Look up Caller*ID name/number from blacklist database\n \n [Description]\n LookupBlacklist(options): Looks up the Caller*ID number on the active\n channel in the Asterisk database (family 'blacklist'). \n The option string may contain the following character:\n 'j' -- jump to n+101 priority if the number/name is found in the blacklist\n This application sets the following channel variable upon completion:\n LOOKUPBLSTATUS The status of the Blacklist lookup as a text string, one of\n FOUND | NOTFOUND\n Example: exten => 1234,1,LookupBlacklist()","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"LookupCIDName: Look up CallerID Name from local database","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'LookupCIDName' -- \n \n [Synopsis]\n Look up CallerID Name from local database\n \n [Description]\n LookupCIDName: Looks up the Caller*ID number on the active\n channel in the Asterisk database (family 'cidname') and sets the\n Caller*ID name. Does nothing if no Caller*ID was received on the\n channel. This is useful if you do not subscribe to Caller*ID\n name delivery, or if you want to change the names on some incoming\n calls.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"Macro: Macro Implementation","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Macro' -- \n \n [Synopsis]\n Macro Implementation\n \n [Description]\n Macro(macroname|arg1|arg2...): Executes a macro using the context\n 'macro-', jumping to the 's' extension of that context and\n executing each step, then returning when the steps end. \n The calling extension, context, and priority are stored in ${MACRO_EXTEN}, \n ${MACRO_CONTEXT} and ${MACRO_PRIORITY} respectively. Arguments become\n ${ARG1}, ${ARG2}, etc in the macro context.\n If you Goto out of the Macro context, the Macro will terminate and control\n will be returned at the location of the Goto.\n If ${MACRO_OFFSET} is set at termination, Macro will attempt to continue\n at priority MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise.\n WARNING: Because of the way Macro is implemented (it executes the priorities\n contained within it via sub-engine), and a fixed per-thread\n memory stack allowance, macros are limited to 7 levels\n of nesting (macro calling macro calling macro, etc.); It\n may be possible that stack-intensive applications in deeply nested\n macros could cause asterisk to crash earlier than this limit.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MacroExit: Exit From Macro","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MacroExit' -- \n \n [Synopsis]\n Exit From Macro\n \n [Description]\n MacroExit():\n Causes the currently running macro to exit as if it had\n ended normally by running out of priorities to execute.\n If used outside a macro, will likely cause unexpected\n behavior.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MacroIf: Conditional Macro Implementation","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MacroIf' -- \n \n [Synopsis]\n Conditional Macro Implementation\n \n [Description]\n MacroIf(?macroname_a[|arg1][:macroname_b[|arg1]])\n Executes macro defined in if is true\n (otherwise if provided)\n Arguments and return values as in application macro()","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MailboxExists: Check to see if Voicemail mailbox exists","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MailboxExists' -- \n \n [Synopsis]\n Check to see if Voicemail mailbox exists\n \n [Description]\n MailboxExists(mailbox[@context][|options]): Check to see if the specified\n mailbox exists. If no voicemail context is specified, the 'default' context\n will be used.\n This application will set the following channel variable upon completion:\n VMBOXEXISTSSTATUS - This will contain the status of the execution of the\n MailboxExists application. Possible values include:\n SUCCESS | FAILED\n \n Options:\n j - Jump to priority n+101 if the mailbox is found.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Math: Performs Mathematical Functions","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Math' -- \n \n [Synopsis]\n Performs Mathematical Functions\n \n [Description]\n Math(returnvar,\n \n Perform floating point calculation on number 1 to number 2 and \n store the result in returnvar. Valid ops are: \n +,-,/,*,%,<,>,>=,<=,==\n and behave as their C equivalents.\n This application has been deprecated in favor of the MATH function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MD5: Calculate MD5 checksum","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MD5' -- \n \n [Synopsis]\n Calculate MD5 checksum\n \n [Description]\n MD5(=): Calculates a MD5 checksum on .\n Returns hash value in a channel variable. ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MD5Check: Check MD5 checksum","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MD5Check' -- \n \n [Synopsis]\n Check MD5 checksum\n \n [Description]\n MD5Check(|[|options]): Calculates a MD5 checksum on \n and compares it with the hash. Returns 0 if is correct for .\n The option string may contain zero or more of the following characters:\n 'j' -- jump to priority n+101 if the hash and string do not match \n This application sets the following channel variable upon completion:\n CHECKMD5STATUS The status of the MD5 check, one of the following\n MATCH | NOMATCH","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MeetMe: MeetMe conference bridge","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MeetMe' -- \n \n [Synopsis]\n MeetMe conference bridge\n \n [Description]\n MeetMe([confno][,[options][,pin]]): Enters the user into a specified MeetMe\nconference.\n If the conference number is omitted, the user will be prompted to enter\n one. \n User can exit the conference by hangup, or if the 'p' option is specified, by\npressing '#'.\n Please note: The Zaptel kernel modules and at least one hardware driver (or ztdummy)\n must be present for conferencing to operate properly. In addition, the\nchan_zap\n channel driver must be loaded for the 'i' and 'r' options to operate\nat all.\n \n The option string may contain zero or more of the following characters:\n 'a' -- set admin mode\n 'A' -- set marked mode\n 'b' -- run AGI script specified in ${MEETME_AGI_BACKGROUND}\n Default: conf-background.agi\n (Note: This does not work with non-Zap channels in the same conference)\n 'c' -- announce user(s) count on joining a conference\n 'd' -- dynamically add conference\n 'D' -- dynamically add conference, prompting for a PIN\n 'e' -- select an empty conference\n 'E' -- select an empty pinless conference\n 'i' -- announce user join/leave\n 'm' -- set monitor only mode (Listen only, no talking)\n 'M' -- enable music on hold when the conference has a single caller\n 'p' -- allow user to exit the conference by pressing '#'\n 'P' -- always prompt for the pin even if it is specified\n 'q' -- quiet mode (don't play enter/leave sounds)\n 'r' -- Record conference (records as ${MEETME_RECORDINGFILE}\n using format ${MEETME_RECORDINGFORMAT}). Default filename is\n meetme-conf-rec-${CONFNO}-${UNIQUEID} and the default format is wav.\n 's' -- Present menu (user or admin) when '*' is received ('send' to menu)\n 't' -- set talk only mode. (Talk only, no listening)\n 'T' -- set talker detection (sent to manager interface and meetme list)\n 'w[()]'\n -- wait until the marked user enters the conference\n 'x' -- close the conference when last marked user exits\n 'X' -- allow user to exit the conference by entering a valid single\n digit extension ${MEETME_EXIT_CONTEXT} or the current context\n if that variable is not defined.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MeetMeAdmin: MeetMe conference Administration","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MeetMeAdmin' -- \n \n [Synopsis]\n MeetMe conference Administration\n \n [Description]\n MeetMeAdmin(confno,command[,user]): Run admin command for conference\n 'e' -- Eject last user that joined\n 'k' -- Kick one user out of conference\n 'K' -- Kick all users out of conference\n 'l' -- Unlock conference\n 'L' -- Lock conference\n 'm' -- Unmute conference\n 'M' -- Mute conference\n 'n' -- Unmute entire conference (except admin)\n 'N' -- Mute entire conference (except admin)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MeetMeCount: MeetMe participant count","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MeetMeCount' -- \n \n [Synopsis]\n MeetMe participant count\n \n [Description]\n MeetMeCount(confno[|var]): Plays back the number of users in the specified\n MeetMe conference. If var is specified, playback will be skipped and the value\n will be returned in the variable. Upon app completion, MeetMeCount will hangup the\n channel, unless priority n+1 exists, in which case priority progress will continue.\n A ZAPTEL INTERFACE MUST BE INSTALLED FOR CONFERENCING FUNCTIONALITY.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Milliwatt: Generate a Constant 1000Hz tone at 0dbm (mu-law)","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Milliwatt' -- \n \n [Synopsis]\n Generate a Constant 1000Hz tone at 0dbm (mu-law)\n \n [Description]\n Milliwatt(): Generate a Constant 1000Hz tone at 0dbm (mu-law)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MixMonitor: Record a call and mix the audio during the recording","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MixMonitor' -- \n \n [Synopsis]\n Record a call and mix the audio during the recording\n \n [Description]\n MixMonitor(.[|[|]])\n \n Records the audio on the current channel to the specified file.\n If the filename is an absolute path, uses that path, otherwise\n creates the file in the configured monitoring directory from\n asterisk.conf.\n \n Valid options:\n a - Append to the file instead of overwriting it.\n b - Only save audio to the file while the channel is bridged.\n Note: does not include conferences.\n v() - Adjust the heard volume by a factor of (range -4 to 4)\n V() - Adjust the spoken volume by a factor of (range -4 to 4)\n W() - Adjust the both heard and spoken volumes by a factor of \n (range -4 to 4)\n \n will be executed when the recording is over\n Any strings matching ^{X} will be unescaped to ${X} and \n all variables will be evaluated at that time.\n The variable MIXMONITOR_FILENAME will contain the filename used to record.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Monitor: Monitor a channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Monitor' -- \n \n [Synopsis]\n Monitor a channel\n \n [Description]\n Monitor([file_format[:urlbase]|[fname_base]|[options]]):\n Used to start monitoring a channel. The channel's input and output\n voice packets are logged to files until the channel hangs up or\n monitoring is stopped by the StopMonitor application.\n file_format optional, if not set, defaults to \"wav\"\n fname_base if set, changes the filename used to the one specified.\n options:\n m - when the recording ends mix the two leg files into one and\n delete the two leg files. If the variable MONITOR_EXEC is set, the\n application referenced in it will be executed instead of\n soxmix and the raw leg files will NOT be deleted automatically.\n soxmix or MONITOR_EXEC is handed 3 arguments, the two leg files\n and a target mixed file name which is the same as the leg file names\n only without the in/out designator.\n If MONITOR_EXEC_ARGS is set, the contents will be passed on as\n additional arguements to MONITOR_EXEC\n Both MONITOR_EXEC and the Mix flag can be set from the\n administrator interface\n \n b - Don't begin recording unless a call is bridged to another channel\n \n Returns -1 if monitor files can't be opened or if the channel is already\n monitored, otherwise 0.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MP3Player: Play an MP3 file or stream","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MP3Player' -- \n \n [Synopsis]\n Play an MP3 file or stream\n \n [Description]\n MP3Player(location) Executes mpg123 to play the given location,\n which typically would be a filename or a URL. User can exit by pressing\n any key on the dialpad, or by hanging up.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"MusicOnHold: Play Music On Hold indefinitely","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'MusicOnHold' -- \n \n [Synopsis]\n Play Music On Hold indefinitely\n \n [Description]\n MusicOnHold(class): Plays hold music specified by class. If omitted, the default\n music source for the channel will be used. Set the default \n class with the SetMusicOnHold() application.\n Returns -1 on hangup.\n Never returns otherwise.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"NBScat: Play an NBS local stream","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'NBScat' -- \n \n [Synopsis]\n Play an NBS local stream\n \n [Description]\n NBScat: Executes nbscat to listen to the local NBS stream.\n User can exit by pressing any key","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"NoCDR: Tell Asterisk to not maintain a CDR for the current call","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'NoCDR' -- \n \n [Synopsis]\n Tell Asterisk to not maintain a CDR for the current call\n \n [Description]\n NoCDR(): This application will tell Asterisk not to maintain a CDR for the\n current call.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"NoOp: Do Nothing","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'NoOp' -- \n \n [Synopsis]\n Do Nothing\n \n [Description]\n NoOp(): This applicatiion does nothing. However, it is useful for debugging\n purposes. Any text that is provided as arguments to this application can be\n viewed at the Asterisk CLI. This method can be used to see the evaluations of\n variables or functions without having any effect.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Page: Pages phones","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Page' -- \n \n [Synopsis]\n Pages phones\n \n [Description]\n Page(Technology/Resource&Technology2/Resource2[|options])\n Places outbound calls to the given technology / resource and dumps\n them into a conference bridge as muted participants. The original\n caller is dumped into the conference as a speaker and the room is\n destroyed when the original caller leaves. Valid options are:\n d - full duplex audio\n q - quiet, do not play beep to caller","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Park: Park yourself","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Park' -- \n \n [Synopsis]\n Park yourself\n \n [Description]\n Park():Used to park yourself (typically in combination with a supervised\n transfer to know the parking space). This application is always\n registered internally and does not need to be explicitly added\n into the dialplan, although you should include the 'parkedcalls'\n context.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ParkAndAnnounce: Park and Announce","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ParkAndAnnounce' -- \n \n [Synopsis]\n Park and Announce\n \n [Description]\n ParkAndAnnounce(announce:template|timeout|dial|[return_context]):\n Park a call into the parkinglot and announce the call over the console.\n announce template: colon separated list of files to announce, the word PARKED\n will be replaced by a say_digits of the ext the call is parked in\n timeout: time in seconds before the call returns into the return context.\n dial: The app_dial style resource to call to make the announcement. Console/dsp\ncalls the console.\n return_context: the goto style label to jump the call back into after timeout.\ndefault=prio+1","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ParkedCall: Answer a parked call","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ParkedCall' -- \n \n [Synopsis]\n Answer a parked call\n \n [Description]\n ParkedCall(exten):Used to connect to a parked call. This application is always\n registered internally and does not need to be explicitly added\n into the dialplan, although you should include the 'parkedcalls'\n context.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"PauseQueueMember: Pauses a queue member","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'PauseQueueMember' -- \n \n [Synopsis]\n Pauses a queue member\n \n [Description]\n PauseQueueMember([queuename]|interface[|options]):\n Pauses (blocks calls for) a queue member.\n The given interface will be paused in the given queue. This prevents\n any calls from being sent from the queue to the interface until it is\n unpaused with UnpauseQueueMember or the manager interface. If no\n queuename is given, the interface is paused in every queue it is a\n member of. If the interface is not in the named queue, or if no queue\n is given and the interface is not in any queue, it will jump to\n priority n+101, if it exists and the appropriate options are set.\n The application will fail if the interface is not found and no extension\n to jump to exists.\n The option string may contain zero or more of the following characters:\n 'j' -- jump to +101 priority when appropriate.\n This application sets the following channel variable upon completion:\n PQMSTATUS The status of the attempt to pause a queue member as a\n text string, one of\n PAUSED | NOTFOUND\n Example: PauseQueueMember(|SIP/3000)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Pickup: Directed Call Pickup","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Pickup' -- \n \n [Synopsis]\n Directed Call Pickup\n \n [Description]\n Pickup(extension[@context]): This application can pickup any ringing channel\n that is calling the specified extension. If no context is specified, the current\n context will be used.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Playback: Play a file","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Playback' -- \n \n [Synopsis]\n Play a file\n \n [Description]\n Playback(filename[&filename2...][|option]): Plays back given filenames (do not put\n extension). Options may also be included following a pipe symbol. The 'skip'\n option causes the playback of the message to be skipped if the channel\n is not in the 'up' state (i.e. it hasn't been answered yet). If 'skip' is \n specified, the application will return immediately should the channel not be\n off hook. Otherwise, unless 'noanswer' is specified, the channel will\n be answered before the sound is played. Not all channels support playing\n messages while still on hook. If 'j' is specified, the application\n will jump to priority n+101 if present when a file specified to be played\n does not exist.\n This application sets the following channel variable upon completion:\n PLAYBACKSTATUS The status of the playback attempt as a text string, one of\n SUCCESS | FAILED","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"PlayTones: Play a tone list","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'PlayTones' -- \n \n [Synopsis]\n Play a tone list\n \n [Description]\n PlayTones(arg): Plays a tone list. Execution will continue with the next step\nimmediately,\n while the tones continue to play.\n Arg is either the tone name defined in the indications.conf configuration file, or\na directly\n specified list of frequencies and durations.\n See the sample indications.conf for a description of the specification of a tonelist.\n \n Use the StopPlayTones application to stop the tones playing. ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"PrivacyManager: Require phone number to be entered, if no CallerID sent","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'PrivacyManager' -- \n \n [Synopsis]\n Require phone number to be entered, if no CallerID sent\n \n [Description]\n PrivacyManager([maxretries[|minlength[|options]]]): If no Caller*ID \n is sent, PrivacyManager answers the channel and asks the caller to\n enter their phone number. The caller is given 3 attempts to do so.\n The application does nothing if Caller*ID was received on the channel.\n Configuration file privacy.conf contains two variables:\n maxretries default 3 -maximum number of attempts the caller is allowed \n to input a callerid.\n minlength default 10 -minimum allowable digits in the input callerid number.\n If you don't want to use the config file and have an i/o operation with\n every call, you can also specify maxretries and minlength as application\n parameters. Doing so supercedes any values set in privacy.conf.\n The option string may contain the following character: \n 'j' -- jump to n+101 priority after failed attempts to collect\n the minlength number of digits.\n The application sets the following channel variable upon completion: \n PRIVACYMGRSTATUS The status of the privacy manager's attempt to collect \n a phone number from the user. A text string that is either:\n SUCCESS | FAILED ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Progress: Indicate progress","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Progress' -- \n \n [Synopsis]\n Indicate progress\n \n [Description]\n Progress(): This application will request that in-band progress information\n be provided to the calling channel.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"Queue: Queue a call for a call queue","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Queue' -- \n \n [Synopsis]\n Queue a call for a call queue\n \n [Description]\n Queue(queuename[|options[|URL][|announceoverride][|timeout]]):\n Queues an incoming call in a particular call queue as defined in queues.conf.\n This application will return to the dialplan if the queue does not exist, or\n any of the join options cause the caller to not enter the queue.\n The option string may contain zero or more of the following characters:\n 'd' -- data-quality (modem) call (minimum delay).\n 'h' -- allow callee to hang up by hitting *.\n 'H' -- allow caller to hang up by hitting *.\n 'n' -- no retries on the timeout; will exit this application and \n go to the next step.\n 'r' -- ring instead of playing MOH\n 't' -- allow the called user transfer the calling user\n 'T' -- to allow the calling user to transfer the call.\n 'w' -- allow the called user to write the conversation to disk via Monitor\n 'W' -- allow the calling user to write the conversation to disk via Monitor\n In addition to transferring the call, a call may be parked and then picked\n up by another user.\n The optional URL will be sent to the called party if the channel supports\n it.\n The timeout will cause the queue to fail out after a specified number of\n seconds, checked between each queues.conf 'timeout' and 'retry' cycle.\n This application sets the following channel variable upon completion:\n QUEUESTATUS The status of the call as a text string, one of\n TIMEOUT | FULL | JOINEMPTY | LEAVEEMPTY | JOINUNAVAIL | LEAVEUNAVAIL","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Random: Conditionally branches, based upon a probability","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Random' -- \n \n [Synopsis]\n Conditionally branches, based upon a probability\n \n [Description]\n Random([probability]:[[context|]extension|]priority)\n probability := INTEGER in the range 1 to 100","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Read: Read a variable","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Read' -- \n \n [Synopsis]\n Read a variable\n \n [Description]\n Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])\n \n Reads a #-terminated string of digits a certain number of times from the\n user in to the given variable.\n filename -- file to play before reading digits.\n maxdigits -- maximum acceptable number of digits. Stops reading after\n maxdigits have been entered (without requiring the user to\n press the '#' key).\n Defaults to 0 - no limit - wait for the user press the '#' key.\n Any value below 0 means the same. Max accepted value is 255.\n option -- may be 'skip' to return immediately if the line is not up,\n or 'noanswer' to read digits even if the line is not up.\n attempts -- if greater than 1, that many attempts will be made in the \n event no data is entered.\n timeout -- if greater than 0, that value will override the default timeout.\n \n Read should disconnect if the function fails or errors out.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ReadFile: ReadFile(varname=file,length)","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ReadFile' -- \n \n [Synopsis]\n ReadFile(varname=file,length)\n \n [Description]\n ReadFile(varname=file,length)\n Varname - Result stored here.\n File - The name of the file to read.\n Length - Maximum number of characters to capture.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"RealTime: Realtime Data Lookup","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'RealTime' -- \n \n [Synopsis]\n Realtime Data Lookup\n \n [Description]\n Use the RealTime config handler system to read data into channel variables.\n RealTime(||[|])\n \n All unique column names will be set as channel variables with optional prefix to\nthe name.\n e.g. prefix of 'var_' would make the column 'name' become the variable ${var_name}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"RealTimeUpdate: Realtime Data Rewrite","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'RealTimeUpdate' -- \n \n [Synopsis]\n Realtime Data Rewrite\n \n [Description]\n Use the RealTime config handler system to update a value\n RealTimeUpdate(||||)\n \n The column in 'family' matching column = will be updated\nto ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Record: Record to a file","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Record' -- \n \n [Synopsis]\n Record to a file\n \n [Description]\n Record(filename.format|silence[|maxduration][|options])\n \n Records from the channel into a given filename. If the file exists it will\n be overwritten.\n - 'format' is the format of the file type to be recorded (wav, gsm, etc).\n - 'silence' is the number of seconds of silence to allow before returning.\n - 'maxduration' is the maximum recording duration in seconds. If missing\n or 0 there is no maximum.\n - 'options' may contain any of the following letters:\n 'a' : append to existing recording rather than replacing\n 'n' : do not answer, but record anyway if line not yet answered\n 'q' : quiet (do not play a beep tone)\n 's' : skip recording if the line is not yet answered\n 't' : use alternate '*' terminator key instead of default '#'\n \n If filename contains '%d', these characters will be replaced with a number\n incremented by one each time the file is recorded. \n \n Use 'show file formats' to see the available formats on your system\n \n User can press '#' to terminate the recording and continue to the next priority.\n \n If the user should hangup during a recording, all data will be lost and the\n application will teminate. ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"RemoveQueueMember: Dynamically removes queue members","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'RemoveQueueMember' -- \n \n [Synopsis]\n Dynamically removes queue members\n \n [Description]\n RemoveQueueMember(queuename[|interface[|options]]):\n Dynamically removes interface to an existing queue\n If the interface is NOT in the queue and there exists an n+101 priority\n then it will then jump to this priority. Otherwise it will return an error\n The option string may contain zero or more of the following characters:\n 'j' -- jump to +101 priority when appropriate.\n This application sets the following channel variable upon completion:\n RQMSTATUS The status of the attempt to remove a queue member as a\n text string, one of\n REMOVED | NOTINQUEUE | NOSUCHQUEUE \n Example: RemoveQueueMember(techsupport|SIP/3000)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ResetCDR: Resets the Call Data Record","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ResetCDR' -- \n \n [Synopsis]\n Resets the Call Data Record\n \n [Description]\n ResetCDR([options]): This application causes the Call Data Record to be\n reset.\n Options:\n w -- Store the current CDR record before resetting it.\n a -- Store any stacked records.\n v -- Save CDR variables.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ResponseTimeout: Set maximum timeout awaiting response","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ResponseTimeout' -- \n \n [Synopsis]\n Set maximum timeout awaiting response\n \n [Description]\n ResponseTimeout(seconds): This will set the maximum amount of time permitted\n to wait for an extension to dialed (see the WaitExten application), before the\n timeout occurs. If this timeout is reached, dialplan execution will continue at\n the 't' extension, if it exists.\n ResponseTimeout has been deprecated in favor of Set(TIMEOUT(response)=timeout)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'RetryDial' -- \n \n [Synopsis]\n Place a call, retrying on failure allowing optional exit extension.\n \n [Description]\n RetryDial(announce|sleep|retries|dialargs): This application will attempt to\n place a call using the normal Dial application. If no channel can be reached,\n the 'announce' file will be played. Then, it will wait 'sleep' number of\n seconds before retying the call. After 'retires' number of attempts, the\n calling channel will continue at the next priority in the dialplan. If the\n 'retries' setting is set to 0, this application will retry endlessly.\n While waiting to retry a call, a 1 digit extension may be dialed. If that\n extension exists in either the context defined in ${EXITCONTEXT} or the current\n one, The call will jump to that extension immediately.\n The 'dialargs' are specified in the same format that arguments are provided\n to the Dial application.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Return: Return from gosub routine","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Return' -- \n \n [Synopsis]\n Return from gosub routine\n \n [Description]\n Return()\n Jumps to the last label on the stack, removing it.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Ringing: Indicate ringing tone","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Ringing' -- \n \n [Synopsis]\n Indicate ringing tone\n \n [Description]\n Ringing(): This application will request that the channel indicate a ringing\n tone to the user.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SayAlpha: Say Alpha","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SayAlpha' -- \n \n [Synopsis]\n Say Alpha\n \n [Description]\n SayAlpha(string): This application will play the sounds that correspond to\n the letters of the given string.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SayDigits: Say Digits","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SayDigits' -- \n \n [Synopsis]\n Say Digits\n \n [Description]\n SayDigits(digits): This application will play the sounds that correspond\n to the digits of the given number. This will use the language that is currently\n set for the channel. See the LANGUAGE function for more information on setting\n the language for the channel.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"SayNumber: Say Number","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SayNumber' -- \n \n [Synopsis]\n Say Number\n \n [Description]\n SayNumber(digits[,gender]): This application will play the sounds that\n correspond to the given number. Optionally, a gender may be specified.\n This will use the language that is currently set for the channel. See the\n LANGUAGE function for more information on setting the language for the channel.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SayPhonetic: Say Phonetic","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SayPhonetic' -- \n \n [Synopsis]\n Say Phonetic\n \n [Description]\n SayPhonetic(string): This application will play the sounds from the phonetic\n alphabet that correspond to the letters in the given string.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SayUnixTime: Says a specified time in a custom format","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SayUnixTime' -- \n \n [Synopsis]\n Says a specified time in a custom format\n \n [Description]\n SayUnixTime([unixtime][|[timezone][|format]])\n unixtime: time, in seconds since Jan 1, 1970. May be negative.\n defaults to now.\n timezone: timezone, see /usr/share/zoneinfo for a list.\n defaults to machine default.\n format: a format the time is to be said in. See voicemail.conf.\n defaults to \"ABdY 'digits/at' IMp\"","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SendDTMF: Sends arbitrary DTMF digits","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'SendDTMF' -- \n \n [Synopsis]\n Sends arbitrary DTMF digits\n \n [Description]\n SendDTMF(digits[|timeout_ms]): Sends DTMF digits on a channel. \n Accepted digits: 0-9, *#abcd, w (.5s pause)\n The application will either pass the assigned digits or terminate if it\n encounters an error.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SendImage: Send an image file","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SendImage' -- \n \n [Synopsis]\n Send an image file\n \n [Description]\n SendImage(filename): Sends an image on a channel. \n If the channel supports image transport but the image send\n fails, the channel will be hung up. Otherwise, the dialplan\n continues execution.\n The option string may contain the following character:\n 'j' -- jump to priority n+101 if the channel doesn't support image transport\n This application sets the following channel variable upon completion:\n SENDIMAGESTATUS The status is the result of the attempt as a text string, one of\n OK | NOSUPPORT ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SendText: Send a Text Message","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SendText' -- \n \n [Synopsis]\n Send a Text Message\n \n [Description]\n SendText(text[|options]): Sends text to current channel (callee).\n Result of transmission will be stored in the SENDTEXTSTATUS\n channel variable:\n SUCCESS Transmission succeeded\n FAILURE Transmission failed\n UNSUPPORTED Text transmission not supported by channel\n \n At this moment, text is supposed to be 7 bit ASCII in most channels.\n The option string many contain the following character:\n 'j' -- jump to n+101 priority if the channel doesn't support\n text transport","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SendURL: Send a URL","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SendURL' -- \n \n [Synopsis]\n Send a URL\n \n [Description]\n SendURL(URL[|option]): Requests client go to URL (IAX2) or sends the \n URL to the client (other channels).\n Result is returned in the SENDURLSTATUS channel variable:\n SUCCESS URL successfully sent to client\n FAILURE Failed to send URL\n NOLOAD Clien failed to load URL (wait enabled)\n UNSUPPORTED Channel does not support URL transport\n \n If the option 'wait' is specified, execution will wait for an\n acknowledgement that the URL has been loaded before continuing\n and will return -1 if the peer is unable to load the URL\n \n Old behaviour (deprecated): \n If the client does not support Asterisk \"html\" transport, \n and there exists a step with priority n + 101, then execution will\n continue at that step.\n Otherwise, execution will continue at the next priority level.\n SendURL only returns 0 if the URL was sent correctly or if\n the channel does not support HTML transport, and -1 otherwise.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Set: Set channel variable(s) or function value(s)","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Set' -- \n \n [Synopsis]\n Set channel variable(s) or function value(s)\n \n [Description]\n Set(name1=value1|name2=value2|..[|options])\n This function can be used to set the value of channel variables or dialplan\n functions. It will accept up to 24 name/value pairs. When setting variables,\n if the variable name is prefixed with _, the variable will be inherited into\n channels created from the current channel. If the variable name is prefixed\n with __, the variable will be inherited into channels created from the current\n channel and all children channels.\n Options:\n g - Set variable globally instead of on the channel\n (applies only to variables, not functions)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetAccount: Set the CDR Account Code","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetAccount' -- \n \n [Synopsis]\n Set the CDR Account Code\n \n [Description]\n SetAccount([account]): This application will set the channel account code for\n billing purposes.\n SetAccount has been deprecated in favor of the Set(CDR(accountcode)=account).","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetAMAFlags: Set the AMA Flags","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetAMAFlags' -- \n \n [Synopsis]\n Set the AMA Flags\n \n [Description]\n SetAMAFlags([flag]): This channel will set the channel's AMA Flags for billing\n purposes.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetCallerID: Set CallerID","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetCallerID' -- \n \n [Synopsis]\n Set CallerID\n \n [Description]\n SetCallerID(clid[|a]): Set Caller*ID on a call to a new\n value. Sets ANI as well if a flag is used. ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetCallerPres: Set CallerID Presentation","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetCallerPres' -- \n \n [Synopsis]\n Set CallerID Presentation\n \n [Description]\n SetCallerPres(presentation): Set Caller*ID presentation on a call.\n Valid presentations are:\n \n allowed_not_screened : Presentation Allowed, Not Screened\n allowed_passed_screen : Presentation Allowed, Passed Screen\n allowed_failed_screen : Presentation Allowed, Failed Screen\n allowed : Presentation Allowed, Network Number\n prohib_not_screened : Presentation Prohibited, Not Screened\n prohib_passed_screen : Presentation Prohibited, Passed Screen\n prohib_failed_screen : Presentation Prohibited, Failed Screen\n prohib : Presentation Prohibited, Network Number\n unavailable : Number Unavailable","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetCDRUserField: Set the CDR user field","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetCDRUserField' -- \n \n [Synopsis]\n Set the CDR user field\n \n [Description]\n [Synopsis]\n SetCDRUserField(value)\n \n [Description]\n SetCDRUserField(value): Set the CDR 'user field' to value\n The Call Data Record (CDR) user field is an extra field you\n can use for data not stored anywhere else in the record.\n CDR records can be used for billing or storing other arbitrary data\n (I.E. telephone survey responses)\n Also see AppendCDRUserField().","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetCIDName: Set CallerID Name","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetCIDName' -- \n \n [Synopsis]\n Set CallerID Name\n \n [Description]\n SetCIDName(cname[|a]): Set Caller*ID Name on a call to a new\n value, while preserving the original Caller*ID number. This is\n useful for providing additional information to the called\n party. \n SetCIDName has been deprecated in favor of the function\n CALLERID(name)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetCIDNum: Set CallerID Number","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetCIDNum' -- \n \n [Synopsis]\n Set CallerID Number\n \n [Description]\n SetCIDNum(cnum[|a]): Set Caller*ID Number on a call to a new\n value, while preserving the original Caller*ID name. This is\n useful for providing additional information to the called\n party. Sets ANI as well if a flag is used.\n SetCIDNum has been deprecated in favor of the function\n CALLERID(number)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetGlobalVar: Set a global variable to a given value","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetGlobalVar' -- \n \n [Synopsis]\n Set a global variable to a given value\n \n [Description]\n SetGlobalVar(variable=value): This application sets a given global variable to\n the specified value.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetGroup: Set the channel's group","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetGroup' -- \n \n [Synopsis]\n Set the channel's group\n \n [Description]\n Usage: SetGroup(groupname[@category])\n Sets the channel group to the specified value. Equivalent to\n Set(GROUP=group). Always returns 0.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetLanguage: Set the channel's preferred language","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetLanguage' -- \n \n [Synopsis]\n Set the channel's preferred language\n \n [Description]\n SetLanguage(language): This will set the channel language to the given value.\n This information is used for the syntax in generation of numbers, and to choose\n a sound file in the given language, when it is available.\n For example, if language is set to 'fr' and the file 'demo-congrats' is \n requested to be played, if the file 'fr/demo-congrats' exists, then\n it will play that file. If not, it will play the normal 'demo-congrats'.\n For some language codes, SetLanguage also changes the syntax of some\n Asterisk functions, like SayNumber.\n SetLanguage has been deprecated in favor of Set(LANGUAGE()=language)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetMusicOnHold: Set default Music On Hold class","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetMusicOnHold' -- \n \n [Synopsis]\n Set default Music On Hold class\n \n [Description]\n SetMusicOnHold(class): Sets the default class for music on hold for a given\nchannel. When\n music on hold is activated, this class will be used to select which\n music is played.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetRDNIS: Set RDNIS Number","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'SetRDNIS' -- \n \n [Synopsis]\n Set RDNIS Number\n \n [Description]\n SetRDNIS(cnum): Set RDNIS Number on a call to a new\n value.\n SetRDNIS has been deprecated in favor of the function\n CALLERID(rdnis)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetTransferCapability: Set ISDN Transfer Capability","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetTransferCapability' -- \n \n [Synopsis]\n Set ISDN Transfer Capability\n \n [Description]\n SetTransferCapability(transfercapability): Set the ISDN Transfer \n Capability of a call to a new value.\n Valid Transfer Capabilities are:\n \n SPEECH : 0x00 - Speech (default, voice calls)\n DIGITAL : 0x08 - Unrestricted digital information (data calls)\n RESTRICTED_DIGITAL : 0x09 - Restricted digital information\n 3K1AUDIO : 0x10 - 3.1kHz Audio (fax calls)\n DIGITAL_W_TONES : 0x11 - Unrestricted digital information with\ntones/announcements\n VIDEO : 0x18 - Video:","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SetVar: Set channel variable(s)","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SetVar' -- \n \n [Synopsis]\n Set channel variable(s)\n \n [Description]\n SetVar(name1=value1|name2=value2|..[|options]): This application has been\n deprecated in favor of using the Set application.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SIPAddHeader: Add a SIP header to the outbound call","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SIPAddHeader' -- \n \n [Synopsis]\n Add a SIP header to the outbound call\n \n [Description]\n SIPAddHeader(Header: Content)\n Adds a header to a SIP call placed with DIAL.\n Remember to user the X-header if you are adding non-standard SIP\n headers, like \"X-Asterisk-Accountcode:\". Use this with care.\n Adding the wrong headers may jeopardize the SIP dialog.\n Always returns 0","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SIPDtmfMode: Change the dtmfmode for a SIP call","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SIPDtmfMode' -- \n \n [Synopsis]\n Change the dtmfmode for a SIP call\n \n [Description]\n SIPDtmfMode(inband|info|rfc2833): Changes the dtmfmode for a SIP call","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"SIPGetHeader: Get a SIP header from an incoming call","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SIPGetHeader' -- \n \n [Synopsis]\n Get a SIP header from an incoming call\n \n [Description]\n SIPGetHeader(var=headername[|options]): \n Sets a channel variable to the content of a SIP header\n Options:\n j - Jump to priority n+101 if the requested header isn't found.\n This application sets the following channel variable upon completion:\n SIPGETSTATUS - This variable will contain the status of the attempt\n FOUND | NOTFOUND\n This application has been deprecated in favor of the SIP_HEADER function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SMS: Communicates with SMS service centres and SMS capable analogue phones","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SMS' -- \n \n [Synopsis]\n Communicates with SMS service centres and SMS capable analogue phones\n \n [Description]\n SMS(name|[a][s]): SMS handles exchange of SMS data with a call to/from SMS capabale\n phone or SMS PSTN service center. Can send and/or receive SMS messages.\n Works to ETSI ES 201 912 compatible with BT SMS PSTN service in UK\n Typical usage is to use to handle called from the SMS service centre CLI,\n or to set up a call using 'outgoing' or manager interface to connect\n service centre to SMS()\n name is the name of the queue used in /var/spool/asterisk/sms\n Arguments:\n a: answer, i.e. send initial FSK packet.\n s: act as service centre talking to a phone.\n Messages are processed as per text file message queues.\n smsq (a separate software) is a command to generate message\n queues and send messages.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SoftHangup: Soft Hangup Application","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'SoftHangup' -- \n \n [Synopsis]\n Soft Hangup Application\n \n [Description]\n SoftHangup(Technology/resource|options)\n Hangs up the requested channel. If there are no channels to hangup,\n the application will report it.\n - 'options' may contain the following letter:\n 'a' : hang up all channels on a specified device instead of a single resource","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sort: Sorts a list of keywords and values","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'Sort' -- \n \n [Synopsis]\n Sorts a list of keywords and values\n \n [Description]\n Sort(newvar=key1:val1[,key2:val2[[...],keyN:valN]]): This application will\n sort the list provided in ascending order. The result will be stored in the\n specified variable name.\n This applicaiton has been deprecated in favor of the SORT function.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"StackPop: Remove one address from gosub stack","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'StackPop' -- \n \n [Synopsis]\n Remove one address from gosub stack\n \n [Description]\n StackPop()\n Removes last label on the stack, discarding it.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"StartMusicOnHold: Play Music On Hold","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'StartMusicOnHold' -- \n \n [Synopsis]\n Play Music On Hold\n \n [Description]\n StartMusicOnHold(class): Starts playing music on hold, uses default music class for\nchannel.\n Starts playing music specified by class. If omitted, the default\n music source for the channel will be used. Always returns 0.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"StopMonitor: Stop monitoring a channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'StopMonitor' -- \n \n [Synopsis]\n Stop monitoring a channel\n \n [Description]\n StopMonitor\n Stops monitoring a channel. Has no effect if the channel is not monitored","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"StopMusicOnHold: Stop Playing Music On Hold","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'StopMusicOnHold' -- \n \n [Synopsis]\n Stop Playing Music On Hold\n \n [Description]\n StopMusicOnHold: Stops playing music on hold.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"StopPlayTones: Stop playing a tone list","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'StopPlayTones' -- \n \n [Synopsis]\n Stop playing a tone list\n \n [Description]\n Stop playing a tone list","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"System: Execute a system command","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'System' -- \n \n [Synopsis]\n Execute a system command\n \n [Description]\n System(command): Executes a command by using system(). If the command\n fails, the console should report a fallthrough. \n Result of execution is returned in the SYSTEMSTATUS channel variable:\n FAILURE Could not execute the specified command\n SUCCESS Specified command successfully executed\n \n Old behaviour:\n If the command itself executes but is in error, and if there exists\n a priority n + 101, where 'n' is the priority of the current instance,\n then the channel will be setup to continue at that priority level.\n Note that this jump functionality has been deprecated and will only occur\n if the global priority jumping option is enabled in extensions.conf.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"TestClient: Execute Interface Test Client","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'TestClient' -- \n \n [Synopsis]\n Execute Interface Test Client\n \n [Description]\n TestClient(testid): Executes test client with given testid.\n Results stored in /var/log/asterisk/testreports/-client.txt","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"TestServer: Execute Interface Test Server","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'TestServer' -- \n \n [Synopsis]\n Execute Interface Test Server\n \n [Description]\n TestServer(): Perform test server function and write call report.\n Results stored in /var/log/asterisk/testreports/-server.txt","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"Transfer: Transfer caller to remote extension","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Transfer' -- \n \n [Synopsis]\n Transfer caller to remote extension\n \n [Description]\n Transfer([Tech/]dest[|options]): Requests the remote caller be transferred\n to a given destination. If TECH (SIP, IAX2, LOCAL etc) is used, only\n an incoming call with the same channel technology will be transfered.\n Note that for SIP, if you transfer before call is setup, a 302 redirect\n SIP message will be returned to the caller.\n \n The result of the application will be reported in the TRANSFERSTATUS\n channel variable:\n SUCCESS Transfer succeeded\n FAILURE Transfer failed\n UNSUPPORTED Transfer unsupported by channel driver\n The option string many contain the following character:\n 'j' -- jump to n+101 priority if the channel transfer attempt\n fails","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"TrySystem: Try executing a system command","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'TrySystem' -- \n \n [Synopsis]\n Try executing a system command\n \n [Description]\n TrySystem(command): Executes a command by using system().\n on any situation.\n Result of execution is returned in the SYSTEMSTATUS channel variable:\n FAILURE Could not execute the specified command\n SUCCESS Specified command successfully executed\n APPERROR Specified command successfully executed, but returned error code\n \n Old behaviour:\n If the command itself executes but is in error, and if\n there exists a priority n + 101, where 'n' is the priority of the current\n instance, then the channel will be setup to continue at that\n priority level. Otherwise, System will terminate.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"TXTCIDName: Lookup caller name from TXT record","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'TXTCIDName' -- \n \n [Synopsis]\n Lookup caller name from TXT record\n \n [Description]\n TXTCIDName([|options]): Looks up a Caller Name via DNS and sets\n the variable 'TXTCIDNAME'. TXTCIDName will either be blank\n or return the value found in the TXT record in DNS.\n The option string may contain the following character:\n 'j' -- jump to n+101 priority if the lookup fails\n This application sets the following channel variable upon completion:\n TXTCIDNAMESTATUS The status of the lookup as a text string, one of\n SUCCESS | FAILED","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"UnpauseQueueMember: Unpauses a queue member","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'UnpauseQueueMember' -- \n \n [Synopsis]\n Unpauses a queue member\n \n [Description]\n UnpauseQueueMember([queuename]|interface[|options]):\n Unpauses (resumes calls to) a queue member.\n This is the counterpart to PauseQueueMember and operates exactly the\n same way, except it unpauses instead of pausing the given interface.\n The option string may contain zero or more of the following characters:\n 'j' -- jump to +101 priority when appropriate.\n This application sets the following channel variable upon completion:\n UPQMSTATUS The status of the attempt to unpause a queue \n member as a text string, one of\n UNPAUSED | NOTFOUND\n Example: UnpauseQueueMember(|SIP/3000)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"UserEvent: Send an arbitrary event to the manager interface","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'UserEvent' -- \n \n [Synopsis]\n Send an arbitrary event to the manager interface\n \n [Description]\n UserEvent(eventname[|body]): Sends an arbitrary event to the\n manager interface, with an optional body representing additional\n arguments. The format of the event will be:\n Event: UserEvent\n Channel: \n Uniqueid: \n [body]\n If the body is not specified, only Event, Channel, and Uniqueid fields\n will be present. Returns 0.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Verbose: Send arbitrary text to verbose output","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Verbose' -- \n \n [Synopsis]\n Send arbitrary text to verbose output\n \n [Description]\n Verbose([|])\n level must be an integer value. If not specified, defaults to 0.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"VMAuthenticate: Authenticate with Voicemail passwords","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'VMAuthenticate' -- \n \n [Synopsis]\n Authenticate with Voicemail passwords\n \n [Description]\n VMAuthenticate([mailbox][@context][|options]): This application behaves the\n same way as the Authenticate application, but the passwords are taken from\n voicemail.conf.\n If the mailbox is specified, only that mailbox's password will be considered\n valid. If the mailbox is not specified, the channel variable AUTH_MAILBOX will\n be set with the authenticated mailbox.\n \n Options:\n s - Skip playing the initial prompts.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"VoiceMail: Leave a Voicemail message","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'VoiceMail' -- \n \n [Synopsis]\n Leave a Voicemail message\n \n [Description]\n VoiceMail(mailbox[@context][&mailbox[@context]][...][|options]): This\n application allows the calling party to leave a message for the specified\n list of mailboxes. When multiple mailboxes are specified, the greeting will\n be taken from the first mailbox specified. Dialplan execution will stop if the\n specified mailbox does not exist.\n The Voicemail application will exit if any of the following DTMF digits are\n received:\n 0 - Jump to the 'o' extension in the current dialplan context.\n * - Jump to the 'a' extension in the current dialplan context.\n This application will set the following channel variable upon completion:\n VMSTATUS - This indicates the status of the execution of the VoiceMail\n application. The possible values are:\n SUCCESS | USEREXIT | FAILED\n \n Options:\n b - Play the 'busy' greeting to the calling party.\n g(#) - Use the specified amount of gain when recording the voicemail\n message. The units are whole-number decibels (dB).\n s - Skip the playback of instructions for leaving a message to the\n calling party.\n u - Play the 'unavailable greeting.\n j - Jump to priority n+101 if the mailbox is not found or some other\n error occurs.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"VoiceMailMain: Check Voicemail messages","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'VoiceMailMain' -- \n \n [Synopsis]\n Check Voicemail messages\n \n [Description]\n VoiceMailMain([mailbox][@context][|options]): This application allows the\n calling party to check voicemail messages. A specific mailbox, and optional\n corresponding context, may be specified. If a mailbox is not provided, the\n calling party will be prompted to enter one. If a context is not specified,\n the 'default' context will be used.\n \n Options:\n p - Consider the mailbox parameter as a prefix to the mailbox that\n is entered by the caller.\n g(#) - Use the specified amount of gain when recording a voicemail\n message. The units are whole-number decibels (dB).\n s - Skip checking the passcode for the mailbox.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Wait: Waits for some time","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Wait' -- \n \n [Synopsis]\n Waits for some time\n \n [Description]\n Wait(seconds): This application waits for a specified number of seconds.\n Then, dialplan execution will continue at the next priority.\n Note that the seconds can be passed with fractions of a second. For example,\n '1.5' will ask the application to wait for 1.5 seconds.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"WaitExten: Waits for an extension to be entered","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'WaitExten' -- \n \n [Synopsis]\n Waits for an extension to be entered\n \n [Description]\n WaitExten([seconds][|options]): This application waits for the user to enter\n a new extension for a specified number of seconds.\n Note that the seconds can be passed with fractions of a second. For example,\n '1.5' will ask the application to wait for 1.5 seconds.\n Options:\n m[(x)] - Provide music on hold to the caller while waiting for an extension.\n Optionally, specify the class for music on hold within parenthesis.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"WaitForRing: Wait for Ring Application","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'WaitForRing' -- \n \n [Synopsis]\n Wait for Ring Application\n \n [Description]\n WaitForRing(timeout)\n Returns 0 after waiting at least timeout seconds. and\n only after the next ring has completed. Returns 0 on\n success or -1 on hangup","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"WaitForSilence: Waits for a specified amount of silence","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'WaitForSilence' -- \n \n [Synopsis]\n Waits for a specified amount of silence\n \n [Description]\n WaitForSilence(x[|y]) Wait for Silence: Waits for up to 'x' \n milliseconds of silence, 'y' times or 1 if omitted\n Set the channel variable WAITSTATUS with to one of these values:SILENCE - if\nsilence of x ms was detectedTIMEOUT - if silence of x ms was not detected.Examples:\n - WaitForSilence(500|2) will wait for 1/2 second of silence, twice\n - WaitForSilence(1000) will wait for 1 second of silence, once","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"WaitMusicOnHold: Wait, playing Music On Hold","type":"text"}]},{"type":"codeBlock","content":[{"text":" -- Info about application 'WaitMusicOnHold' -- \n \n [Synopsis]\n Wait, playing Music On Hold\n \n [Description]\n WaitMusicOnHold(delay): Plays hold music specified number of seconds. Returns 0 when\n done, or -1 on hangup. If no hold music is available, the delay will\n still occur with no sound.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"While: Start A While Loop","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'While' -- \n \n [Synopsis]\n Start A While Loop\n \n [Description]\n Usage: While()\n Start a While Loop. Execution will return to this point when\n EndWhile is called until expr is no longer true.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Zapateller: Block telemarketers with SIT","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'Zapateller' -- \n \n [Synopsis]\n Block telemarketers with SIT\n \n [Description]\n Zapateller(options): Generates special information tone to block\n telemarketers from calling you. Options is a pipe-delimited list of\n options. The following options are available:\n 'answer' causes the line to be answered before playing the tone,\n 'nocallerid' causes Zapateller to only play the tone if there\n is no callerid information available. Options should be separated by |\n characters","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ZapBarge: Barge in (monitor) Zap channel","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ZapBarge' -- \n \n [Synopsis]\n Barge in (monitor) Zap channel\n \n [Description]\n ZapBarge([channel]): Barges in on a specified zap\n channel or prompts if one is not specified. Returns\n -1 when caller user hangs up and is independent of the\n state of the channel being monitored.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ZapRAS: Executes Zaptel ISDN RAS application","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ZapRAS' -- \n \n [Synopsis]\n Executes Zaptel ISDN RAS application\n \n [Description]\n ZapRAS(args): Executes a RAS server using pppd on the given channel.\n The channel must be a clear channel (i.e. PRI source) and a Zaptel\n channel to be able to use this function (No modem emulation is included).\n Your pppd must be patched to be zaptel aware. Arguments should be\n separated by | characters.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"ZapScan: Scan Zap channels to monitor calls","type":"text"}]},{"type":"codeBlock","content":[{"text":"-- Info about application 'ZapScan' -- \n \n [Synopsis]\n Scan Zap channels to monitor calls\n \n [Description]\n ZapScan([group]) allows a call center manager to monitor Zap channels in\n a convenient way. Use '#' to select the next channel and use '*' to exit\n Limit scanning to a channel GROUP by setting the option group argument.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"GET DATA [ []]","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Plays the given file and receives DTMF data. This is similar to STREAM FILE, but this command can accept and return many DTMF digits, while STREAM FILE returns immediately after the first DTMF digit is detected.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns If the command ended due to timeout then the result is of the form","type":"text"}]},{"type":"codeBlock","content":[{"text":" 200 Result= (timeout)","type":"text"}]},{"type":"paragraph","content":[{"text":"where will be zero or more ASCII characters depending on what the user pressed.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"If the command ended because the maximum number of digits were entered then the result is of the form","type":"text"}]},{"type":"codeBlock","content":[{"text":" 200 Result=","type":"text"}]},{"type":"paragraph","content":[{"text":"and the number of digits returned will be equal to .","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"In either case what you get are actual ASCII characters. For example if the user pressed the one key, the three key and then the star key, the result would be","type":"text"}]},{"type":"codeBlock","content":[{"text":" 200 Result=13* (timeout)","type":"text"}]},{"type":"paragraph","content":[{"text":"This differs from other commands with return DTMF as numbers representing ASCII characters.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Don't give an extension with the filename.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Asterisk looks for the file to play in /var/lib/asterisk/sounds","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the user doesn't press any keys then the message plays, there is milliseconds of silence then the command ends.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for milliseconds. Every time the user presses another key the timer is restarted. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you don't specify a time out then a default timeout of 2000 is used following a pressed digit. If no digits are pressed then 6 seconds of silence follow the message.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you want to specify then you *must* specify a as well.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you don't specify then the user can enter as many digits as they want.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pressing the # key has the same effect as the timer running out: the command ends and any previously keyed digits are returned. A side effect of this is that there is no way to read a # key using this command.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"GET VARIABLE ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Fetch the value of a variable.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Returns 0 if the variable hasn't been set. Returns 1 followed by the value of the variable in parenthesis if it has been set.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SET VARIABLE Foo \"This is a test\" 200 result=1 GET VARIABLE Foo 200 result=1 (This is a test)","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"HANGUP []","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Hangup the specified channel. If no channel name is given, hang up the current channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns If the hangup was successful then the result is 200 result=1","type":"text"}]},{"type":"paragraph","content":[{"text":"If no channel matches the you specified then the result is 200 result=-1","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Examples HANGUP Hangup the current channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"HANGUP Zap/9-1 Hangup channel Zap/9-1","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The to use is the same as the channel names reported by the Asterisk console 'show channels' command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"With power comes responsibility. Hanging up channels other than your own isn't something that is done routinely. If you are not sure why you are doing so, then don't.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"RECEIVE CHAR ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Receive a character of text from a connected channel. Waits up to milliseconds for a character to arrive, or infinitely if is zero.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns If a character is received, returns the ASCII value of the character as a decimal number. For example if the character 'A' is received the result would be","type":"text"}]},{"type":"codeBlock","content":[{"text":" result=65","type":"text"}]},{"type":"paragraph","content":[{"text":"If the channel does not support text reception or if the no character arrives in milliseconds then the result is","type":"text"}]},{"type":"codeBlock","content":[{"text":" result=0 (timeout)","type":"text"}]},{"type":"paragraph","content":[{"text":"On error or failure the result is","type":"text"}]},{"type":"codeBlock","content":[{"text":" result=-1","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note: ","type":"text","marks":[{"type":"strong"}]},{"text":"Most channels do not support the reception of text.","type":"text"}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"RECORD FILE [BEEP]","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Record sound to a file until an acceptable DTMF digit is received or a specified amount of time has passed. Optionally the file BEEP is played before recording begins.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns The documentation in the code says on hangup the result is -1, however when I tried it the hangup result was","type":"text"}]},{"type":"codeBlock","content":[{"text":" result=0 (hangup)","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurs then the result is -1. This can happen, for example, if you ask for a non-existent format.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the user presses an acceptable escape digit then the result is a number representing the ASCII digit pressed. For example if recording terminated because the user pressed the '2' key the result is","type":"text"}]},{"type":"codeBlock","content":[{"text":" result=50 (dtmf)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Example RECORD FILE foo gsm 123 5000 beep Record sound in gsm format to file 'foo.gsm'. Play a beep before starting to record. Stop recording if user presses '1', '2' or '3', after five seconds of recording, or if the user hangs up.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Don't put an extension on the filename; the filename extension will be created based on the specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The file will be created in /var/lib/asterisk/sounds","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" specifies what kind of file will be recorded. GSM is a commonly used format. To find out what other formats are supported start Asterisk with at a verbosity level of at least 2 (-vvc) and look for the messages that appear saying \"== Registered file format '. Most but not all registered formats can be used, for example, Asterisk can read but not write files in 'mp3' format.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you don't want ANY digits to terminate recording then specify \"\" instead of a digit string. To change the above example so no digits terminate recording use RECORD FILE foo gsm \"\" 5000 beep","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the maximum record time in milliseconds, or -1 for no timeout. When this document was written [Nov 2002] I was unable to get to work; this command always kept recording until I pressed an escape digit or hung up, as if -1 had been specified for timeout. A patch to correct this has been submitted but has not yet shown up in the CVS tree.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAY DIGITS ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Say the given digit string, returning early if any of the given DTMF escape digits are received on the channel. If no DTMF digits are to be received specify \"\" for .","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Zero if playback completes without a digit being received, or the ASCII numerical representation of the digit pressed, or -1 on error or hangup.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SAY DIGITS 123 78#","type":"text"}]},{"type":"paragraph","content":[{"text":"The digits 'one', 'two', 'three' are spoken. If the user presses the '7', '8' or '#' key the speaking stops and the command ends. If the user pressed no keys the result would be 200 result=0. If the user pressed the '#' key then the result would be 200 result=35.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAY NUMBER ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Say the given number, returning early if any of the given DTMF escape digits are received on the channel. If no DTMF digits are to be accepted specify \"\" for .","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Zero if playback completes without a digit being received, or the ASCII numerical representation of the digit pressed, or -1 on error or hangup.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SAY NUMBER 123 789","type":"text"}]},{"type":"paragraph","content":[{"text":"The phrase 'one hundred twenty three' is spoken. If the user presses the '7', '8' or '9' key the speaking stops and the command ends. If the user pressed no keys the result would be 200 result=0. If the user pressed the '#' key then the result would be 200 result=35.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SEND IMAGE ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Send the specified image on a channel. The image name should not should not include the extension.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Zero if the image is sent or if the channel does not support image transmission. Returns -1 only on error or hangup.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Asterisk looks for the image in /var/lib/asterisk/images","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Most channels do not support the transmission of images.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SEND TEXT \"\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Send the given text to the connected channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns 0 if text is sent or if the channel does not support text transmission. Returns -1 only on error or hangup.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SEND TEXT \"Hello world\"","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Most channels do not support transmission of text.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SET CALLERID ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Changes the caller ID of the current channel","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Always returns 200 result=1","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SET CALLERID \"John Smith\"<1234567>","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This command will let you take liberties with the but the format shown in the example above works well: the name enclosed in double quotes followed immediately by the number inside angle brackets. If there is no name then you can omit it.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the name contains no spaces you can omit the double quotes around it.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The number must follow the name immediately; don't put a space between them.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The angle brackets around the number are necessary; if you omit them the number will be considered to be part of the name.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SET CONTEXT ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Sets the context for continuation upon exiting the application.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Always returns 200 result=0.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SET CONTEXT demo","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Setting the context does NOT automatically reset the extension and the priority; if you want to start at the top of the new context you should set extension and priority yourself.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you specify a non-existent context you receive no error indication (the result returned is still 'result=0') but you do get a warning message on the Asterisk console.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SET EXTENSION ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Set the extension to be used for continuation upon exiting the application.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Always returns 200 result=0.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SET EXTENSION 23","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Setting the extension does NOT automatically reset the priority. If you want to start with the first priority of the extension you should set the priority yourself.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you specify a non-existent extension you receive no error indication (the result returned is still 'result=0') but you do get a warning message on the Asterisk console.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SET PRIORITY ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Set the priority to be used for continuation upon exiting the application.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Always returns 200 result=0.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SET PRIORITY 5","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"paragraph","content":[{"text":"If you specify a non-existent priority you receive no error indication of any sort: the result returned is still 'result=0' and no warning is issued on the Asterisk console.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SET VARIABLE ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Sets a variable to the specified value. The variables so created can later be used by later using ${} in the dialplan.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Always returns 200 result=1.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example SET VARIABLE station zap/3","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a variable named 'station' with the value 'zap/3'.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Unlike most of Asterisk, variable names are case sensitive. The names 'Foo' and 'foo' refer to two separate and distinct variables.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the value being assigned contains spaces then put it inside double quotes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you want double quotes inside the value then you have to escape them. For example to create a variable CID whose value is \"John Doe\"<555-1212> you could use: SET VARIABLE CID \"\\\"John Doe \\\"<555-1212>","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Be aware that the language you are using may eat the backslash before it gets passed to Asterisk; you may have to use two backslashes or otherwise tell the language that, yes, you really do want a backslash in the string you are sending.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"These variables live in the channel Asterisk creates when you pickup a phone and as such they are both local and temporary. Variables created in one channel can not be accessed by another channel. When you hang up the phone, the channel is deleted and any variables in that channel are deleted as well.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"STREAM FILE ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Play the given audio file, allowing playback to be interrupted by a DTMF digit. This command is similar to the GET DATA command but this command returns after the first DTMF digit has been pressed while GET DATA can accumulated any number of digits before returning.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns If playback finished with no acceptable digit being pressed the result is zero. If an acceptable digit was pressed the result is the decimal representation of the pressed digit. If the channel was disconnected or an error occurred the result is -1.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example STREAM FILE welcome #","type":"text"}]},{"type":"paragraph","content":[{"text":"Plays the file 'welcome'. If the user presses the '#' key the playing stops and the command returns 200 result=35","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Don't give an extension with the filename.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Asterisk looks for the file to play in /var/lib/asterisk/sounds","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use double quotes if the message should play completely. For example to play audio file 'welcome' without allowing interruption by digits use: STREAM FILE welcome \"\"","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"TDD MODE ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Enable or disable TDD transmission/reception on the current channel.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns 1 if successful or 0 if the channel is not TDD capable.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example TDD MODE on","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"paragraph","content":[{"text":"The argument can be 'on' or 'tdd' to enable tdd mode. It can also be 'mate' which apparently sets some unspecified tdd mode. If it is anything else ('off' for example) then tdd mode is disabled.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"VERBOSE []","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Sends to the Asterisk console via the 'verbose' message system.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns Always returns 1","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example VERBOSE Hello 3","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends the message \"Hello\" to the console if the current Asterisk verbosity level is set to 3 or greater.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" is the verbosity level in the range 1 through 4.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your message contains spaces, then enclose it in double quotes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Asterisk verbosity system works as follows. The Asterisk usbr gets to set the desired verbosity at startup time or later using the console 'set verbose' command. Messages are displayed on the console if their verbose level is less than or equal to desired verbosity set by the user. More important messages should have a low verbose level; less important messages should have a high verbose level.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"WAIT FOR DIGIT ","type":"text"}]},{"type":"paragraph","content":[{"text":"Purpose Waits up to 'timeout' milliseconds for channel to receive a DTMF digit","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Returns -1 on channel failure, 0 if no digit is received in timeout or the numerical value of the ascii of the digit received.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use -1 for the timeout value if you want the call to wait indefinitely.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Example WAIT FOR DIGIT 3000","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This page has no content. Enrich Array by contributing.","type":"text"}]}]}]}],"version":1}

Browser not supported