Giter Club home page Giter Club logo

dhee-chatbot-api-js's Introduction

dhee-chatbot-api-js

The javascript API for initiating chat with agents deployed in Dhee.AI cloud.

Download the JS file dhee-chat-api.js and include it in your server's scripts.

An example for reference is available here https://github.com/DheeYantra/dhee-chatbot-api-js/tree/main/src/main/resources/static

Add the script then to the HTML page where you would want your users to have chat conversations.

Add dependencies : JQuery, JsJac.js

Initialize the chat client as below:

var dheeChatConfig = {};
dheeChatConfig.instanceId = 'js-api-test';
dheeChatConfig.inputMessageBoxId = 'userMessage';
dheeChatConfig.onIncomingMessage = onMessage;
dheeChatConfig.onAllBotsBusy = onAllBotsBusy;
DheeChatApi.init(dheeChatConfig);

A chat is started as in the example below :

DheeChatApi.launchDheeChat(USERNAME, CONTACTNUMBER, LANGUAGE);

USERNAME is the name with which the bot is supposed to address the chat user. CONTACTNUMBER is the mobile number of the chat user if available. Else fill in with 10 zeros.

Supported languages are : ENGLISH, HINDI, BANGLA, TAMIL, TELUGU, KANNADA, MARATHI, GUJARATI, MALAYALAM

Event handlers can be set as below :

dheeChatConfig.onIncomingMessage =  function(message) {
// handle message from bot, like displaying in a div.
}

Events supported are onIncomingMessage, onError, onAllBotsBusy.

At any point disable speak aloud feature with -

            DheeChatApi.disableSpeechSynthesis()

To re-enable speech synthesis -

            DheeChatApi.enableSpeechSynthesis()

To change the language of interaction -

            DheeChatApi.changeLanguage(NEW_LANGUAGE)

Possible values of NEW_LANGUAGE are string values of the subset of supported languages chosen by you in your project.

After the chat, the bot disconnects the call. Of course at any point of conversation, the user can disconnect the call. To facilitate this, use this function -

            DheeChatApi.endChat()

Issue reports, fix/extention PRs are welcome!

dhee-chatbot-api-js's People

Contributors

sreekj avatar technologistkj avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.