The <Transfer> element permits to transfer the call to a Basix user, group, conference room, voicemail box, PSTN number etc.

To transfer to a user voicemail box, you can pass "uservoicemail,UserName" as transfer target.

To transfer to a group voicemail box, you can pass "groupvoicemail,GroupName" as transfer target.

Element Attributes

Attribute Name Description Allowed Values Default Value
callingNumber Optional: a calling number to be used in case the transfer is done to PSTN (it must be a calling number belonging to your Basix PBX). If not provided, your Basix domain calling number will be used. none
failureAction Optional: URL to be called (or Section name to where we would jump to) in case transfer fails (it can be a list of URLs separated by commas to permit fallback in case the main URL fails to reply). The HTTP POST request sent to the URL will contain paramenter TransferFailureReason set to 'busy', 'no_answer' etc. It can also be the name of a Section Element to where the control will jump in case of failure. none
answerTimeout Optional: overrides the default answer timeout of the transfer target (user or group). Allowed range: 5 to 180 seconds. Only valid if attribute failureAction is provided (it doesn't work for transfer to PSTN number as this is not configurable in Basix so it cannot be overridden). none
suppressPreAnswerAudio Optional: for transfers to PSTN, suppresses the pre-answer audio (ringing etc) with MusicOnHold true or false false
relayReceivedCallingNumber Optional: in case of transfer to PSTN, if set to true, forces relay of ANI received from caller (cannot be used with attribute callingNumber) true or false false
  • for transfers to PSTN, answerTimeout will only work if suppressPreAnswerAudio is set to 'true'.
  • in case of transfer to users or groups, if failureAction is set and the target has forward enabled, forward will not be executed: the transfer will fail and failureAction will be contacted.
  • if Transfer fails, variable TransferFailureReason will be set and can be inspected using element Switch.

Examples

Example 1: Transfer to PSTN number

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer>0312341234</Transfer>
</Response>

Example 2: Transfer to PSTN number with callingNumber

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer callingNumber="05068681111">0312341234</Transfer>
</Response>

Example 3: Transfer to extension number with failureAction (2 URLs) and answerTimeout

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer failureAction="http://somewhere1/failed,http://somewhere2/failed" answerTimeout="20">1000</Transfer>
</Response>

Example 4: Transfer to user jones

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer>jones</Transfer>
</Response>

Example 5: Transfer to group sales

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer>sales</Transfer>
</Response>

Example 6: Transfer to voicemail box of user jones

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer>uservoicemail,jones</Transfer>
</Response>

Example 7: Transfer to voicemail box of group sales

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer>groupvoicemail,sales</Transfer>
</Response>

Example 8: Transfer to PSTN suppressing pre-answer PSTN audio

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Transfer suppressPreAnswerAudio="true" answerTimeout="10" failureAction="http://somewhere/failed">0312341234</Transfer>
</Response>

Example 9: Transfer with failureAction to jump to Section

1
2
3
4
5
6
7
8
9

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<Section name="main">
		<Transfer failureAction="transferFailure">sales</Transfer>
	</Section>
	<Section name="transferFailure">
		<Speak voice="rms">Sorry. Transfer to sales failed.</Speak>
	</Section>
</Response>