RingCentral Engage (Dimelo) bot framework for JavaScript
- Nodejs 8.10+/npm, recommend using nvm to install nodejs/npm.
- RingCentral Engage(Dimelo) account, request a demo.
Let's start a simple RingCentral Engage chatbot server that will auto respond to any email with a auto reply.
# get the code git clone git@github.com:ringcentral/engage-digital-chatbot-js.git cd engage-digital-chatbot-js # install dependecies npm i # start proxy server, this will make your local bot server can be accessed by RingCentral service npm run ngrok # will show Forwarding https://xxxx.ap.ngrok.io -> localhost:6066 # Remember the https://xxxx.ap.ngrok.io, we will use it later
Follow Step by Step guide to enable sources to prepare the source and webhook. You could choose only one source.
# create env file cp .env.sample .env # then edit .env, set proper setting according to the tip in .env # run local dev server npm start
- Send a email to your predefined email source address, then bot will auto reply with
This is a auto reply by bot. - Edit
example-bots/auto-reply-all.jsto set your own reply logic.
- Run
npm run dev1to run bot with skills - Check
example-bots/auto-reply-all-with-skills.jsandexample-skills/ping-pong-skill.js
npx ringcentral-engage-chatbot path-to-your-bot.js
Check docs/direct-use.md
- https://github.com/zxdong262/ping-pong-engage-digital-chatbot: Example engage digital chat bot that will respond with "pong" for "ping" message.
First, follow the guide to create a Engage Messaging channel
# just run
npm run dev2Then you can try it in Engage Messaging:
Check bot code for details.
Also we have standalone demo from Embbnux: https://github.com/ringcentral-tutorials/engage-digital-structured-messages-demo
We have built-in CLI command to init a empty project from template: https://github.com/ringcentral/engage-digital-bot-template-js.
npm i -g ringcentral-engage-chatbot ringcentral-engage-chatbot-create my-app
Will show:
MIT