161 lines
34 KiB
HTML
161 lines
34 KiB
HTML
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AsterNET.FastAGI.Command Namespace</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="AsterNET.FastAGI.Command namespace" /><meta name="Microsoft.Help.F1" content="AsterNET.FastAGI.Command" /><meta name="Microsoft.Help.Id" content="N:AsterNET.FastAGI.Command" /><meta name="Description" content="AsterNet FastAGI Command" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.FastAGI.Command" /><meta name="file" content="N_AsterNET_FastAGI_Command" /><meta name="guid" content="N_AsterNET_FastAGI_Command" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_FastAGI_Command.htm" title="AsterNET.FastAGI.Command" tocid="N_AsterNET_FastAGI_Command">AsterNET.FastAGI.Command</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_AGICommand.htm" title="AGICommand Class" tocid="T_AsterNET_FastAGI_Command_AGICommand">AGICommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_AnswerCommand.htm" title="AnswerCommand Class" tocid="T_AsterNET_FastAGI_Command_AnswerCommand">AnswerCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_ChannelStatusCommand.htm" title="ChannelStatusCommand Class" tocid="T_AsterNET_FastAGI_Command_ChannelStatusCommand">ChannelStatusCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_ControlStreamFileCommand.htm" title="ControlStreamFileCommand Class" tocid="T_AsterNET_FastAGI_Command_ControlStreamFileCommand">ControlStreamFileCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_DatabaseDelCommand.htm" title="DatabaseDelCommand Class" tocid="T_AsterNET_FastAGI_Command_DatabaseDelCommand">DatabaseDelCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_DatabaseDelTreeCommand.htm" title="DatabaseDelTreeCommand Class" tocid="T_AsterNET_FastAGI_Command_DatabaseDelTreeCommand">DatabaseDelTreeCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_DatabaseGetCommand.htm" title="DatabaseGetCommand Class" tocid="T_AsterNET_FastAGI_Command_DatabaseGetCommand">DatabaseGetCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_DatabasePutCommand.htm" title="DatabasePutCommand Class" tocid="T_AsterNET_FastAGI_Command_DatabasePutCommand">DatabasePutCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_ExecCommand.htm" title="ExecCommand Class" tocid="T_AsterNET_FastAGI_Command_ExecCommand">ExecCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_GetDataCommand.htm" title="GetDataCommand Class" tocid="T_AsterNET_FastAGI_Command_GetDataCommand">GetDataCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_GetFullVariableCommand.htm" title="GetFullVariableCommand Class" tocid="T_AsterNET_FastAGI_Command_GetFullVariableCommand">GetFullVariableCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_GetOptionCommand.htm" title="GetOptionCommand Class" tocid="T_AsterNET_FastAGI_Command_GetOptionCommand">GetOptionCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_GetVariableCommand.htm" title="GetVariableCommand Class" tocid="T_AsterNET_FastAGI_Command_GetVariableCommand">GetVariableCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_HangupCommand.htm" title="HangupCommand Class" tocid="T_AsterNET_FastAGI_Command_HangupCommand">HangupCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_NoopCommand.htm" title="NoopCommand Class" tocid="T_AsterNET_FastAGI_Command_NoopCommand">NoopCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_ReceiveCharCommand.htm" title="ReceiveCharCommand Class" tocid="T_AsterNET_FastAGI_Command_ReceiveCharCommand">ReceiveCharCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_ReceiveTextCommand.htm" title="ReceiveTextCommand Class" tocid="T_AsterNET_FastAGI_Command_ReceiveTextCommand">ReceiveTextCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_RecordFileCommand.htm" title="RecordFileCommand Class" tocid="T_AsterNET_FastAGI_Command_RecordFileCommand">RecordFileCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SayAlphaCommand.htm" title="SayAlphaCommand Class" tocid="T_AsterNET_FastAGI_Command_SayAlphaCommand">SayAlphaCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SayDateTimeCommand.htm" title="SayDateTimeCommand Class" tocid="T_AsterNET_FastAGI_Command_SayDateTimeCommand">SayDateTimeCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SayDigitsCommand.htm" title="SayDigitsCommand Class" tocid="T_AsterNET_FastAGI_Command_SayDigitsCommand">SayDigitsCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SayNumberCommand.htm" title="SayNumberCommand Class" tocid="T_AsterNET_FastAGI_Command_SayNumberCommand">SayNumberCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SayPhoneticCommand.htm" title="SayPhoneticCommand Class" tocid="T_AsterNET_FastAGI_Command_SayPhoneticCommand">SayPhoneticCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SayTimeCommand.htm" title="SayTimeCommand Class" tocid="T_AsterNET_FastAGI_Command_SayTimeCommand">SayTimeCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SendImageCommand.htm" title="SendImageCommand Class" tocid="T_AsterNET_FastAGI_Command_SendImageCommand">SendImageCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SendTextCommand.htm" title="SendTextCommand Class" tocid="T_AsterNET_FastAGI_Command_SendTextCommand">SendTextCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetAutoHangupCommand.htm" title="SetAutoHangupCommand Class" tocid="T_AsterNET_FastAGI_Command_SetAutoHangupCommand">SetAutoHangupCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetCallerIdCommand.htm" title="SetCallerIdCommand Class" tocid="T_AsterNET_FastAGI_Command_SetCallerIdCommand">SetCallerIdCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetContextCommand.htm" title="SetContextCommand Class" tocid="T_AsterNET_FastAGI_Command_SetContextCommand">SetContextCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetExtensionCommand.htm" title="SetExtensionCommand Class" tocid="T_AsterNET_FastAGI_Command_SetExtensionCommand">SetExtensionCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetMusicOffCommand.htm" title="SetMusicOffCommand Class" tocid="T_AsterNET_FastAGI_Command_SetMusicOffCommand">SetMusicOffCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetMusicOnCommand.htm" title="SetMusicOnCommand Class" tocid="T_AsterNET_FastAGI_Command_SetMusicOnCommand">SetMusicOnCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetPriorityCommand.htm" title="SetPriorityCommand Class" tocid="T_AsterNET_FastAGI_Command_SetPriorityCommand">SetPriorityCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_SetVariableCommand.htm" title="SetVariableCommand Class" tocid="T_AsterNET_FastAGI_Command_SetVariableCommand">SetVariableCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_StreamFileCommand.htm" title="StreamFileCommand Class" tocid="T_AsterNET_FastAGI_Command_StreamFileCommand">StreamFileCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_TDDModeCommand.htm" title="TDDModeCommand Class" tocid="T_AsterNET_FastAGI_Command_TDDModeCommand">TDDModeCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_VerboseCommand.htm" title="VerboseCommand Class" tocid="T_AsterNET_FastAGI_Command_VerboseCommand">VerboseCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_WaitForDigitCommand.htm" title="WaitForDigitCommand Class" tocid="T_AsterNET_FastAGI_Command_WaitForDigitCommand">WaitForDigitCommand Class</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize"><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize"></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn">AsterNET.FastAGI.Command Namespace</td></tr></table><span class="introStyle"></span><div class="summary">AsterNet FastAGI Command</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Classes</span></div><div id="ID0RBSection" class="collapsibleSection"><table id="typeList" class="members"><tr><th class="iconColumn">
|
||
|
||
</th><th>Class</th><th>Description</th></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_AGICommand.htm">AGICommand</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_AnswerCommand.htm">AnswerCommand</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_ChannelStatusCommand.htm">ChannelStatusCommand</a></td><td><div class="summary">
|
||
Returns the status of the specified channel.
|
||
If no channel name is given the returns the status of the current channel.<br />
|
||
Return values:
|
||
<ul><li>0 Channel is down and available</li><li>1 Channel is down, but reserved</li><li>2 Channel is off hook</li><li>3 Digits (or equivalent) have been dialed</li><li>4 Line is ringing</li><li>5 Remote end is ringing</li><li>6 Line is up</li><li>7 Line is busy</li></ul></div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_ControlStreamFileCommand.htm">ControlStreamFileCommand</a></td><td><div class="summary">
|
||
Plays the given file, allowing playback to be interrupted by the given
|
||
digits, if any, and allows the listner to control the stream.<br />
|
||
If offset is provided then the audio will seek to sample offset before play
|
||
starts.<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed, or -1 on error or if the
|
||
channel was disconnected. <br />
|
||
Remember, the file extension must not be included in the filename.<br />
|
||
Available since Asterisk 1.2
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_DatabaseDelCommand.htm">DatabaseDelCommand</a></td><td><div class="summary">
|
||
Deletes a family or specific keytree within a family in the Asterisk database.<br />
|
||
Returns 1 if successful, 0 otherwise.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_DatabaseDelTreeCommand.htm">DatabaseDelTreeCommand</a></td><td><div class="summary">
|
||
Deletes an entry in the Asterisk database for a given family and key.<br />
|
||
Returns 1 if successful, 0 otherwise.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_DatabaseGetCommand.htm">DatabaseGetCommand</a></td><td><div class="summary">
|
||
Retrieves an entry in the Asterisk database for a given family and key.<br />
|
||
Returns 0 if is not set. Returns 1 if the variable is set and returns the
|
||
value in parenthesis.<br />
|
||
Example return code: 200 result=1 (testvariable)
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_DatabasePutCommand.htm">DatabasePutCommand</a></td><td><div class="summary">
|
||
Adds or updates an entry in the Asterisk database for a given family, key, and value.<br />
|
||
Returns 1 if successful, 0 otherwise.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_ExecCommand.htm">ExecCommand</a></td><td><div class="summary">
|
||
Executes an application with the given options.<br />
|
||
Returns whatever the application returns, or -2 if the application was not found.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_GetDataCommand.htm">GetDataCommand</a></td><td><div class="summary">
|
||
Stream the given file, and recieve DTMF data. The user may interrupt the streaming by starting to enter digits.<br />
|
||
Returns the digits recieved from the channel at the other end.<br />
|
||
Input ends when the timeout is reached, the maximum number of digits is read or the user presses #.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_GetFullVariableCommand.htm">GetFullVariableCommand</a></td><td><div class="summary">
|
||
Returns the value of the given channel varible and understands complex
|
||
variable names and builtin variables, unlike the GetVariableCommand.<br />
|
||
You can also use this command to use custom Asterisk functions. Syntax is "func(args)".<br />
|
||
Returns 0 if the variable is not set or channel does not exist. Returns 1 if
|
||
the variable is set and returns the variable in parenthesis.<br />
|
||
Example return code: 200 result=1 (testvariable)
|
||
Available since Asterisk 1.2
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_GetOptionCommand.htm">GetOptionCommand</a></td><td><div class="summary">
|
||
Plays the given file, and waits for the user to press one of the given
|
||
digits. If none of the esacpe digits is pressed while streaming the file this
|
||
command waits for the specified timeout still waiting for the user to press a
|
||
digit. Streaming always begins at the beginning.<br />
|
||
Returns 0 if no digit being pressed, or the ASCII numerical value of the
|
||
digit if one was pressed, or -1 on error or if the channel was disconnected.
|
||
<br />
|
||
Remember, the file extension must not be included in the filename.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_GetVariableCommand.htm">GetVariableCommand</a></td><td><div class="summary">
|
||
Returns the value of the given channel varible.<br />
|
||
Since Asterisk 1.2 you can also use this command to use custom Asterisk functions. Syntax is "func(args)".<br />
|
||
Returns 0 if the variable is not set. Returns 1 if the variable is set and returns the variable in parenthesis.<br />
|
||
Example return code: 200 result=1 (testvariable)
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_HangupCommand.htm">HangupCommand</a></td><td><div class="summary">
|
||
Hangs up the specified channel. If no channel name is given, hangs up the current channel.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_NoopCommand.htm">NoopCommand</a></td><td><div class="summary">
|
||
Does nothing.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_ReceiveCharCommand.htm">ReceiveCharCommand</a></td><td><div class="summary">
|
||
Receives a character of text on a channel.<br />
|
||
Specify timeout to be the maximum time to wait for input in milliseconds, or 0 for infinite.<br />
|
||
Most channels do not support the reception of text.<br />
|
||
Returns the decimal value of the character if one is received, or 0 if the
|
||
channel does not support text reception. Returns -1 only on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_ReceiveTextCommand.htm">ReceiveTextCommand</a></td><td><div class="summary">
|
||
Receives a string of text on a channel.<br />
|
||
Specify timeout to be the maximum time to wait for input in milliseconds, or
|
||
0 for infinite.<br />
|
||
Most channels do not support the reception of text.<br />
|
||
Returns -1 for failure or 1 for success, and the string in parentheses.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_RecordFileCommand.htm">RecordFileCommand</a></td><td><div class="summary">
|
||
Record to a file until a given dtmf digit in the sequence is received.<br />
|
||
Returns -1 on hangup or error.<br />
|
||
The format will specify what kind of file will be recorded. The timeout is
|
||
the maximum record time in milliseconds, or -1 for no timeout. Offset samples
|
||
is optional, and if provided will seek to the offset without exceeding the
|
||
end of the file. "maxSilence" is the number of seconds of maxSilence allowed
|
||
before the function returns despite the lack of dtmf digits or reaching
|
||
timeout.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SayAlphaCommand.htm">SayAlphaCommand</a></td><td><div class="summary"> Say a given character string, returning early if any of the given DTMF digits are received on the channel.<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed or -1 on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SayDateTimeCommand.htm">SayDateTimeCommand</a></td><td><div class="summary">
|
||
Say a given time, returning early if any of the given DTMF digits are pressed.<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed or -1 on error/hangup.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SayDigitsCommand.htm">SayDigitsCommand</a></td><td><div class="summary">
|
||
Say a given digit string, returning early if any of the given DTMF digits are received on the channel.<br />
|
||
Returns 0 if playback completes without a digit being pressed,
|
||
or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SayNumberCommand.htm">SayNumberCommand</a></td><td><div class="summary">
|
||
Say a given number, returning early if any of the given DTMF number are received on the channel.<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed or -1 on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SayPhoneticCommand.htm">SayPhoneticCommand</a></td><td><div class="summary">
|
||
Say a given character string with phonetics, returning early if any of the given DTMF digits are received on the channel.<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed or -1 on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SayTimeCommand.htm">SayTimeCommand</a></td><td><div class="summary">
|
||
Say a given time, returning early if any of the given DTMF digits are received on the channel.<br />
|
||
Time is the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed or -1 on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SendImageCommand.htm">SendImageCommand</a></td><td><div class="summary">
|
||
Sends the given image on a channel.<br />
|
||
Most channels do not support the transmission of images.<br />
|
||
Returns 0 if image is sent, or if the channel does not support image
|
||
transmission. Returns -1 only on error/hangup.<br />
|
||
Image names should not include extensions.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SendTextCommand.htm">SendTextCommand</a></td><td><div class="summary">
|
||
Sends the given text on a channel.<br />
|
||
Most channels do not support the transmission of text.<br />
|
||
Returns 0 if text is sent, or if the channel does not support text
|
||
transmission. Returns -1 only on error/hangup.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetAutoHangupCommand.htm">SetAutoHangupCommand</a></td><td><div class="summary">
|
||
Cause the channel to automatically hangup at the given number of seconds in the future.<br />
|
||
Of course it can be hungup before then as well. Setting to 0 will cause the
|
||
autohangup feature to be disabled on this channel.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetCallerIdCommand.htm">SetCallerIdCommand</a></td><td><div class="summary">
|
||
Changes the CallerID of the current channel.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetContextCommand.htm">SetContextCommand</a></td><td><div class="summary">
|
||
Sets the context for continuation upon exiting the application.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetExtensionCommand.htm">SetExtensionCommand</a></td><td><div class="summary">
|
||
Sets the extension for continuation upon exiting the application.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetMusicOffCommand.htm">SetMusicOffCommand</a></td><td><div class="summary">
|
||
Turns off music on hold on the current channel.<br />
|
||
Always returns 0.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetMusicOnCommand.htm">SetMusicOnCommand</a></td><td><div class="summary">
|
||
Turns on music on hold on the current channel.<br />
|
||
Always returns 0.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetPriorityCommand.htm">SetPriorityCommand</a></td><td><div class="summary">
|
||
Sets the priority for continuation upon exiting the application.<br />
|
||
Since Asterisk 1.2 SetPriorityCommand also supports labels.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_SetVariableCommand.htm">SetVariableCommand</a></td><td><div class="summary">
|
||
Sets the given channel variable to the given value.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_StreamFileCommand.htm">StreamFileCommand</a></td><td><div class="summary">
|
||
Plays the given file, allowing playback to be interrupted by the given digits, if any.<br />
|
||
If offset is provided then the audio will seek to sample offset before play starts.<br />
|
||
Returns 0 if playback completes without a digit being pressed, or the ASCII
|
||
numerical value of the digit if one was pressed, or -1 on error or if the
|
||
channel was disconnected. <br />
|
||
Remember, the file extension must not be included in the filename.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_TDDModeCommand.htm">TDDModeCommand</a></td><td><div class="summary">
|
||
Enable/Disable TDD transmission/reception on a channel.<br />
|
||
Returns 1 if successful, or 0 if channel is not TDD-capable.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_VerboseCommand.htm">VerboseCommand</a></td><td><div class="summary">
|
||
Sends a message to the console via the verbose message system.<br />
|
||
Always returns 1.
|
||
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_FastAGI_Command_WaitForDigitCommand.htm">WaitForDigitCommand</a></td><td><div class="summary">
|
||
Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.<br />
|
||
Returns -1 on channel failure, 0 if no digit is received in the timeout, or
|
||
the numerical value of the ascii of the digit if one is received. Use -1 for
|
||
the timeout value if you desire the call to block indefinitely.
|
||
</div></td></tr></table></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |