asternet/docs/html/Properties_T_AsterNET_Manager_Action_OriginateAction.htm

53 lines
15 KiB
HTML
Raw Permalink Normal View History

<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>OriginateAction Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="OriginateAction class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Action.OriginateAction" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Action" /><meta name="file" content="Properties_T_AsterNET_Manager_Action_OriginateAction" /><meta name="guid" content="Properties_T_AsterNET_Manager_Action_OriginateAction" /><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="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_Manager_Action.htm" title="AsterNET.Manager.Action" tocid="N_AsterNET_Manager_Action">AsterNET.Manager.Action</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_OriginateAction.htm" title="OriginateAction Class" tocid="T_AsterNET_Manager_Action_OriginateAction">OriginateAction Class</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="Properties_T_AsterNET_Manager_Action_OriginateAction.htm" title="OriginateAction Properties" tocid="Properties_T_AsterNET_Manager_Action_OriginateAction">OriginateAction Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_OriginateAction_Account.htm" title="Account Property " tocid="P_AsterNET_Manager_Action_OriginateAction_Account">Account Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_OriginateAction_Action.htm" title="Action Property " tocid="P_AsterNET_Manager_Action_OriginateAction_Action">Action Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_OriginateAction_Application.htm" title="Application Property " tocid="P_AsterNET_Manager_Action_OriginateAction_Application">Application Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_OriginateAction_Async.htm" title="Async Property " tocid="P_AsterNET_Manager_Action_OriginateAction_Async">Async Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_OriginateActio
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Account.htm">Account</a></td><td><div class="summary">
Get/Set the account code to use for the originated call.
The account code is included in the call detail record generated for this call and will be used for billing.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Action.htm">Action</a></td><td><div class="summary">
Get the name of this action, i.e. "Originate".
</div> (Overrides <a href="P_AsterNET_Manager_Action_ManagerAction_Action.htm">ManagerAction<span id="LST5E27F775_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST5E27F775_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Action</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_ActionId.htm">ActionId</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Application.htm">Application</a></td><td><div class="summary">
Get/Set Application to use on connect (use Data for parameters)
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Async.htm">Async</a></td><td><div class="summary">
Get/Set true if this is a fast origination.<br />
For the origination to be asynchronous (allows multiple calls to be generated without waiting for a response).
<br />
Will send OriginateSuccess- and OriginateFailureEvents.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_CallerId.htm">CallerId</a></td><td><div class="summary">
Get/Set the caller id to set on the outgoing channel.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Channel.htm">Channel</a></td><td><div class="summary">
Get/Set Channel on which to originate the call (The same as you specify in the Dial application command)<br />
This property is required.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Context.htm">Context</a></td><td><div class="summary">
Get/Set the name of the context of the extension to connect to.
If you set the context you also have to set the exten and priority properties.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Data.htm">Data</a></td><td><div class="summary">
Get/Set the parameters to pass to the application.
Data if Application parameter is user
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Exten.htm">Exten</a></td><td><div class="summary">
Get/Ser the extension to connect to.
If you set the extension you also have to set the context and priority properties.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Priority.htm">Priority</a></td><td><div class="summary">
Get /Set the priority of the extension to connect to.
If you set the priority you also have to set the context and exten properties.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_ProxyKey.htm">ProxyKey</a></td><td><div class="summary">
You can use this as a simple authentication mechanism.<br />
Rather than have to login with a username &amp; password,
you can specify a <b>ProxyKey</b> that must be passed from
a client before requests are processed.<br />
This is helpful in situations where you would like to authenticate and
execute an action in a single step.
</div> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_Server.htm">Server</a></td><td><div class="summary">
Specify a server to which to send your commands (x.x.x.x or hostname).<br />
This should match the server name specified in your config file's "host" entry.
If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
</div> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Timeout.htm">Timeout</a></td><td><div class="summary">
Get/Set the timeout for the origination in milliseconds.<br />
The channel must be answered within this time, otherwise the origination
is considered to have failed and an OriginateFailureEvent is generated.<br />
If not set, Asterisk assumes a default value of 30000 meaning 30 seconds.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Variable.htm">Variable</a></td><td> <strong>Obsolete. </strong><div class="summary">
Get/Set the variables to set on the originated call.<br />
Variable assignments are of the form "VARNAME=VALUE". You can specify
multiple variable assignments separated by the '|' character.<br />
Example: "VAR1=abc|VAR2=def" sets the channel variables VAR1 to "abc" and VAR2 to "def".
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_AsterNET_Manager_Action_OriginateAction.htm">OriginateAction Class</a></div><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Action.htm">AsterNET.Manager.Action Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>