modules:transfer

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
modules:transfer [2017/12/29 09:54]
admin
modules:transfer [2020/01/09 16:04] (current)
Line 1: Line 1:
 ====== Transfer ====== ====== Transfer ======
  
-{{:​transfer.png?​nolink|}}+<WRAP group> 
 +<WRAP COLUMN>{{INLINETOC width18 4-5|Transfer}}</​WRAP>​ 
 +<WRAP COLUMN>​{{:​modules:module-transfer.png?​nolink |}}</​WRAP>​ 
 +</​WRAP>​
 ---- ----
  
 ===Function=== ===Function===
-This module facilitates call transfers. Both the prompt field and the destination number field can consist of a static or a variable value.+This module facilitates call transfers. ​\\ 
 +Both the prompt field and the destination number field can consist of a static or a variable value.
  
-You can determine the result of the transfer using a combination of the result_variable,​ and the duration shadow variable (result_variable$.duration). ​+ 
 +Destination number field can accept either a phone number (ex: 800-000-1234) or a SIP address (ex: sip:​1234@10.0.1.2) 
 + 
 + 
 + 
 + 
 +\\ You can determine the result of the transfer using a combination of the //result_variable//, and the duration ​[[:​shadow_variables|shadow variable]] (//result_variable$.duration//). 
 \\ \\
 \\ \\
 ^ Transfer Result ^ Result Variable and Duration ^ ^ Transfer Result ^ Result Variable and Duration ^
-| Caller hung up before transfer began | result_variable = NULL and result_variable$.duration = NULL | +| Caller hung up before transfer began | //result_variable = NULL// and //result_variable$.duration = NULL// 
-| Caller hung up while transfer is ringing | result_variable = NULL and result_variable$.duration = 0 | +| Caller hung up while transfer is ringing | //result_variable = NULL// and //result_variable$.duration = 0// 
-| No one at the far end answered before the connect timeout | result_variable = noanswer and result_variable$.duration = 0| +| No one at the far end answered before the connect timeout | //result_variable = noanswer// and //result_variable$.duration = 0// 
-| Far end was busy | result_variable = busy and result_variable$.duration = 0| +| Far end was busy | //result_variable = busy// and //result_variable$.duration = 0// 
-| Caller hung up during transfer | result_variable = NULL and result_variable$.duration > 0 | +| Caller hung up during transfer | //result_variable = NULL// and //result_variable$.duration > 0// 
-| Far end hung up on the original caller | result_variable = far_end_disconnect and result_variable$.duration > 0 | +| Far end hung up on the original caller | //result_variable = far_end_disconnect// and //result_variable$.duration > 0// 
-| Maximum timeout was reached | result_variable = maxtime_disconnect and result_variable$.duration = maximum timeout |+| Maximum timeout was reached | //result_variable = maxtime_disconnect// and //result_variable$.duration = maximum timeout// |
  
 +
 +\\ If the IVR is not expect to do anything after the entire transfer is finished, an //​[[modules:​exit|Exit]]//​ ( {{:​exit.svg?​nolink&​16x16|}} ) module should be placed at the end of the transfer module to complete the call flow.
 +
 +
 +
 +----
 ===Module Settings=== ===Module Settings===
-  * Hold Music +{{:​modules:​settingsmod-transfer.png?​nolink&​0x240|}} ​
-  * Private +
-  * Show Custom Errors +
-  * Show Custom Timeouts +
-  * Show SIP Headers+
  
-==Setting Notes== +{{page>​modules:​module-settings#​hold-music&​link&​noeditbutton&​nofooter&​firstseconly&​noreadmore}}
-  * The 'Show Custom Errors'​ setting for this module ​displays '​Error'​ and 'No Answer'​ options. If a transfer experiences a connection timeout with 'Show Custom Errors'​ enabled, the call automatically flows to 'No Answer'​. If this setting is not enabled, the call disconnects. +
-  * The 'Show SIP Headers'​ setting ONLY applies to call transfers to a SIP destination (e.g. sip:​1234@1.2.3.4) and not transfers to traditional,​ 10-digit phone numbers. Enabling this option allows users to define custom headers to be sent in the event of a call transfer. Fuse restricts custom headers to the "​User-to-User"​ header or any header that starts with a '​x-'​ prefix. The field uses Fuse's standard WYSIWYG field so developers can inject dyanmic data into the headers using Fuse variables.  +
-  * The default durations for the 'Show Custom Timeouts'​ setting are: Connect Timeout ​30 seconds; Maximum Timeout ​0 (unlimited). ​+
  
 +----
 +{{page>​modules:​module-settings#​private&​link&​noeditbutton&​nofooter&​firstseconly&​noreadmore}}
 +
 +----
 +{{page>​modules:​module-settings#​show-sip-headers&​link&​noeditbutton&​nofooter&​firstseconly&​noreadmore}}
 +
 +----
 +{{page>​modules:​module-settings#​show-custom-errors-transfer&​link&​noeditbutton&​nofooter&​firstseconly&​noreadmore}}
 +
 +----
 +{{page>​modules:​module-settings#​show-custom-timeouts&​link&​noeditbutton&​nofooter&​firstseconly&​noreadmore}}
 +
 +
 +----
 **Advanced Settings**: Advanced Fuse users may want to use shadow variables that are available for the Transfer module. For more information on this functionality,​ please visit the [[:​shadow_variables|Shadow Variables]] page. **Advanced Settings**: Advanced Fuse users may want to use shadow variables that are available for the Transfer module. For more information on this functionality,​ please visit the [[:​shadow_variables|Shadow Variables]] page.
modules/transfer.1514559250.txt.gz · Last modified: 2020/01/09 16:04 (external edit)