{"id":21406670,"url":"https://github.com/ringcentral/engage-digital-chatbot-js","last_synced_at":"2025-07-18T01:13:27.050Z","repository":{"id":143906498,"uuid":"187749557","full_name":"ringcentral/engage-digital-chatbot-js","owner":"ringcentral","description":"RingCentral Engage Chatbot framework js","archived":false,"fork":false,"pushed_at":"2023-11-12T01:50:28.000Z","size":496,"stargazers_count":7,"open_issues_count":4,"forks_count":2,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-07-14T00:46:22.619Z","etag":null,"topics":["bot","engage","js","ringcentral"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ringcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-21T02:46:04.000Z","updated_at":"2025-07-08T23:31:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"322c9310-ca14-4ef5-8d14-5c61267aeff6","html_url":"https://github.com/ringcentral/engage-digital-chatbot-js","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/engage-digital-chatbot-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-chatbot-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-chatbot-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-chatbot-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-chatbot-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/engage-digital-chatbot-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-chatbot-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265687096,"owners_count":23811218,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","engage","js","ringcentral"],"created_at":"2024-11-22T16:41:35.191Z","updated_at":"2025-07-18T01:13:27.004Z","avatar_url":"https://github.com/ringcentral.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Engage Digital Chatbot Framework for JavaScript\n\n[![Build Status](https://travis-ci.com/ringcentral/engage-digital-chatbot-js.svg?branch=release)](https://travis-ci.com/ringcentral/engage-digital-chatbot-js)\n[![Coverage Status](https://coveralls.io/repos/github/ringcentral/engage-digital-chatbot-js/badge.svg?branch=release)](https://coveralls.io/github/ringcentral/engage-digital-chatbot-js?branch=release)\n\n[RingCentral Engage (Dimelo)](https://www.ringcentral.com/view_demo_cx.html) bot framework for JavaScript\n\n* [API docs](https://developers.ringcentral.com/engage/digital/guide)\n\n## Prerequisites\n\n- Nodejs 8.10+/npm, recommend using [nvm](https://github.com/creationix/nvm) to install nodejs/npm.\n- RingCentral Engage(Dimelo) account, [request a demo](https://www.ringcentral.com/view_demo_cx.html).\n\n## Quick start\n\nLet's start a simple RingCentral Engage chatbot server that will auto respond to any email with a auto reply.\n\n```bash\n# get the code\ngit clone git@github.com:ringcentral/engage-digital-chatbot-js.git\ncd engage-digital-chatbot-js\n\n# install dependecies\nnpm i\n\n# start proxy server, this will make your local bot server can be accessed by RingCentral service\nnpm run ngrok\n\n# will show\nForwarding                    https://xxxx.ap.ngrok.io -\u003e localhost:6066\n# Remember the https://xxxx.ap.ngrok.io, we will use it later\n```\n\nFollow [Step by Step guide to enable sources](docs/guides-to-add-sources.md) to prepare the source and webhook. You could choose only one source.\n\n```bash\n# create env file\ncp .env.sample .env\n# then edit .env, set proper setting according to the tip in .env\n\n# run local dev server\nnpm start\n```\n\n### Test bot\n\n- Send a email to your predefined email source address, then bot will auto reply with `This is a auto reply by bot`.\n- Edit `example-bots/auto-reply-all.js` to set your own reply logic.\n\n### Test bot skill\n\n- Run `npm run dev1` to run bot with skills\n- Check `example-bots/auto-reply-all-with-skills.js` and `example-skills/ping-pong-skill.js`\n\n## Youtube video\n\n[https://youtu.be/HDDGUFIzNxQ](https://youtu.be/HDDGUFIzNxQ)\n\n## Use it as CLI tool\n\n```bash\nnpx ringcentral-engage-chatbot path-to-your-bot.js\n```\n\n## Use is as a module\n\nCheck [docs/direct-use.md](docs/direct-use.md)\n\n## Real example\n\n- [https://github.com/zxdong262/ping-pong-engage-digital-chatbot](https://github.com/zxdong262/ping-pong-engage-digital-chatbot): Example engage digital chat bot that will respond with \"pong\" for \"ping\" message.\n\n## Structured Message in Engage Messaging\n\nFirst, follow [the guide](docs/enable-dimelo-chat.md) to create a Engage Messaging channel\n\n```sh\n# just run\nnpm run dev2\n```\n\nThen you can try it in Engage Messaging:\n\n![ ](screenshots/tm.png)\n\nCheck [bot code](example-bots/auto-reply-all-with-structure-msg.js) for details.\n\nAlso we have standalone demo from Embbnux: [https://github.com/ringcentral-tutorials/engage-digital-structured-messages-demo](https://github.com/ringcentral-tutorials/engage-digital-structured-messages-demo)\n\n## Write a bot\n\n[docs/write-a-bot.md](docs/write-a-bot.md)\n\n## Write a bot skill\n\n[docs/write-use-a-skill.md](docs/write-use-a-skill.md)\n\n## Build and Deploy to AWS Lambda\n\n[deploy-to-lambda.md](docs/deploy-to-lambda.md)\n\n## Init a bot/bot skill project with factory CLI tool\n\nWe have built-in CLI command to init a empty project from template: [https://github.com/ringcentral/engage-digital-bot-template-js](https://github.com/ringcentral/engage-digital-bot-template-js).\n\n```bash\nnpm i -g ringcentral-engage-chatbot\nringcentral-engage-chatbot-create my-app\n```\n\nWill show:\n\n![ ](screenshots/s1.png)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-digital-chatbot-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fengage-digital-chatbot-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-digital-chatbot-js/lists"}