Session Api’s

$.session.close ()

Closes the session and session will start from defautl assigned queue next time

function myHandler(){
    return $.session.close();
}

$.session.route ( options )

Sesison can be switched between multiple apps using routing api by providing QueueCodes

  • options.queue - Target Queue where convesation should swith to.
  • options.team (optional) - works only if options.queue is agent type
  • options.agent (optional) - works only if options.queue is agent type 
$.session.route({
  queue : "my_other_bot",
  params : {
    //Additonal params to send to next app
  }
});

$.session.route.to.queue ( queueCode, params ) 

$.session.route.to.queue("my_agent_app");

// Is short-cut for
$.session.route({
    queue : "my_other_bot",
});

$.session.route.to.team ( teamCode ) 

$.session.route.to.team("my_team_code");

// Is short-cut for
$.session.route({
    queue : "agent_desk", //Default agent queue
    team : "my_team_code"
});

$.session.route.to.agent ( agentCode ) 

$.session.route.to.agent("my_agent_code");

// Is short-cut for
$.session.route({
    queue : "agent_desk", //Default agent queue
    agent : "my_agent_code"
});

$.session.route.to.skills ( skill_1, skill_2, skill3, …skills_n ) 

$.session.route.to.skills("orthos","dental");

// Is short-cut for
$.session.route({
    queue : "agent_desk", //Default agent queue
    skills : ["orthos","dental"]
});

$.session.feedback ( options )

Save sesison feedback.

  • options.score -
  • options.tag -
  • options.review - 
$.session.feedback({
  score : 5.0
});

$.session.feedback.set.score ( value ) 

$.session.feedback.set.score(5.0);

// Is short-cut for
$.session.feedback({
    score : 5.0
});

$.session.feedback.set.tag ( value ) 

$.session.feedback.set.tag("good");

// Is short-cut for
$.session.feedback({
    tag : "good"
});

$.session.feedback.set.review ( value ) 

$.session.feedback.set.review("It was very helpful");

// Is short-cut for
$.session.feedback({
    review : "It was very helpful"
});

$.session.app.config ( options )

Get your app config.

$.session.app.config();