{"id":21406651,"url":"https://github.com/ringcentral/engage-voice-embeddable","last_synced_at":"2025-07-29T23:34:03.118Z","repository":{"id":36585677,"uuid":"228795635","full_name":"ringcentral/engage-voice-embeddable","owner":"ringcentral","description":"(Beta)RingCentral RingCX Embeddable widget","archived":false,"fork":false,"pushed_at":"2025-06-24T05:03:03.000Z","size":22657,"stargazers_count":6,"open_issues_count":11,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-14T00:46:21.642Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ringcentral.github.io/engage-voice-embeddable/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"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,"zenodo":null}},"created_at":"2019-12-18T08:40:44.000Z","updated_at":"2025-04-15T06:13:52.000Z","dependencies_parsed_at":"2025-04-15T05:19:45.511Z","dependency_job_id":"18f24bf1-9179-4d19-9dbd-b1af964eb097","html_url":"https://github.com/ringcentral/engage-voice-embeddable","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/engage-voice-embeddable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-embeddable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-embeddable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-embeddable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-embeddable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/engage-voice-embeddable/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-embeddable/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267780200,"owners_count":24143202,"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-07-29T02:00:12.549Z","response_time":2574,"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":[],"created_at":"2024-11-22T16:41:22.062Z","updated_at":"2025-07-29T23:34:03.079Z","avatar_url":"https://github.com/ringcentral.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RingCX Embeddable (Beta)\n\n[![Build Status](https://github.com/ringcentral/engage-voice-embeddable/actions/workflows/deploy.yml/badge.svg?branch=master)](https://github.com/ringcentral/engage-voice-embeddable/actions)\n\n## Introduction\n\nThis is an out-of-the-box embeddable web application that help developers to integrate [RingCentral RingCX](https://www.ringcentral.com/ringcx.html) services to their web applications with few code.\n\n## Visit Online\n\nVisit [website](https://ringcentral.github.io/engage-voice-embeddable/) in GitHub pages.\n\n![demo](https://user-images.githubusercontent.com/7036536/133401087-2e60c93c-c9dc-48d1-9f24-f8419c5618ca.png)\n\n## Inject\n\n```html\n\u003cscript\u003e\n  (function() {\n    var rcs = document.createElement(\"script\");\n    rcs.src = \"https://ringcentral.github.io/engage-voice-embeddable/adapter.js\";\n    var rcs0 = document.getElementsByTagName(\"script\")[0];\n    rcs0.parentNode.insertBefore(rcs, rcs0);\n  })();\n\u003c/script\u003e\n```\n\n## Documents\n\n* [Get Started](docs/get-started.md)\n* [Customize Client ID and environment](docs/customize-client-id.md)\n* [Customize Redirect Uri](docs/customize-redirect-uri.md)\n* [Customize Authorization](docs/customize-authorization.md)\n* [API](docs/api.md)\n* [Message Transport](docs/message-transport.md)\n* [Call Events](docs/call-events.md)\n* [Popup a standalone widget](docs/popup-window.md)\n\n## Awesome Embeddable projects\n\n* RingCentral RingCX Embeddable phone for Hubspot CRM - [repo](https://github.com/ringcentral/hubspot-embeddable-engage-phone)\n\n## Contribution and Development\n\n### Clone the code\n\n```\n$ git clone https://github.com/ringcentral/engage-voice-embeddable.git\n```\n\n### Create a free RingCentral app\n\n1. Create a [RingCentral developer free account](https://developer.ringcentral.com)\n2. Create a RingCentral app with platform type - \"Browser Based\"\n3. Add permissions `Read Accounts` to your app.\n4. Add redirect uri `http://localhost:8080/redirect.html` to your app settings.\n\n### Create environment variables file in project root path\n\nCreate `.env` file in project root path:\n\n```\nRINGCENTRAL_CLIENT_ID=your_ringcentral_app_client_id\nRINGCENTRAL_SERVER=https://platform.ringcentral.com\n\nENGAGE_VOICE_AUTH_SERVER=https://engage.ringcentral.com\n```\n**Notice**: Now the RingCX service only is supported on production environment. Please make sure your key is graduated into RingCentral production environment.\n\n### Start development server\n\nWe assume you have pre-installed node.js \u003e= 10 and yarn. \n\n**It is recommended to use `yarn` instead of `npm`.** We have `yarn.lock` file in source code to lock dependence version. With `yarn`, we can install dependencies with correct version that work well with this project.\n\n```bash\n$ yarn       # use yarn to install dependencies\n$ yarn start # start a webpack dev server\n```\n\nOpen site: 'http://localhost:8080/' on browser\n\n### Deploy on production\n\nIf you create pull request to this repository and get merged, CI will deploy it to this repository's github page automatically. But for something that customized, you can deploy it to your own web space, such as your github page.\n\n1. Update `.env` file in production environment\n2. Run command to compile code and build release\n\n```\n$ yarn build --hosting-url your_host_url\n```\n\nPlease replace `your_host_uri` with your own web host address, such as `https://ringcentral.github.io/engage-voice-embeddable`.\n\n3. Upload all files in `build/rc` folder to your web space. And visit it in browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-voice-embeddable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fengage-voice-embeddable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-voice-embeddable/lists"}