Route command

The Route command routes a phone call in response to the RoutingInterception notification.

Command example usage:

By routing calls you can call another number if the call wasn't answered for a specified time. For example if John can't pick up the phone in 20 seconds it will be routed to Michael and he gets 30 seconds to pick it up if not it will be routed to Jessy.

Parameters:

Parameter name Value Description Default value Mandatory
Destination e.g. 1000 The extension to route the call to. The parameter can be provided between the command nodes. (None) Yes
RingTime e.g. 30 Shows in seconds how much time it should wait before the callee picks the phone up. 90 No
CallerId e.g. 1000 The information the callee receives about the identity of the caller, i.e. what the callee should see regarding who calls. (None) No
DialedNumber e.g. 1001 This parameter determines which number should be called. (None) No

OzML example:

In all the examples below, the caller is 1442, the callee is 81234567.

1. example

If the Destination parameter is blank, the call gets disconnected, i.e the caller will be rejected. 

<?xml version="1.0"?>
<Response>
  <Route Destination=""/>
</Response>

2. example

Routes the call to 1000 and rings the phone for a maximum of 30 seconds.
(The CallerId is 1442, the DialedNumber is 81234567.) 

<?xml version="1.0"?>
<Response>
  <Route RingTime="30" Destination="1000"/>
</Response>

3. example

If you call an external number, you should provide the name of the outisde line as Destination. 

<?xml version="1.0"?>
<Response>
  <Route RingTime="30" Destination="voipservice1"/>
</Response>

4. example

If there is a DialedNumber parameter, that particular number will be called through the VoIP Provider connection.
(The CallerId is 1442, the DialedNumber is 234567.) 

<?xml version="1.0"?>
<Response>
  <Route RingTime="30" Destination="voipservice1" DialedNumber="234567"/>
</Response>

5. example

If you provide a CallerId, that Caller ID will be displayed for the callee as the caller. In order for the VoIP Providers to accept this setting option, you should make sure to validate that the given phone number is yours. This way VoIP Providers can ensure that you cannot make calls in the name of another person.
(The CallerId is 1500, the DialedNumber is 81234567.) 

<?xml version="1.0"?>
<Response>
  <Route RingTime="30" Destination="voipservice1" CallerId="1500"/>
</Response>

6. example

If you return a completely empty string, the rules set on the PBX will run and you will not deal with the current call on your webserver.

Route command is used in OzML responses to this notification:
RoutingInterception

More information