ringcentral-welcome-bot-py

Glip bot to welcome new team member

Prerequisites$

• Python3.6+ and Pip3
• Create the bot App: Login to developer.ringcentral.com and create an public Server/Bot app with permissions: ReadAccounts, Edit Extensions, WebhookSubscriptions, Glip(or more as you may need), ---> Click to Create app

Development & Quick start

# init
cp bot-logic.py config.py
bin/init
source ./venv/bin/activate

# run ngrok proxy
# since bot need https server,
# so we need a https proxy for ringcentral to visit our local server
./bin/proxy
# will show:
# Forwarding https://xxxxx.ngrok.io -> localhost:3000

# create env file
# .env already created from .sample.env
# just edit .env, set proper setting,
RINGCENTRAL_BOT_SERVER=https://xxxxx.ngrok.io

## for bots auth required, get them from your ringcentral app page
RINGCENTRAL_BOT_CLIENT_ID=
RINGCENTRAL_BOT_CLIENT_SECRET=

# and goto your ringcentral app setting page, set OAuth Redirect URI to https://https://xxxxx.ngrok.io/bot-oauth

# run local dev server
./bin/start

Test bot

• Goto your ringcentral app's bot section, click 'Add to glip'
• Login to https://glip-app.devtest.ringcentral.com, find the bot by searching its name. Talk to the bot.
• Edit config.py to change bot bahavior and test in https://glip-app.devtest.ringcentral.com

Create your own bot logic

• You can edit/add method in config.py you need to use, write your own bot logic, restart the app, check it in https://glip-app.devtest.ringcentral.com.
• You can read all configs available from all-config.py

And we have examples bots you can check out as examples:

• date-time-chatbot : Simple ringcentral chatbot which can tell time/date.
• assistant-bot : Simple assistant Glip bot to show user/company information, this bot will show you how to access user data.
• survey-bot : Example survey bot, this bot will show you how to create/use custom database wrapper.

Advanced topics

• Deploy to AWS Lambda
• Use or write extensions

License

MIT