{"id":21406673,"url":"https://github.com/ringcentral/engage-voice-js","last_synced_at":"2025-10-26T04:11:13.170Z","repository":{"id":40766646,"uuid":"267239968","full_name":"ringcentral/engage-voice-js","owner":"ringcentral","description":"RingCentral Engage Voice API js wrapper","archived":false,"fork":false,"pushed_at":"2023-07-06T03:20:26.000Z","size":1142,"stargazers_count":4,"open_issues_count":20,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T15:25:42.749Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://engage-voice-api-docs.readthedocs.io/en/latest/","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":"2020-05-27T06:34:01.000Z","updated_at":"2025-07-15T19:11:34.000Z","dependencies_parsed_at":"2024-11-22T16:51:47.322Z","dependency_job_id":null,"html_url":"https://github.com/ringcentral/engage-voice-js","commit_stats":{"total_commits":37,"total_committers":2,"mean_commits":18.5,"dds":"0.10810810810810811","last_synced_commit":"f35c6bbcdd3be1a982848eeb455cd8bf7bd77ded"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/engage-voice-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/engage-voice-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-voice-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271469227,"owners_count":24765124,"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-08-21T02:00:08.990Z","response_time":74,"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:35.595Z","updated_at":"2025-10-26T04:11:13.083Z","avatar_url":"https://github.com/ringcentral.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RingCentral Engage Voice JavaScript SDK\r\n\r\n[![Build Status](https://travis-ci.com/ringcentral/engage-voice-js.svg?branch=release)](https://travis-ci.com/github/ringcentral/engage-voice-js)\r\n[![Coverage Status](https://coveralls.io/repos/github/ringcentral/engage-voice-js/badge.svg?branch=release)](https://coveralls.io/github/ringcentral/engage-voice-js?branch=release)\r\n\r\nRingCentral Engage Voice Client SDK for JavaScript.\r\n\r\n## Features\r\n\r\n- Auto refresh access token\r\n\r\n## Use\r\n\r\n```bash\r\nnpm i ringcentral-engage-voice-client\r\n```\r\n\r\n```js\r\nconst RingCentralEngageVoice = require('ringcentral-engage-voice-client').default\r\n// or\r\n// import RingCentralEngageVoice from 'ringcentral-engage-voice-client'\r\n\r\n// create from ringcentral app client id /secret\r\n// you can create app from https://developer.ringcentral.com\r\nconst ev = new RingCentralEngageVoice({\r\n  clientId: process.env.RINGCENTRAL_CLIENTID,\r\n  clientSecret: process.env.RINGCENTRAL_CLIENTSECRET\r\n})\r\n\r\n// auth with jwt\r\nawait ev.authorize({\r\n  jwt: process.env.RINGCENTRAL_JWT\r\n})\r\n\r\n// get access token\r\nconst token = ev.token().accessToken\r\n\r\n// can also auth with password flow\r\n// await ev.authorize({\r\n//   username: process.env.RINGCENTRAL_USERNAME,\r\n//   extension: process.env.RINGCENTRAL_EXTENSION,\r\n//   password: process.env.RINGCENTRAL_PASSWORD\r\n// })\r\n\r\n// can also auth with auth code flow\r\n// check https://developers.ringcentral.com/guide/authentication for more detail\r\n// await ev.authorize({\r\n//   code: 'xxxx',\r\n//   redirectUri: 'yyyyyy'\r\n// })\r\n\r\n// api request\r\n// check all api doc from https://engage-voice-api-docs.readthedocs.io/en/latest/\r\nlet r = await ev.get('/api/v1/admin/accounts')\r\nr = r.data\r\nexpect(r.length \u003e 0).toBe(true)\r\n```\r\n\r\nFor legacy server use:\r\n\r\n```js\r\nconst RingCentralEngageVoice = require('ringcentral-engage-voice-client').default\r\n// or\r\n// import RingCentralEngageVoice from 'ringcentral-engage-voice-client'\r\n\r\n// LEGACY_SERVER could be\r\n// 'https://portal.vacd.biz',\r\n// or  'https://portal.virtualacd.biz'\r\nconst ev = new RingCentralEngageVoice({\r\n  server: process.env.LEGACY_SERVER\r\n})\r\n\r\n// only support username/password auth\r\nawait ev.authorize({\r\n  username: process.env.LEGACY_USERNAME,\r\n  password: process.env.LEGACY_PASSWORD\r\n})\r\n\r\n// api request\r\n// check all api doc from https://engage-voice-api-docs.readthedocs.io/en/latest/\r\nlet r = await ev.get('/api/v1/admin/accounts')\r\nr = r.data\r\nexpect(r.length \u003e 0).toBe(true)\r\n\r\n// revoke api token\r\nev.revokeLegacyToken()\r\n```\r\n\r\n## Instance methods\r\n\r\nev.request(config)\r\n\r\nev.get(url, config = {})\r\n\r\nev.post(url, data = undefined, config = {})\r\n\r\nev.put(url, data = undefined, config = {})\r\n\r\nev.delete (url, config = {})\r\n\r\nev.patch(url, data = undefined, config = {})\r\n\r\n## Test\r\n\r\n```bash\r\nnpm i\r\ncp env-sample.env .env\r\n# then edit .env fill all fields\r\nnpm run test\r\n```\r\n\r\n## Run demo code\r\n\r\n```bash\r\ncd demo\r\nnpm i\r\ncp env-sample.env .env\r\n# then edit .env fill all fields\r\nnpm start\r\n# edit index.js to play\r\n```\r\n\r\n## Credits\r\n\r\nBased on tyler's [ringcentral-js-concise](https://github.com/tylerlong/ringcentral-js-concise)\r\n\r\n## License\r\n\r\nMIT\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-voice-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fengage-voice-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-voice-js/lists"}