Functions 224

A

ABS() Returns absolute value of a number. AES_DECRYPT() Decrypt a string encoded in base64 with AES given a 16 character key. AES_ENCRYPT() Encrypt a string with AES given a 16 character key. AGC() Apply automatic gain control to audio on a channel. AGENT() Gets information about an Agent AMI_CLIENT() Currently, the only supported parameter is "sessions" which will return the current number of active... ARRAY() The comma-delimited list passed as a value to which the function is set will be interpreted as a set... AST_CONFIG() Retrieve a variable from a configuration file. AST_SORCERY() Get a field from a sorcery object

B

BASE64_DECODE() Decode a base64 string. BASE64_ENCODE() Encode a string in base64. BASENAME() Return the name of a file. BLACKLIST() Uses astdb to check if the Caller*ID is in family 'blacklist'. Returns '1' or '0'. Asterisk dialplan...

C

CALENDAR_BUSY() Determine if the calendar is marked busy at this time. CALENDAR_EVENT() Get calendar event notification data from a notification call. CALENDAR_QUERY() Query a calendar server and store the data on a channel CALENDAR_QUERY_RESULT() Retrieve data from a previously run CALENDAR_QUERY() call CALENDAR_WRITE() Write event data to a calendar entry from the Asterisk dialplan. Set fields like summary, descriptio... CALLCOMPLETION() Get or set a call completion configuration parameter for a channel. CALLERID() Gets or sets Caller*ID data on the channel. CALLERPRES() Gets or sets Caller*ID presentation on the channel. CDR() Read or set Call Detail Record fields in the dialplan. Access standard CDR fields (src, dst, duratio... CDR_PROP() Set a property on a channel's CDR. CHANNEL() Gets/sets various pieces of information about the channel, additional item may be available from the... CHANNELS() Gets the list of channels, optionally filtering by a regular expression. CHANNEL_EXISTS() Checks if the specified channel exists. CHECKSIPDOMAIN() Checks if the domain in the argument is configured as a local SIP domain that this Asterisk server i... CONFBRIDGE() Set a custom dynamic bridge, user, or menu profile on a channel for the ConfBridge application using... CONFBRIDGE_CHANNELS() Get a list of channels in a ConfBridge conference. CONFBRIDGE_INFO() Get information about a ConfBridge conference. CONNECTEDLINE() Gets or sets Connected Line data on the channel. CSV_QUOTE() Quotes a given string for use in a CSV file, escaping embedded quotes as necessary CURL() Retrieve content from a remote web or ftp server CURLOPT() Sets various options for future invocations of CURL. CUT() Slices and dices strings, based upon a named delimiter.

D

DAHDI_CHANNEL() Set or get a property of a DAHDI channel. DB() Will read from or write a value to the Asterisk database. On a read, this function returns the corre... DB_DELETE() Will retrieve a value from the Asterisk database and then remove that key from the database. DBRESUL... DB_EXISTS() Check to see if a key exists in the Asterisk database. DB_KEYCOUNT() Obtain the number of keys at a prefix within the Asterisk database. DB_KEYS() Obtain a list of keys within the Asterisk database. DEC() Decrements the value of a variable, while returning the updated value to the dialplan DELETE() Deletes a specified channel variable. DENOISE() The DENOISE function will apply noise reduction to audio on the channel that it is executed on. Aste... DEVICE_STATE() The DEVICE\STATE function can be used to retrieve the device state from any device state provider. A... DIALGROUP() Presents an interface meant to be used in concert with the Dial application, by presenting a list of... DIALPLAN_EXISTS() Checks the existence of a dialplan target. DIGIT_SUM() Returns the sum of all the digits in a number. DIRNAME() Return the directory of a file. DUNDILOOKUP() This will do a DUNDi lookup of the given phone number. This function will return the Technology/Reso... DUNDIQUERY() This will do a DUNDi lookup of the given phone number. The result of this function will be a numeric... DUNDIRESULT() Retrieve results from a DUNDIQUERY.

E

ENUMLOOKUP() General or specific querying of NAPTR records for ENUM or ENUM-like DNS pointers. ENUMQUERY() Initiate an ENUM query. ENUMRESULT() Retrieve results from a ENUMQUERY. ENV() Variables starting with 'AST\_' are reserved to the system and may not be set. Additionally, the fol... EVAL() Using EVAL basically causes a string to be evaluated twice. When a variable or expression is in the ... EVAL_EXTEN() Evaluates the contents of a dialplan extension and returns it as a string. EVAL_SUB() Executes a Gosub and provides its return value as a string EXCEPTION() Retrieve the details of the current dialplan exception. EXISTS() Test the existence of a value. EXPORT() Set variables or dialplan functions on any arbitrary channel that exists. EXTENSION_STATE() The EXTENSION\STATE function can be used to retrieve the state from any hinted extension. Asterisk d...

F

FAXOPT() Gets/sets various pieces of information about a fax session. FEATURE() Get or set a feature option on a channel. FEATUREMAP() Get or set a feature map to a given value on a specific channel. FIELDNUM() Search the variable named varname for the string value delimited by delim and return a 1-based offse... FIELDQTY() The delimiter may be specified as a special or extended ASCII character, by encoding it. Asterisk di... FILE() Read and write text files from the Asterisk dialplan in character and line mode. Supports reading, w... FILE_COUNT_LINE() Returns the number of lines, or '-1' on error. If 'live\_dangerously' in 'asterisk.conf' is set to '... FILE_FORMAT() Return the line terminator type: 'u' - Unix "\n" format 'd' - DOS "\r\n" format 'm' - Macintosh "\r"... FILTER() Permits all characters listed in allowed-chars, filtering all others outs. In addition to literally ... FRAME_DROP() Drops specific frame types in the TX or RX direction on a channel. FRAME_TRACE() View internal ast_frames as they are read and written on a channel.

G

GEOLOC_PROFILE() When used to set a parameter on a profile, if the profile doesn't already exist, a new one will be c... GLOBAL() Gets or sets the global variable specified. GLOBAL_DELETE() Delete the global variable specified in varname. Will succeed if the global variable exists or not. ... GLOBAL_EXISTS() Check if a global variable exists or not. GROUP() Category can be employed for more fine grained group management. Each channel can only be member of ... GROUP_COUNT() Counts the number of channels in the specified group. GROUP_LIST() Gets a list of the groups set on a channel. GROUP_MATCH_COUNT() Counts the number of channels in the groups matching the specified pattern.

H

HANGUPCAUSE() Gets per-channel hangupcause information from the channel. HANGUPCAUSE_KEYS() Gets the list of channels for which hangup causes are available. HASH() In two arguments mode, gets and sets values to corresponding keys within a named associative array. ... HASHKEYS() Retrieve the keys of the HASH() function. HINT() The HINT function can be used to retrieve the list of devices that are mapped to a dialplan hint. As... HOLD_INTERCEPT() Intercepts hold frames on a channel and raises an event instead of passing the frame on

I

IAXPEER() Gets IAX peer information. IAXVAR() Sets or retrieves a remote variable. ICONV() Converts charsets of strings. IF() Check for an expression. IFMODULE() Checks if a module is loaded. Use the full module name as shown by the list in 'module list'. Return... IFTIME() Temporal Conditional. IMPORT() Retrieve the value of a variable from another channel. INC() Increments the value of a variable, while returning the updated value to the dialplan ISNULL() Check if a value is NULL.

J

JABBER_RECEIVE() Reads XMPP messages. JABBER_STATUS() Retrieves the numeric status associated with the buddy identified by jid. The return value will be o... JITTERBUFFER() Add a Jitterbuffer to the Read side of the channel. This dejitters the audio stream before it reache... JSON_DECODE() Extract values from JSON strings in the Asterisk dialplan. Commonly used to parse API responses from...

K

KEYPADHASH() Hash the letters in string into equivalent keypad numbers.

L

LEN() Return the length of a string in the Asterisk dialplan. Counts characters in the given argument. Com... LISTFILTER() Remove value from the list contained in the varname variable, where the list delimiter is specified ... LOCAL() Read and write a variable local to the gosub stack frame, once we Return() it will be lost (or it wi... LOCAL_PEEK() Retrieve variables hidden by the local gosub stack frame. LOCK() Attempts to grab a named lock exclusively, and prevents other channels from obtaining the same lock.... LOG_GROUP() Set the channel group name for log filtering on this channel LTRIM() Trim leading whitespace in a string

M

MAILBOX_EXISTS() DEPRECATED. Use VM\INFO(mailbox\[@context\],exists) instead. /// Returns a boolean of whether the co... MASTER_CHANNEL() Allows access to the oldest channel associated with the current channel if it still exists. Asterisk... MATH() Performs Mathematical Functions. MAX() Returns the maximum of two numbers. MD5() Computes an MD5 digest. MEETME_INFO() Query a given conference of various properties. MESSAGE() Will read from or write a value to a text message. It is used both to read the data out of an incomi... MESSAGE_DATA() Will read from or write a value to a text message. It is used both to read the data out of an incomi... MIN() Returns the minimum of two numbers. MINIVMACCOUNT() Gets MiniVoicemail account information. MINIVMCOUNTER() The operation is atomic and the counter is locked while changing the value. The counters are stored ... MIXMONITOR() Retrieve data pertaining to specific instances of MixMonitor on a channel. MUTEAUDIO() The MUTEAUDIO function can be used to mute inbound (to the PBX) or outbound audio in a call. Asteris...

O

ODBC() Controls ODBC transaction properties. ODBC_FETCH() For queries which are marked as mode=multirow, the original query returns a result-id from which res...

P

PARK_GET_CHANNEL() Get the channel name of an occupied parking space in a parking lot. PASSTHRU() Literally returns the given string. The intent is to permit other dialplan functions which take a va... PERIODIC_HOOK() Execute a periodic dialplan hook into the audio of a call. PITCH_SHIFT() Pitch shift both tx and rx audio streams on a channel. PJSIP_AOR() Get information about a PJSIP AOR PJSIP_CONTACT() Get information about a PJSIP contact PJSIP_DIAL_CONTACTS() Return a dial string for dialing all contacts on an AOR. PJSIP_DTMF_MODE() When read, returns the current DTMF mode When written, sets the current DTMF mode This function uses... PJSIP_ENDPOINT() Get information about a PJSIP endpoint PJSIP_HEADER() Read, add, update, or remove SIP headers on PJSIP channels. Use PJSIP_HEADER to inspect inbound head... PJSIP_HEADERS() Gets the list of SIP header names from an INVITE message. PJSIP_HEADER_PARAM() Get or set header/URI parameters on a PJSIP channel. PJSIP_INHERITABLE_HEADER() Adds, updates or removes the specified SIP header from a PJSIP or non-PJSIP channel to be inherited ... PJSIP_MEDIA_OFFER() Media and codec offerings to be set on an outbound SIP channel prior to dialing. PJSIP_MOH_PASSTHROUGH() Get or change the on-hold behavior for a SIP call. PJSIP_PARSE_URI() Parse a URI and return a type part of the URI. PJSIP_PARSE_URI_FROM() Parse the contents of a variable as a URI and return a type part of the URI. PJSIP_RESPONSE_HEADER() Gets headers of 200 response from an outbound PJSIP channel. PJSIP_RESPONSE_HEADERS() Gets the list of SIP header names from the 200 response of INVITE message. PJSIP_SEND_SESSION_REFRESH() W/O: Initiate a session refresh via an UPDATE or re-INVITE on an established media session PJSIP_TRANSFER_HANDLING() Set how transfers are handled for a PJSIP channel. POLARITY() The POLARITY function can be used to set the polarity of a DAHDI channel. Applies only to FXS channe... POP() Removes and returns the last item off of a variable containing delimited text PP_EACH_EXTENSION() Output the specified template for each extension associated with the specified MAC address. Asterisk... PP_EACH_USER() Pass in a string, with phoneprov variables you want substituted in the format of %\{VARNAME\}, and y... PRESENCE_STATE() The PRESENCE\STATE function can be used to retrieve the presence from any presence provider. Asteris... PUSH() Appends one or more values to the end of a variable containing delimited text

Q

QUEUE_EXISTS() Check if a named queue exists on this server QUEUE_GET_CHANNEL() Return caller at the specified position in a queue. QUEUE_MEMBER() Provides a count of queue members based on the provided criteria, or updates a queue member's settin... QUEUE_MEMBER_COUNT() Returns the number of members currently associated with the specified queuename. This function has b... QUEUE_MEMBER_LIST() Returns a comma-separated list of members associated with the specified queuename. Asterisk dialplan... QUEUE_MEMBER_PENALTY() Gets or sets queue members penalty. QUEUE_VARIABLES() Makes the following queue variables available. Returns '0' if queue is found and setqueuevar is defi... QUEUE_WAITING_COUNT() Count number of calls currently waiting in a queue. QUOTE() Quotes a given string, escaping embedded quotes as necessary

R

RAND() Choose a random number between min and max. min defaults to '0', if not specified, while max default... REALTIME() Will read or write values from/to a RealTime repository. REALTIME(....) will read names/values from ... REALTIME_DESTROY() RealTime Destroy Function. REALTIME_FIELD() RealTime query function. REALTIME_HASH() Retrieves a single record from the RT engine, where fieldmatch contains the value matchvalue and for... REALTIME_STORE() Will insert a new set of values into the RealTime repository. If RT engine provides an unique ID of ... RECORDING_INFO() Retrieve information about a recording previously created using the Record application REDIRECTING() Gets or sets Redirecting data on the channel. The orig-pres, from-pres and to-pres fields get/set a ... REGEX() Return '1' on regular expression match or '0' otherwise Please note that the space following the dou... REPLACE() Replace a set of characters in a given string with another character. RTRIM() Trim trailing whitespace in a string

S

SAYFILES() Returns the ampersand-delimited file names that would be played by the Say applications (e.g. SayAlp... SCRAMBLE() Scrambles audio on a channel using whole spectrum inversion. This is not intended to be used for sec... SET() SET assigns a value to a channel variable. SHA1() Computes a SHA1 digest. SHARED() Implements a shared variable area, in which you may share variables between channels. Asterisk dialp... SHELL() Executes a command using the system shell and captures its output. SHIFT() Removes and returns the first item off of a variable containing delimited text SIPPEER() ### Syntax SIPPEER(peername,item). Asterisk dialplan function reference. SIP_HEADER() Reads a named SIP header from an incoming INVITE message. Supports indexed access for repeated heade... SIP_HEADERS() Gets the list of SIP header names from an incoming INVITE message. SMDI_MSG() Is used to access details of an SMDI message that was pulled from the incoming SMDI message queue us... SMDI_MSG_RETRIEVE() Is used to retrieve an incoming SMDI message. It returns an ID which can be used with the SMDI\_MSG(... SORT() Sorts a list of key/vals into a list of keys, based upon the vals. SPEECH() Gets information about speech recognition results. SPEECH_ENGINE() Get or change a speech engine specific attribute. SPEECH_GRAMMAR() Gets the matched grammar of a result if available. SPEECH_RESULTS_TYPE() Sets the type of results that will be returned. Valid options are normal or nbest. Asterisk dialplan... SPEECH_SCORE() Gets the confidence score of a result. SPEECH_TEXT() Gets the recognized text of a result. SPRINTF() Parses the format string specified and returns a string matching that format. Supports most options ... SQL_ESC() Escapes single ticks for use in SQL statements. SQL_ESC_BACKSLASHES() Escapes backslashes for use in SQL statements. SRVQUERY() Initiate an SRV query. SRVRESULT() Retrieve results from an SRVQUERY. STACK_PEEK() Read the calling 'c'ontext, 'e'xtension, 'p'riority, or 'l'abel, as specified by which, by going up ... STAT() > Note > > If 'live_dangerously' in 'asterisk.conf' is set to 'no', this function can only be execut... STIR_SHAKEN() Gets the number of STIR/SHAKEN results or a specific STIR/SHAKEN value from a result on the channel. STIR_SHAKEN_ATTESTATION() Sets STIR/SHAKEN Attestation parameters on an outgoing channel. STRBETWEEN() Inserts a substring between each character in a string. STRFTIME() Returns the current date/time in the specified format. STRPTIME() Returns the epoch of the arbitrary date/time string structured as described by the format. STRREPLACE() Replace instances of a substring within a string with another string. SYSINFO() Returns system information specified by parameter.

T

TALK_DETECT() Raises notifications when Asterisk detects silence or talking on a channel. TESTTIME() Sets a time to be used with the channel to test logical conditions. TIMEOUT() The timeouts that can be manipulated are: absolute: The absolute maximum amount of time permitted fo... TOLOWER() Convert a string to lowercase in the Asterisk dialplan. Useful for normalizing input before pattern ... TONE_DETECT() Asynchronously detects a tone TOUPPER() Convert a string to uppercase in the Asterisk dialplan. Useful for normalizing input before pattern ... TRIM() Trim leading and trailing whitespace in a string TRYLOCK() Attempt to obtain a named mutex. TXTCIDNAME() Looks up the given phone number in DNS to retrieve the caller id name. The result will either be bla...

U

UNLOCK() Unlocks a previously locked mutex. Returns '1' if the channel had a lock or '0' otherwise. Asterisk ... UNSHIFT() Inserts one or more values to the beginning of a variable containing delimited text URIDECODE() Decodes a URI-encoded string according to RFC 2396. URIENCODE() Encodes a string to URI-safe encoding according to RFC 2396. UUID() Generates an UUID.

V

VALID_EXTEN() Returns a true value if the indicated context, extension, and priority exist. This function has been... VARIABLE_EXISTS() Check if a dialplan variable exists or not. VERSION() Return the current Asterisk version string, or compare it against a specified version using standard... VMCOUNT() Count the voicemails in a specified mailbox or mailboxes. VM_INFO() Returns the selected attribute from the specified mailbox. If context is not specified, defaults to ... VOLUME() The VOLUME function can be used to increase or decrease the 'tx' or 'rx' gain of any channel. Asteri...