--- title: "Bot JavaScript SDK" slug: "bot-javascript-sdk" updated: 2022-11-29T07:41:59Z published: 2022-11-29T07:41:59Z canonical: "developer.comm100.com/bot-javascript-sdk" --- > ## Documentation Index > Fetch the complete documentation index at: https://developer.comm100.com/llms.txt > Use this file to discover all available pages before exploring further. # Bot JavaScript SDK ## Introduction Bot JavaScript SDK is used to connect Comm100 Live Chat Visitor Side and 3rd party systems. For example, Comm100 Chatbot can send a form to visitors for collecting information. The form can be the built-in form with custom fields or a fully custom form from your webpage. If you are using your own form, you can set values, submit form or get chatbot variables with the SDK. ## Installation To use the SDK, please copy and paste the following code into the form webpage before the closing `</body>` tag ``` ``` ## How to use the SDK It's recommended to wrap your call with a callback function that is assigned to BotJavaScriptSDK.onReady. ``` BotJavaScriptSDK.onReady = function () { // use SDK here safely }; ``` Your can find some examples in this repository: [https://github.com/jeveryun/comm100-botJavaScriptSDK.git](https://github.com/jeveryun/comm100-botJavaScriptSDK.git) ## What the SDK provides Bot JavaScript SDK provides 3 functions: Get, Set and Do. ### Get To get information from chatbot, you can use BotJavaScriptSDK.get: ``` /** * @param {string} type - Type of data to get, you can find all types in doc below. * @return {any} result. */ BotJavaScriptSDK.get("bot.variables"); ``` ### Set To set value to chatbot variable, you can use BotJavaScriptSDK.set: ``` /** * @param {string} type - Type of data to set, you can find all types in doc below. * @param {any} value - Value that will be set. */ BotJavaScriptSDK.set("bot.variable", { name: "Name", value: "xxx", }); ``` ### Do To submit a form or close form page, you can use BotJavaScriptSDK.do: ``` /** * @param {string} type - Type of action to do, you can find all types in doc below. * @param {any} value - Value that will be send. * finished successfully or not. nothing will be returned. */ var name = "xxx"; var email = "xxx@xxx.com"; BotJavaScriptSDK.do( "bot.sendForm.submit", `submit success! \n name: ${name} \n email: ${email}` ); ``` ## Reference ### Site ID ``` const siteId = BotJavaScriptSDK.get(`livechat.siteId`); ``` ### Campaign ID ``` const campaignId = BotJavaScriptSDK.get(`livechat.campaignId`); ``` ### Chat Id ``` const chatId = BotJavaScriptSDK.get(`livechat.chatId`); ``` ### Bot info ``` const botInfo = BotJavaScriptSDK.get("bot.botInfo"); ``` ### Get or Set Custom Variable ``` const customVariables = BotJavaScriptSDK.get("livechat.customVariables"); /** * @return * [ * { * name: "custom variable 1", * value: "current value", * }, * { * name: "non-existant custom variable", * value: "current value", * } * ] */ const values = [ { name: "custom variable 1", value: "current value", }, { name: "non-existant custom variable", value: "current value", }, { name: "ignored custom variable", }, ]; BotJavaScriptSDK.set("livechat.customVariables", values); ``` ### Get or Set Bot variables ``` const collectValues = BotJavaScriptSDK.get("bot.variables"); /** * @return * { * "variableName1": "variable value", * "variableName2": ["variable value1", "variable value2"], * "variableName3": { * "key1": "value", * "key2": "value2" * } * } */ BotJavaScriptSDK.set("bot.variable", { { name: "variableName1", value: "variable value", } }); BotJavaScriptSDK.set("bot.variable", { { name: "variableName2", value: ["variable value1", "variable value2"], } }); BotJavaScriptSDK.set("bot.variable", { { name: "variableName3", value: { "key1": "value", "key2": "value2" } } }); ``` ### Get visitor Info ``` const visitorInfo = Comm100APICrossMessage.get("bot.visitorInfo"); /** * @return * { * name: "", * email: "", * phone: "", * company: "", * product: "", * department: "", * ticketId: "", * ... * } */ ``` ### Submit data ``` var name = "xxx"; var email = "xxx@xxx.com"; BotJavaScriptSDK.do( "bot.sendForm.submit", `submit success! \n name: ${name} \n email: ${email}` ); ``` ### Close webView ``` BotJavaScriptSDK.do("bot.sendForm.close"); ```