Skip to main content Link Search Menu Expand Document (external link)

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"]
});

Table of contents