npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ringcentral-engage-chatbot

v1.2.0

Published

RingCentral Engage bot framework for js

Downloads

5

Readme

Engage Digital Chatbot Framework for JavaScript

Build Status Coverage Status

RingCentral Engage (Dimelo) bot framework for JavaScript

Prerequisites

  • Nodejs 8.10+/npm, recommend using nvm to install nodejs/npm.
  • RingCentral Engage(Dimelo) account, request a demo.

Quick start

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 [email protected]: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

Test bot

  • 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.js to set your own reply logic.

Test bot skill

  • Run npm run dev1 to run bot with skills
  • Check example-bots/auto-reply-all-with-skills.js and example-skills/ping-pong-skill.js

Youtube video

https://youtu.be/HDDGUFIzNxQ

Use it as CLI tool

npx ringcentral-engage-chatbot path-to-your-bot.js

Use is as a module

Check docs/direct-use.md

Real example

Structured Message in Engage Messaging

First, follow the guide to create a Engage Messaging channel

# just run
npm run dev2

Then you can try it in Engage Messaging:

Check bot code for details.

Write a bot

docs/write-a-bot.md

Write a bot skill

docs/write-use-a-skill.md

Build and Deploy to AWS Lambda

deploy-to-lambda.md

Init a bot/bot skill project with factory CLI tool

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:

License

MIT