{"id":21415,"date":"2019-06-11T06:25:53","date_gmt":"2019-06-11T05:25:53","guid":{"rendered":"https:\/\/developer.kore.ai\/?p=21415"},"modified":"2020-12-09T10:16:12","modified_gmt":"2020-12-09T10:16:12","slug":"using-session-and-context-variables-in-tasks","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/v9-0\/docs\/bots\/bot-builder-tool\/dialog-task\/using-session-and-context-variables-in-tasks\/","title":{"rendered":"Using Session Variables in Tasks"},"content":{"rendered":"

When you define tasks, you can access session variables provided by the Bots Platform, or custom variables that you define, as well as the context\u00a0that defines the scope of the variable.<\/p>\n

For example, some API requests may require you to set session variables before the request is executed, or a dialog task component may need to access a session variable to transition to the next node.\u00a0In addition, a dialog task can access the context<\/code> object with additional system variables. For more information, see the\u00a0Context Object<\/a>.<\/p>\n

You can use session variables where you define JavaScript for tasks and the User Prompt editor on the JavaScript tab.<\/p>\n<\/div><\/div>

<\/div><\/div>

<\/span>Session Variables<\/span><\/h2>\n

This section describes the context variables and the scope of the context variables that you can use in your custom JavaScript code for your tasks.<\/p>\n

The JavaScript syntax to GET or PUT a key\/value pair for each context type is:<\/p>\n

   \"EnterpriseContext\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   },\r\n   \"BotContext\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   },\r\n   \"UserContext\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n   },\r\n   \"UserSession\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   },\r\n   \"BotUserSession\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   }<\/pre>\n
For example:<\/p>\n
\u00a0 \u00a0 BotContext.put(\"topicSessionVariable\",\"music\",2000);\r\n\u00a0 \u00a0 UserSession.put(\"firstName\",\"Mary\",20000);\r\n\u00a0 \u00a0 UserContext.get(\"firstName\");<\/pre>\n<\/div><\/div>
<\/div><\/div>
<\/span>Session Variable Types<\/span><\/h2>\n
The following types of session variables are available on the Bots Platform:<\/p>\n