How to do routing using javascript

From Yate Documentation
Jump to: navigation, search

The Javascript module offers support for programmatically routing a call.

Using the example below you will learn how to:

  • route calls starting with specific blocks of numbers to the desired destinations
  • route calls to a specific gateway set in accfile module


Configure script in Javascript module

To configure a routing script you must list it in the javascript.conf file.

Parameter routing from [general] section must contain the name of the script.


Configure a gateway

In order to route outside, a gateway is required. To set the gateway you must configure it in accfile.conf.

;the registrar has the following format IP:port

Routing Script

This is the example.js script.
By default your script should be in share/scripts directory from Yate sources.

// First display calling and called party numbers
Engine.output("Got call from '" + message.caller + "' to '" + message.called + "'");

if (message.called.substr(0,2)=="19") {
        // route calls starting with 19 to
        // 5060 is the default SIP port. When using the default port you don't need to specify it
        Channel.callJust("sip/sip:" + message.called + "@");

} else if (message.called.substr(0,2)=="00" && message.called.length>10) {
        //route calls using a function 

} else if (message.called.match("^60")) {
        //route calls starting with 60 to
        Channel.callJust("h323/" + message.called + "@");

} else if (message.caller=="209") {
        //route calls from caller: 209
        Channel.callJust("iax/user_iax@" + message.called + "@iaxcontext");

} else {
        //route other calls that don't match the above rules 

function routeOutside() {
    // rewrite caller number for all calls that will be routed to this account
    message.caller = "+40211231234";

    // rewrite called number: strip 00 and add +_in front of the number
    message.called = "+" + message.called.substr(2);

    // send all calls starting with +40 to line "gwout" defined in accfile.conf
    if(message.called.substr(3) == "+40")        // alternative: if(message.called.match("^\+40.*"))
         message.line = "gwout";
    Channel.callJust("line/" + message.called);

How it works

When a call is coming, a inbound call leg is created.

The inbound call leg is associated with a new script instance.

The parameters in the call.route message are set in the message variable.

Then the main code flow(that is, outside any function) is executed.

The Javascript code can make decisions based on these parameters and can call methods of the Channel object to route the call to the desired destination.

See also

Personal tools