{"id":21406754,"url":"https://github.com/ringcentral/ringcentral-chatbot-js","last_synced_at":"2025-10-11T12:34:27.021Z","repository":{"id":33855538,"uuid":"156838895","full_name":"ringcentral/ringcentral-chatbot-js","owner":"ringcentral","description":"RingCentral Chatbot Framework for JavaScript","archived":false,"fork":false,"pushed_at":"2023-03-13T21:47:12.000Z","size":2213,"stargazers_count":13,"open_issues_count":16,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-14T00:46:56.865Z","etag":null,"topics":["bot","javascript","ringcentral","ringcentral-chatbot-framework"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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":"2018-11-09T09:22:38.000Z","updated_at":"2025-03-30T00:43:18.000Z","dependencies_parsed_at":"2024-11-22T16:42:47.052Z","dependency_job_id":"5c10a979-eb93-4ffe-9987-d9a569ca4448","html_url":"https://github.com/ringcentral/ringcentral-chatbot-js","commit_stats":null,"previous_names":["tylerlong/ringcentral-chatbot-js"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/ringcentral-chatbot-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/ringcentral-chatbot-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-chatbot-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007166,"owners_count":26084247,"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-11T02:00:06.511Z","response_time":55,"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","javascript","ringcentral","ringcentral-chatbot-framework"],"created_at":"2024-11-22T16:42:34.025Z","updated_at":"2025-10-11T12:34:26.974Z","avatar_url":"https://github.com/ringcentral.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RingCentral chatbot framework for JavaScript\n\n## Philosophy\n\n- Let developers focus on business logic instead of RingCentral/Glip Platform implementation details\n\n\n## Supported features\n\n- Bot token management\n- Bot WebHook management\n- Remove \u0026 re-add bot\n- Deploy to AWS Lambda\n- Update bot name and avatar\n- Bot join \u0026 leave group\n\n\n## Quick Start tutorials\n\n- If you want to create a Glip chatbot and deploy it to your own server\n    - [read this tutorial](https://github.com/tylerlong/glip-ping-chatbot/tree/express)\n- If you want to create a Glip chatbot and deploy it to AWS Lambda\n    - [read this tutorial](https://github.com/tylerlong/glip-ping-chatbot/tree/lambda)\n\nWe recommend you to finish reading/watching at least one of the tutorials above before reading on.\n\n\n## Create a RingCentral app\n\nClick the link below to create a RingCentral app quickly:\n\n[Create Bot App](https://developer.ringcentral.com/new-app?name=Sample+Bot+App\u0026desc=A+sample+app+created+for+the+javascript+chatbot+framework\u0026public=true\u0026type=ServerBot\u0026permissions=ReadAccounts,EditExtensions,SubscriptionWebhook,Glip\u0026redirectUri=https://\u003cchatbot-server\u003e/bot/oauth)\n\nDo remember to change redirect uri from `https://\u003cchatbot-server\u003e/bot/oauth` to the real uri.\nIf you don't have a public uri, leave that field blank.\n\n\n## Setup database\n\nThe first time you setup the bot, the database is empty, you need to create tables.\n\nThere is an easy way:\n\n```\ncurl -X PUT -u admin:password https://\u003cbot-server\u003e/admin/setup-database\n```\n\n## Migrate database\n\nIf you update the SDK from an early version, it might not work because the database schema has changed.\n\nIn such case, you can migrate the database:\n\n```\ncurl -X PUT -u admin:password https://\u003cbot-server\u003e/admin/migrate-database\n```\nThis command will smartly check your database and add new fields/tables if necessary.\n\n\n## Maintain\n\n\"Maintain\" is useful in the following cases:\n\n- If for reason bot server changed, you need to re-setup WebHooks\n- You bot server was down for quite a while and your WebHooks have been blacklisted\n- There is orphan data in database\n\nYou can \"maintain\" to resolve the issues above:\n\n```\ncurl -X PUT -u admin:password https://\u003cbot-server\u003e/admin/maintain\n```\n\nIt is recommended that you create a cron job to run this command daily.\n\n\n## Diagnostic\n\nSometimes there are issues and you don't know what happened. This framework provides interfaces for diagnostic:\n\n```\ncurl -X GET -u admin:password https://\u003cbot-server\u003e/admin/dump-database\ncurl -X GET -u admin:password https://\u003cbot-server\u003e/admin/list-subscriptions\n```\n\nTo enable verbose logging, please define environment variable `RC_VERBOSE_LOGGING` with string value \"true\".\n\n\n## Update token\n\n```\ncurl -X PUT -u admin:password https://\u003cbot-server\u003e/admin/update-token?id=\u003cbot-extension-id\u003e\u0026token=access-token'\n```\n\n\n## Hidden commands\n\nThe following commands are considered \"hidden\" or \"easter eggs\":\n\n- `__rename__ \u003cnewName\u003e`: rename bot to `newName`\n- `__updateToken__ \u003caccess_token\u003e`: update bot access token to `access_token`\n- A message with text `__setAvatar__` and an attached image file: set bot avatar to the attached image\n\n\n## Advanced topics\n\n- [Skills](./skills.md)\n- [Integrate with third party services](./third-party-services.md)\n\n\n## About graduation\n\nIn order to graduate a RingCentral app, you need to invoke each API endpoint used in your app at least 5 times. \n\nIn order to to meet this requirement quickly, you can invoke API endpoints explicitly in code, for example:\n\n```\nawait bot.rc.get('/restapi/v1.0/account/~/extension/~')\n```\n\n\n## Advanced Demo bots\n\n- [Glip Crontab Chatbot](https://github.com/tylerlong/glip-crontab-chatbot)\n    - Allow Glip users to create cron jobs to send notifications\n    - [Try it](https://www.ringcentral.com/apps/glip-crontab-chatbot)\n    - By reading its source code, you will get how to handle messages from users and how to reply.\n- [Glip RC Assistant Chatbot](https://github.com/tylerlong/rc-assistant)\n    - Allow Glip users to query/edit their RingCentral data via Glip.\n    - [Try it](https://www.ringcentral.com/apps/glip-rc-assistant-chatbot)\n    - It is a demo for integrating Glip chatbot with RingCentral platform.\n- [Glip Google Drive Chatbot](https://github.com/tylerlong/glip-google-drive-chatbot)\n    - Allow Glip users to monitor their Google Drive events.\n    - [Try it](https://www.ringcentral.com/apps/glip-google-drive-chatbot)\n    - It is a demo for integrating Glip chatbot with a third party service (Google Drive)\n    - It is also a demo for chatbot skills\n\n\n## Notes\n\n- AWS Lambda connects AWS RDS issue\n    - If you create an RDS manually and let it create a new security group for you.\n        - By default, the security group only allows inbound traffic from your current laptop's public IP address\n        - AWS Lambda by default cannot access the newly created AWS RDS\n        - We need to update security group to allow inbound traffic from `0.0.0.0/0`\n- AWS Lambda and `await` issue\n    - AWS Lambda is stateless and it won't keep a background runner\n    - So if your code is async, DO remember to `await`. Otherwise that code will not be executed before Lambda invocation terminates\n    - I forgot to `await`, a weird phenomenon was: whenever I issued a command, I always got reply of previous command\n- AWS Lambda global code dead-lock issue\n    - Do NOT invoke lambda functions in global code outside of handlers\n    - I tried once and it seemed to case dead-lock. Lots of requests which causes 429 error and database connection exhausted\n        - In global code I did `axio.put('https://\u003cbot-server\u003e/admin/maintain')` and it caused dead-lock\n\n\n## Todo\n\n- send api to change presence, let bot user to be online\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-chatbot-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fringcentral-chatbot-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-chatbot-js/lists"}