{"id":21406667,"url":"https://github.com/ringcentral/ringcentral-chatbot-python","last_synced_at":"2025-10-08T20:28:54.040Z","repository":{"id":57461986,"uuid":"157343228","full_name":"ringcentral/ringcentral-chatbot-python","owner":"ringcentral","description":"RingCentral Chatbot Framework for Python","archived":false,"fork":false,"pushed_at":"2021-10-28T08:43:51.000Z","size":139,"stargazers_count":12,"open_issues_count":7,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-14T00:46:30.602Z","etag":null,"topics":["bot","framework","ringcentral"],"latest_commit_sha":null,"homepage":null,"language":"Python","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}},"created_at":"2018-11-13T08:07:11.000Z","updated_at":"2025-01-16T19:15:53.000Z","dependencies_parsed_at":"2022-08-28T02:00:26.717Z","dependency_job_id":null,"html_url":"https://github.com/ringcentral/ringcentral-chatbot-python","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/ringcentral-chatbot-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/ringcentral-chatbot-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-python/sbom","scorecard":{"id":776755,"data":{"date":"2025-08-11","repo":{"name":"github.com/ringcentral/ringcentral-chatbot-python","commit":"4ca6feb4f686705a75501239c13a1869e617d2a3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: pipCommand not pinned by hash: bin/init:4","Warn: pipCommand not pinned by hash: bin/init:7","Info:   0 out of   2 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2023-179 / GHSA-8mjr-6c96-39w8"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T03:49:49.424Z","repository_id":57461986,"created_at":"2025-08-23T03:49:49.424Z","updated_at":"2025-08-23T03:49:49.424Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000653,"owners_count":26082817,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","framework","ringcentral"],"created_at":"2024-11-22T16:41:33.812Z","updated_at":"2025-10-08T20:28:54.009Z","avatar_url":"https://github.com/ringcentral.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [RingCentral chatbot framework for Python](https://github.com/ringcentral/ringcentral-chatbot-python) \u003c!-- omit in toc --\u003e\n\n[![Build Status](https://travis-ci.org/ringcentral/ringcentral-chatbot-python.svg?branch=test)](https://travis-ci.org/ringcentral/ringcentral-chatbot-python)\n\nWelcome to the RingCentral Chatbot Framework for Python. This framework dramatically simplifies the process of building a bot to work with Glip, RingCentral's group chat system. It is intended to do most of the heavy lifting for developers, allowing them to focus primarily on the logic and user experience of their bot.\n\n## Features\n\n- **Token Management** - handles the server logic associated with bot authentication, and auth token persistence\n- **Event Subscribtion** - automatically subscribes to bot events, and renews those subscriptions when they expire\n- **Easy Customization** - modify bot behaviors by editing `bot.py`\n- **Data Persistence** - built-in suport for filedb and AWS dynamodb, with fully customizable DB layer\n- **Turn-key hosting** - built-in suport for AWS lambda to host your bot\n\n## Getting Started\n\nLet's get a local chatbot server up and running so that you can understand how the framework functions. Our first chatbot will be a simple parrot bot that will repeat things back to you. Before we get started, let's get your development environment setup with everything you need.\n\n### Install Prerequisites\n\nThis framework requires Python3.6+ and Pip3.\n\nFirst we install [virtualenv](https://virtualenv.pypa.io/en/latest/) which will create an isolated environment in which to install and run all the python libraries needed by this framework. Using virtualenv will ensure that the libraries installed for this project do not conflict or disrupt the other python projects you are working on.\n\n```bash\n# init project\nbin/init\nsource venv/bin/activate\n```\n\nNext, we need to run [ngrok](https://ngrok.com/), a tool for routing web requests to a localhost. This is what will allow your local bot in development to receive webhooks from RingCentral. ngrok is a node app and is installed and start as follows:\n\n```bash\n./bin/proxy\n```\n\nAfter ngrok has started, it will display the URL when the ngrok proxy is operating. It will say something like:\n\n```Forwarding https://xxxxx.ngrok.io -\u003e localhost:9898```\n\nMake note of this URL, as you will need it in the next step.\n\n### Create Your Bot App\n\nYou will need to create your Bot App in RingCentral. Clicking the link, \"Create Bot App\" below will do this for you. Remember to select `messagging bot` bot and for `All RingCentral customers`, When you click it, you will to enter in the `OAuth Redirect URI ` for the bot. This will be the ngrok URL above, plus `/bot-oauth`. For example:\n\n    https://xxxxxx.ngrok.io/bot-oauth\n\n[Create Bot App](https://developer.ringcentral.com/new-app?name=Sample+Bot+App\u0026desc=A+sample+app+created+in+conjunction+with+the+python+bot+framework\u0026public=true\u0026type=ServerBot\u0026carriers=7710,7310,3420\u0026permissions=ReadAccounts,EditExtensions,SubscriptionWebhook,Glip\u0026redirectUri=)\n\nWhen you are finished creating your Bot Application, make note of the Client ID and Client Secret. We will use those values in the next step.\n\n### Edit .env\n\nA sample .env file can be found in `.env.sample`. Create a copy of this file:\n\n```bash\ncp .sample.env .env\n```\n\nThen look for the following variables, and set them accordingly:\n\n- `RINGCENTRAL_BOT_SERVER`\n- `RINGCENTRAL_BOT_CLIENT_ID`\n- `RINGCENTRAL_BOT_CLIENT_SECRET`\n\n### Install Bot Behaviors\n\nThis bot framework loads all bot behaviors from a file called `config.py`. Let's copy the parrot bot config to get started.\n\n```bash\ncp sample-bots/parrot.py ./bot.py\n```\n\n### Start the Server\n\n```bash\n# rcs is cli server module from ringcentral_chatbot_server\nrcs bot.py\n```\n\n### Add Bot to Glip\n\nWhen the server is up and running, you can add the bot to your sandbox Glip account. Navigate the dashboard for the app you created above. Select \"Bot\" from the left-hand sidebar menu. Save a preferred name for your bot, then click the \"Add to Glip\" button.\n\n### Send a Test Message\n\nAfter the bot is added, we can message with it. Login to our [sandbox Glip](https://glip.devtest.ringcentral.com). Then start a chat with the bot using the name you chose in the previous step.\n\nYou should now be in private chat session with the bot. It should greet you with a message similar to:\n\n\u003e Hello, I am a chatbot. Please reply \"ParrotBot\" if you want to talk to me.\n\nType `@ParrotBot Polly want a cracker?` and let's see what happens.\n\n## Quick start: Init a bot project with one line script\n\nNow you know how it works, you may try to init a bot project in one line script:\n\n```bash\n# make sure you have python3.6+ and pip3 installed\n\n# use wget\nwget -qO- https://raw.githubusercontent.com/ringcentral/ringcentral-chatbot-factory-py/master/bin/init.sh | bash\n\n# or with curl\ncurl -o- https://raw.githubusercontent.com/ringcentral/ringcentral-chatbot-factory-py/master/bin/init.sh | bash\n```\n\nA video to show the process: [https://youtu.be/x5sTrj5xSN8](https://youtu.be/x5sTrj5xSN8)\n\n## Example bot apps\n\nThe following bots were created using this framework, and should serves as guides as you develop your own original bot.\n\n- [date-time-chatbot](https://github.com/zxdong262/ringcentral-date-time-chatbot): simple Glip chatbot that can tell time/date.\n- [assistant-bot](https://github.com/zxdong262/ringcentral-assistant-bot): simple assistant Glip bot to show user/company information, this bot will show you how to access user data.\n- [poll-bot](https://github.com/zxdong262/ringcentral-poll-bot): Glip poll bot, this bot will show you how to create/use custom database wrapper.\n- [translate-bot](https://github.com/zxdong262/ringcentral-translate-bot): translate bot for glip.\n- [welcome-bot](https://github.com/zxdong262/ringcentral-welcome-bot-py): Glip chatbot to welcome new team member.\n- [at-all-bot](https://github.com/zxdong262/ringcentral-at-all-bot): Add AT all function to glip with this bot.\n\n## Advanced Topics\n\n### Adaptive cards support\n\nCheck [sample-bots/parrot-adaptive-card.py](sample-bots/parrot-adaptive-card.py) as an example,\n- Use `bot.sendAdaptiveCard` to send AdaptiveCard\n- Use `bot.updateAdaptiveCard` to update AdaptiveCard\n\n### Interactive message\n\nSince we support `adaptive cards`, we also support interactive messages when using adaptive cards actions, so bot can get interactive messages directly from user actions, you need goto app setting page in `developer.ringcentral.com`, enable `Interactive Messages`, and set `https://xxxxx.ngrok.io/interactive` as `Outbound Webhook URL`\n\nCheck [sample-bots/interactive.py](sample-bots/interactive.py) as an example, define your own `onInteractiveMessage` function to handle interative messages.\n\n### Hidden commands\n\n- Post message `@Bot __rename__ newName` to rename bot to `newName`\n- Post message `@Bot __setAvatar__` and image attachment to set bot profile image.\n\n### Use CLI tool to create a bot app\n\nThe [ringcentral-chatbot-factory-py](https://github.com/ringcentral/ringcentral-chatbot-factory-py) was created to help speed up the process of creating additional Glip bots. To use it, install it, then run the `rcf` command as shown below:\n\n```bash\npip3 install ringcentral_chatbot_factory\nrcf my-ringcentral-chat-bot\n```\n\nThen just answer the prompts. Then follow the directions in `my-ringcentral-chat-bot/README.md` to get up and running.\n\n![ ](https://github.com/ringcentral/ringcentral-chatbot-factory-py/raw/master/screenshots/cli.png)\n\n- [Deploy to AWS Lambda](docs/deploy-to-aws-lambda.md)\n- [Use or write extensions](docs/extensions.md)\n- [Direct Use](docs/use.md)\n\n## Unit Test\n\n```bash\nbin/test\n```\n\n## Todos\n\nVisit [https://github.com/zxdong262/ringcentral-chatbot-python/issues](https://github.com/zxdong262/ringcentral-chatbot-python/issues)\n\n## Credits\n\nThe core bot framework logic is implanted from [ringcentral-ai-bot](https://github.com/ringcentral-tutorials/ringcentral-ai-bot) written by [@tylerlong](https://github.com/tylerlong)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-chatbot-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fringcentral-chatbot-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-chatbot-python/lists"}