Asterisk-13-ManagerEvent_AttendedTransfer_29395008.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 ManagerEvent_AttendedTransfer</title>
  5. <link rel="stylesheet" href="styles/site.css" type="text/css" />
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </head>
  8. <body class="theme-default aui-theme-default">
  9. <div id="page">
  10. <div id="main" class="aui-page-panel">
  11. <div id="main-header">
  12. <div id="breadcrumb-section">
  13. <ol id="breadcrumbs">
  14. <li class="first">
  15. <span><a href="index.html">Asterisk Project</a></span>
  16. </li>
  17. <li>
  18. <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
  19. </li>
  20. <li>
  21. <span><a href="Asterisk-13-AMI-Events_29394281.html">Asterisk 13 AMI Events</a></span>
  22. </li>
  23. </ol>
  24. </div>
  25. <h1 id="title-heading" class="pagetitle">
  26. <span id="title-text">
  27. Asterisk Project : Asterisk 13 ManagerEvent_AttendedTransfer
  28. </span>
  29. </h1>
  30. </div>
  31. <div id="content" class="view">
  32. <div class="page-metadata">
  33. Created by <span class='author'> wikibot</span> on Aug 08, 2014
  34. </div>
  35. <div id="main-content" class="wiki-content group">
  36. <h1 id="Asterisk13ManagerEvent_AttendedTransfer-AttendedTransfer">AttendedTransfer</h1>
  37. <h3 id="Asterisk13ManagerEvent_AttendedTransfer-Synopsis">Synopsis</h3>
  38. <p>Raised when an attended transfer is complete.</p>
  39. <h3 id="Asterisk13ManagerEvent_AttendedTransfer-Description">Description</h3>
  40. <p>The headers in this event attempt to describe all the major details of the attended transfer. The two transferer channels and the two bridges are determined based on their chronological establishment. So consider that Alice calls Bob, and then Alice transfers the call to Voicemail. The transferer and bridge headers would be arranged as follows:</p>
  41. <p><em>OrigTransfererChannel</em>: Alice's channel in the bridge with Bob.</p>
  42. <p><em>OrigBridgeUniqueid</em>: The bridge between Alice and Bob.</p>
  43. <p><em>SecondTransfererChannel</em>: Alice's channel that called Voicemail.</p>
  44. <p><em>SecondBridgeUniqueid</em>: Not present, since a call to Voicemail has no bridge.</p>
  45. <p>Now consider if the order were reversed; instead of having Alice call Bob and transfer him to Voicemail, Alice instead calls her Voicemail and transfers that to Bob. The transferer and bridge headers would be arranged as follows:</p>
  46. <p><em>OrigTransfererChannel</em>: Alice's channel that called Voicemail.</p>
  47. <p><em>OrigBridgeUniqueid</em>: Not present, since a call to Voicemail has no bridge.</p>
  48. <p><em>SecondTransfererChannel</em>: Alice's channel in the bridge with Bob.</p>
  49. <p><em>SecondBridgeUniqueid</em>: The bridge between Alice and Bob.</p>
  50. <h3 id="Asterisk13ManagerEvent_AttendedTransfer-Syntax">Syntax</h3>
  51. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  52. <pre>Event: AttendedTransfer
  53. Result: &lt;value&gt;
  54. OrigTransfererChannel: &lt;value&gt;
  55. OrigTransfererChannelState: &lt;value&gt;
  56. OrigTransfererChannelStateDesc: &lt;value&gt;
  57. OrigTransfererCallerIDNum: &lt;value&gt;
  58. OrigTransfererCallerIDName: &lt;value&gt;
  59. OrigTransfererConnectedLineNum: &lt;value&gt;
  60. OrigTransfererConnectedLineName: &lt;value&gt;
  61. OrigTransfererAccountCode: &lt;value&gt;
  62. OrigTransfererContext: &lt;value&gt;
  63. OrigTransfererExten: &lt;value&gt;
  64. OrigTransfererPriority: &lt;value&gt;
  65. OrigTransfererUniqueid: &lt;value&gt;
  66. OrigBridgeUniqueid: &lt;value&gt;
  67. OrigBridgeType: &lt;value&gt;
  68. OrigBridgeTechnology: &lt;value&gt;
  69. OrigBridgeCreator: &lt;value&gt;
  70. OrigBridgeName: &lt;value&gt;
  71. OrigBridgeNumChannels: &lt;value&gt;
  72. SecondTransfererChannel: &lt;value&gt;
  73. SecondTransfererChannelState: &lt;value&gt;
  74. SecondTransfererChannelStateDesc: &lt;value&gt;
  75. SecondTransfererCallerIDNum: &lt;value&gt;
  76. SecondTransfererCallerIDName: &lt;value&gt;
  77. SecondTransfererConnectedLineNum: &lt;value&gt;
  78. SecondTransfererConnectedLineName: &lt;value&gt;
  79. SecondTransfererAccountCode: &lt;value&gt;
  80. SecondTransfererContext: &lt;value&gt;
  81. SecondTransfererExten: &lt;value&gt;
  82. SecondTransfererPriority: &lt;value&gt;
  83. SecondTransfererUniqueid: &lt;value&gt;
  84. SecondBridgeUniqueid: &lt;value&gt;
  85. SecondBridgeType: &lt;value&gt;
  86. SecondBridgeTechnology: &lt;value&gt;
  87. SecondBridgeCreator: &lt;value&gt;
  88. SecondBridgeName: &lt;value&gt;
  89. SecondBridgeNumChannels: &lt;value&gt;
  90. DestType: &lt;value&gt;
  91. DestBridgeUniqueid: &lt;value&gt;
  92. DestApp: &lt;value&gt;
  93. LocalOneChannel: &lt;value&gt;
  94. LocalOneChannelState: &lt;value&gt;
  95. LocalOneChannelStateDesc: &lt;value&gt;
  96. LocalOneCallerIDNum: &lt;value&gt;
  97. LocalOneCallerIDName: &lt;value&gt;
  98. LocalOneConnectedLineNum: &lt;value&gt;
  99. LocalOneConnectedLineName: &lt;value&gt;
  100. LocalOneAccountCode: &lt;value&gt;
  101. LocalOneContext: &lt;value&gt;
  102. LocalOneExten: &lt;value&gt;
  103. LocalOnePriority: &lt;value&gt;
  104. LocalOneUniqueid: &lt;value&gt;
  105. LocalTwoChannel: &lt;value&gt;
  106. LocalTwoChannelState: &lt;value&gt;
  107. LocalTwoChannelStateDesc: &lt;value&gt;
  108. LocalTwoCallerIDNum: &lt;value&gt;
  109. LocalTwoCallerIDName: &lt;value&gt;
  110. LocalTwoConnectedLineNum: &lt;value&gt;
  111. LocalTwoConnectedLineName: &lt;value&gt;
  112. LocalTwoAccountCode: &lt;value&gt;
  113. LocalTwoContext: &lt;value&gt;
  114. LocalTwoExten: &lt;value&gt;
  115. LocalTwoPriority: &lt;value&gt;
  116. LocalTwoUniqueid: &lt;value&gt;
  117. DestTransfererChannel: &lt;value&gt;
  118. TransfereeChannel: &lt;value&gt;
  119. TransfereeChannelState: &lt;value&gt;
  120. TransfereeChannelStateDesc: &lt;value&gt;
  121. TransfereeCallerIDNum: &lt;value&gt;
  122. TransfereeCallerIDName: &lt;value&gt;
  123. TransfereeConnectedLineNum: &lt;value&gt;
  124. TransfereeConnectedLineName: &lt;value&gt;
  125. TransfereeAccountCode: &lt;value&gt;
  126. TransfereeContext: &lt;value&gt;
  127. TransfereeExten: &lt;value&gt;
  128. TransfereePriority: &lt;value&gt;
  129. TransfereeUniqueid: &lt;value&gt;
  130. </pre>
  131. </div></div>
  132. <h5 id="Asterisk13ManagerEvent_AttendedTransfer-Arguments">Arguments</h5>
  133. <ul>
  134. <li><code>Result</code> - Indicates if the transfer was successful or if it failed.
  135. <ul>
  136. <li><code>Fail</code> - An internal error occurred.</li>
  137. <li><code>Invalid</code> - Invalid configuration for transfer (e.g. Not bridged)</li>
  138. <li><code>Not Permitted</code> - Bridge does not permit transfers</li>
  139. <li><code>Success</code> - Transfer completed successfully
  140. <div class="aui-message hint shadowed information-macro">
  141. <p class="title">Note</p>
  142. <span class="aui-icon icon-hint">Icon</span>
  143. <div class="message-content">
  144. <p>A result of <code>Success</code> does not necessarily mean that a target was succesfully contacted. It means that a party was succesfully placed into the dialplan at the expected location.</p>
  145. </div>
  146. </div>
  147. </li>
  148. </ul>
  149. </li>
  150. <li><code>OrigTransfererChannel</code></li>
  151. <li><code>OrigTransfererChannelState</code> - A numeric code for the channel's current state, related to OrigTransfererChannelStateDesc</li>
  152. <li><code>OrigTransfererChannelStateDesc</code>
  153. <ul>
  154. <li><code>Down</code></li>
  155. <li><code>Rsrvd</code></li>
  156. <li><code>OffHook</code></li>
  157. <li><code>Dialing</code></li>
  158. <li><code>Ring</code></li>
  159. <li><code>Ringing</code></li>
  160. <li><code>Up</code></li>
  161. <li><code>Busy</code></li>
  162. <li><code>Dialing Offhook</code></li>
  163. <li><code>Pre-ring</code></li>
  164. <li><code>Unknown</code></li>
  165. </ul>
  166. </li>
  167. <li><code>OrigTransfererCallerIDNum</code></li>
  168. <li><code>OrigTransfererCallerIDName</code></li>
  169. <li><code>OrigTransfererConnectedLineNum</code></li>
  170. <li><code>OrigTransfererConnectedLineName</code></li>
  171. <li><code>OrigTransfererAccountCode</code></li>
  172. <li><code>OrigTransfererContext</code></li>
  173. <li><code>OrigTransfererExten</code></li>
  174. <li><code>OrigTransfererPriority</code></li>
  175. <li><code>OrigTransfererUniqueid</code></li>
  176. <li><code>OrigBridgeUniqueid</code></li>
  177. <li><code>OrigBridgeType</code> - The type of bridge</li>
  178. <li><code>OrigBridgeTechnology</code> - Technology in use by the bridge</li>
  179. <li><code>OrigBridgeCreator</code> - Entity that created the bridge if applicable</li>
  180. <li><code>OrigBridgeName</code> - Name used to refer to the bridge by its BridgeCreator if applicable</li>
  181. <li><code>OrigBridgeNumChannels</code> - Number of channels in the bridge</li>
  182. <li><code>SecondTransfererChannel</code></li>
  183. <li><code>SecondTransfererChannelState</code> - A numeric code for the channel's current state, related to SecondTransfererChannelStateDesc</li>
  184. <li><code>SecondTransfererChannelStateDesc</code>
  185. <ul>
  186. <li><code>Down</code></li>
  187. <li><code>Rsrvd</code></li>
  188. <li><code>OffHook</code></li>
  189. <li><code>Dialing</code></li>
  190. <li><code>Ring</code></li>
  191. <li><code>Ringing</code></li>
  192. <li><code>Up</code></li>
  193. <li><code>Busy</code></li>
  194. <li><code>Dialing Offhook</code></li>
  195. <li><code>Pre-ring</code></li>
  196. <li><code>Unknown</code></li>
  197. </ul>
  198. </li>
  199. <li><code>SecondTransfererCallerIDNum</code></li>
  200. <li><code>SecondTransfererCallerIDName</code></li>
  201. <li><code>SecondTransfererConnectedLineNum</code></li>
  202. <li><code>SecondTransfererConnectedLineName</code></li>
  203. <li><code>SecondTransfererAccountCode</code></li>
  204. <li><code>SecondTransfererContext</code></li>
  205. <li><code>SecondTransfererExten</code></li>
  206. <li><code>SecondTransfererPriority</code></li>
  207. <li><code>SecondTransfererUniqueid</code></li>
  208. <li><code>SecondBridgeUniqueid</code></li>
  209. <li><code>SecondBridgeType</code> - The type of bridge</li>
  210. <li><code>SecondBridgeTechnology</code> - Technology in use by the bridge</li>
  211. <li><code>SecondBridgeCreator</code> - Entity that created the bridge if applicable</li>
  212. <li><code>SecondBridgeName</code> - Name used to refer to the bridge by its BridgeCreator if applicable</li>
  213. <li><code>SecondBridgeNumChannels</code> - Number of channels in the bridge</li>
  214. <li><code>DestType</code> - Indicates the method by which the attended transfer completed.
  215. <ul>
  216. <li><code>Bridge</code> - The transfer was accomplished by merging two bridges into one.</li>
  217. <li><code>App</code> - The transfer was accomplished by having a channel or bridge run a dialplan application.</li>
  218. <li><code>Link</code> - The transfer was accomplished by linking two bridges together using a local channel pair.</li>
  219. <li><code>Threeway</code> - The transfer was accomplished by placing all parties into a threeway call.</li>
  220. <li><code>Fail</code> - The transfer failed.</li>
  221. </ul>
  222. </li>
  223. <li><code>DestBridgeUniqueid</code> - Indicates the surviving bridge when bridges were merged to complete the transfer
  224. <div class="aui-message hint shadowed information-macro">
  225. <p class="title">Note</p>
  226. <span class="aui-icon icon-hint">Icon</span>
  227. <div class="message-content">
  228. <p>This header is only present when <em>DestType</em> is <code>Bridge</code> or <code>Threeway</code></p>
  229. </div>
  230. </div>
  231. </li>
  232. <li><code>DestApp</code> - Indicates the application that is running when the transfer completes
  233. <div class="aui-message hint shadowed information-macro">
  234. <p class="title">Note</p>
  235. <span class="aui-icon icon-hint">Icon</span>
  236. <div class="message-content">
  237. <p>This header is only present when <em>DestType</em> is <code>App</code></p>
  238. </div>
  239. </div>
  240. </li>
  241. <li><code>LocalOneChannel</code></li>
  242. <li><code>LocalOneChannelState</code> - A numeric code for the channel's current state, related to LocalOneChannelStateDesc</li>
  243. <li><code>LocalOneChannelStateDesc</code>
  244. <ul>
  245. <li><code>Down</code></li>
  246. <li><code>Rsrvd</code></li>
  247. <li><code>OffHook</code></li>
  248. <li><code>Dialing</code></li>
  249. <li><code>Ring</code></li>
  250. <li><code>Ringing</code></li>
  251. <li><code>Up</code></li>
  252. <li><code>Busy</code></li>
  253. <li><code>Dialing Offhook</code></li>
  254. <li><code>Pre-ring</code></li>
  255. <li><code>Unknown</code></li>
  256. </ul>
  257. </li>
  258. <li><code>LocalOneCallerIDNum</code></li>
  259. <li><code>LocalOneCallerIDName</code></li>
  260. <li><code>LocalOneConnectedLineNum</code></li>
  261. <li><code>LocalOneConnectedLineName</code></li>
  262. <li><code>LocalOneAccountCode</code></li>
  263. <li><code>LocalOneContext</code></li>
  264. <li><code>LocalOneExten</code></li>
  265. <li><code>LocalOnePriority</code></li>
  266. <li><code>LocalOneUniqueid</code></li>
  267. <li><code>LocalTwoChannel</code></li>
  268. <li><code>LocalTwoChannelState</code> - A numeric code for the channel's current state, related to LocalTwoChannelStateDesc</li>
  269. <li><code>LocalTwoChannelStateDesc</code>
  270. <ul>
  271. <li><code>Down</code></li>
  272. <li><code>Rsrvd</code></li>
  273. <li><code>OffHook</code></li>
  274. <li><code>Dialing</code></li>
  275. <li><code>Ring</code></li>
  276. <li><code>Ringing</code></li>
  277. <li><code>Up</code></li>
  278. <li><code>Busy</code></li>
  279. <li><code>Dialing Offhook</code></li>
  280. <li><code>Pre-ring</code></li>
  281. <li><code>Unknown</code></li>
  282. </ul>
  283. </li>
  284. <li><code>LocalTwoCallerIDNum</code></li>
  285. <li><code>LocalTwoCallerIDName</code></li>
  286. <li><code>LocalTwoConnectedLineNum</code></li>
  287. <li><code>LocalTwoConnectedLineName</code></li>
  288. <li><code>LocalTwoAccountCode</code></li>
  289. <li><code>LocalTwoContext</code></li>
  290. <li><code>LocalTwoExten</code></li>
  291. <li><code>LocalTwoPriority</code></li>
  292. <li><code>LocalTwoUniqueid</code></li>
  293. <li><code>DestTransfererChannel</code> - The name of the surviving transferer channel when a transfer results in a threeway call
  294. <div class="aui-message hint shadowed information-macro">
  295. <p class="title">Note</p>
  296. <span class="aui-icon icon-hint">Icon</span>
  297. <div class="message-content">
  298. <p>This header is only present when <em>DestType</em> is <code>Threeway</code></p>
  299. </div>
  300. </div>
  301. </li>
  302. <li><code>TransfereeChannel</code></li>
  303. <li><code>TransfereeChannelState</code> - A numeric code for the channel's current state, related to TransfereeChannelStateDesc</li>
  304. <li><code>TransfereeChannelStateDesc</code>
  305. <ul>
  306. <li><code>Down</code></li>
  307. <li><code>Rsrvd</code></li>
  308. <li><code>OffHook</code></li>
  309. <li><code>Dialing</code></li>
  310. <li><code>Ring</code></li>
  311. <li><code>Ringing</code></li>
  312. <li><code>Up</code></li>
  313. <li><code>Busy</code></li>
  314. <li><code>Dialing Offhook</code></li>
  315. <li><code>Pre-ring</code></li>
  316. <li><code>Unknown</code></li>
  317. </ul>
  318. </li>
  319. <li><code>TransfereeCallerIDNum</code></li>
  320. <li><code>TransfereeCallerIDName</code></li>
  321. <li><code>TransfereeConnectedLineNum</code></li>
  322. <li><code>TransfereeConnectedLineName</code></li>
  323. <li><code>TransfereeAccountCode</code></li>
  324. <li><code>TransfereeContext</code></li>
  325. <li><code>TransfereeExten</code></li>
  326. <li><code>TransfereePriority</code></li>
  327. <li><code>TransfereeUniqueid</code></li>
  328. </ul>
  329. <h3 id="Asterisk13ManagerEvent_AttendedTransfer-Class">Class</h3>
  330. <p>CALL</p>
  331. <h3 id="Asterisk13ManagerEvent_AttendedTransfer-SeeAlso">See Also</h3>
  332. <h3 id="Asterisk13ManagerEvent_AttendedTransfer-ImportVersion">Import Version</h3>
  333. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  334. </div>
  335. </div> </div>
  336. <div id="footer">
  337. <section class="footer-body">
  338. <p>Document generated by Confluence on Aug 11, 2014 13:39</p>
  339. </section>
  340. </div>
  341. </div> </body>
  342. </html>