The column <newcol> in 'family' matching column <colmatch>=<value> will be
updated to <newval>. REALTIMECOUNT will be set with the number of rows
updated or -1 if an error occurs.
\end{verbatim}
\section{Record}
\subsection{Synopsis}
\begin{verbatim}
@ -2182,8 +2198,9 @@ Return from gosub routine
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Return()
Jumps to the last label on the stack, removing it.
Return([return-value])
Jumps to the last label on the stack, removing it. The return value, if
any, is saved in the channel variable GOSUB_RETVAL.
\end{verbatim}
@ -2201,50 +2218,6 @@ tone to the user.
\end{verbatim}
\section{Rpt}
\subsection{Synopsis}
\begin{verbatim}
Radio Repeater/Remote Base Control System
\end{verbatim}
\subsection{Description}
\begin{verbatim}
Rpt(nodename[|options]): Radio Remote Link or Remote Base Link Endpoint Process.
Not specifying an option puts it in normal endpoint mode (where source
IP and nodename are verified).
Options are as follows:
X - Normal endpoint mode WITHOUT security check. Only specify
this if you have checked security already (like with an IAX2
user/password or something).
Rannounce-string[|timeout[|timeout-destination]] - Amateur Radio
Reverse Autopatch. Caller is put on hold, and announcement (as
specified by the 'announce-string') is played on radio system.
Users of radio system can access autopatch, dial specified
code, and pick up call. Announce-string is list of names of
recordings, or "PARKED" to substitute code for un-parking,
or "NODE" to substitute node number.
P - Phone Control mode. This allows a regular phone user to have
full control and audio access to the radio system. For the
user to have DTMF control, the 'phone_functions' parameter
must be specified for the node in 'rpt.conf'. An additional
function (cop,6) must be listed so that PTT control is available.
D - Dumb Phone Control mode. This allows a regular phone user to
have full control and audio access to the radio system. In this
mode, the PTT is activated for the entire length of the call.
For the user to have DTMF control (not generally recomended in
this mode), the 'dphone_functions' parameter must be specified
for the node in 'rpt.conf'. Otherwise no DTMF control will be
available to the phone user.
\end{verbatim}
\section{SayAlpha}
\subsection{Synopsis}
\begin{verbatim}
@ -2422,10 +2395,6 @@ channel and all children channels.
g - Set variable globally instead of on the channel
(applies only to variables, not functions)
The use of Set to set multiple variables at once and the g flag have both
been deprecated. Please use multiple Set calls and the GLOBAL() dialplan
function instead.
\end{verbatim}
@ -2442,21 +2411,6 @@ Set the AMA Flags
\end{verbatim}
\section{SetCallerID}
\subsection{Synopsis}
\begin{verbatim}
Set CallerID
\end{verbatim}
\subsection{Description}
\begin{verbatim}
SetCallerID(clid[|a]): Set Caller*ID on a call to a new
value. Sets ANI as well if a flag is used.
This application has been deprecated in favor of Set(CALLERID(all)=...)
\end{verbatim}
\section{SetCallerPres}
\subsection{Synopsis}
\begin{verbatim}
@ -2481,44 +2435,6 @@ Set CallerID Presentation
\end{verbatim}
\section{SetCDRUserField}
\subsection{Synopsis}
\begin{verbatim}
Set the CDR user field
\end{verbatim}
\subsection{Description}
\begin{verbatim}
[Synopsis]
SetCDRUserField(value)
[Description]
SetCDRUserField(value): Set the CDR 'user field' to value
The Call Data Record (CDR) user field is an extra field you
can use for data not stored anywhere else in the record.
CDR records can be used for billing or storing other arbitrary data
(I.E. telephone survey responses)
Also see AppendCDRUserField().
This application has been deprecated in favor of Set(CDR(userfield)=...)
\end{verbatim}
\section{SetGlobalVar}
\subsection{Synopsis}
\begin{verbatim}
Set a global variable to a given value
\end{verbatim}
\subsection{Description}
\begin{verbatim}
SetGlobalVar(variable=value): This application sets a given global variable to
the specified value.
This application has been deprecated in favor of Set(GLOBAL(var)=value)
\end{verbatim}
\section{SetMusicOnHold}
\subsection{Synopsis}
\begin{verbatim}
@ -2533,29 +2449,6 @@ music is played.
\end{verbatim}
\section{SetTransferCapability}
\subsection{Synopsis}
\begin{verbatim}
Set ISDN Transfer Capability
\end{verbatim}
\subsection{Description}
\begin{verbatim}
SetTransferCapability(transfercapability): Set the ISDN Transfer
Capability of a call to a new value.
Valid Transfer Capabilities are:
SPEECH : 0x00 - Speech (default, voice calls)
DIGITAL : 0x08 - Unrestricted digital information (data calls)
RESTRICTED_DIGITAL : 0x09 - Restricted digital information
3K1AUDIO : 0x10 - 3.1kHz Audio (fax calls)
DIGITAL_W_TONES : 0x11 - Unrestricted digital information with tones/announcements
VIDEO : 0x18 - Video
This application has been deprecated in favor of Set(CHANNEL(transfercapability)=...)
\end{verbatim}
\section{SIPAddHeader}
\subsection{Synopsis}
\begin{verbatim}
@ -2592,13 +2485,8 @@ Shared Line Appearance Station
\end{verbatim}
\subsection{Description}
\begin{verbatim}
SLAStation(station):
This application should be executed by an SLA station. The argument depends
on how the call was initiated. If the phone was just taken off hook, then
the argument "station" should be just the station name. If the call was
initiated by pressing a line key, then the station name should be preceded
by an underscore and the trunk name associated with that line button.
For example: "station1_line1".
SLAStation():
\end{verbatim}
@ -2609,10 +2497,7 @@ Shared Line Appearance Trunk
\end{verbatim}
\subsection{Description}
\begin{verbatim}
SLATrunk(trunk):
This application should be executed by an SLA trunk on an inbound call.
The channel calling this application should correspond to the SLA trunk
with the name "trunk" that is being passed as an argument.
SLATrunk():
\end{verbatim}
@ -2624,9 +2509,11 @@ Communicates with SMS service centres and SMS capable analogue phones
\end{verbatim}
\subsection{Description}
\begin{verbatim}
SMS(name|[a][s]): SMS handles exchange of SMS data with a call to/from SMS capabale
SMS(name|[a][s][t][p(d)][r][o]|addr|body):
SMS handles exchange of SMS data with a call to/from SMS capable
phone or SMS PSTN service center. Can send and/or receive SMS messages.
Works to ETSI ES 201 912 compatible with BT SMS PSTN service in UK
and Telecom Italia in Italy.
Typical usage is to use to handle called from the SMS service centre CLI,
or to set up a call using 'outgoing' or manager interface to connect
service centre to SMS()
@ -2634,9 +2521,17 @@ name is the name of the queue used in /var/spool/asterisk/sms
Arguments:
a: answer, i.e. send initial FSK packet.
s: act as service centre talking to a phone.
t: use protocol 2 (default used is protocol 1).
p(N): set the initial delay to N ms (default is 300).
addr and body are a deprecated format to send messages out.
s: set the Status Report Request (SRR) bit.
o: the body should be coded as octets not 7-bit symbols.
Messages are processed as per text file message queues.
smsq (a separate software) is a command to generate message
queues and send messages.
NOTE: the protocol has tight delay bounds. Please use short frames
and disable/keep short the jitter buffer on the ATA to make sure that
respones (ACK etc.) are received in time.
\end{verbatim}
@ -2683,7 +2578,7 @@ This application plays a sound file and waits for the person to speak. Once they
Once they stop talking the processing sound is played to indicate the speech recognition engine is working.
Once results are available the application returns and results (score and text) are available using dialplan functions.
The first text and score are ${SPEECH_TEXT(0)} AND ${SPEECH_SCORE(0)} while the second are ${SPEECH_TEXT(1)} and ${SPEECH_SCORE(1)}.
The first argument is the sound file and the second is the timeout. Note the timeout will only start once the sound file has stopped playing.
The first argument is the sound file and the second is the timeout integer in seconds. Note the timeout will only start once the sound file has stopped playing.
\end{verbatim}
@ -3297,16 +3192,3 @@ Limit scanning to a channel GROUP by setting the option group argument.
\end{verbatim}
\section{ZapSendKeypadFacility}
\subsection{Synopsis}
\begin{verbatim}
Send digits out of band over a PRI
\end{verbatim}
\subsection{Description}
\begin{verbatim}
ZapSendKeypadFacility(): This application will send the given string of digits in a Keypad Facility
Russell Bryant
18 years ago