https://github.com/ringcentral/engage-voice-js
RingCentral Engage Voice API js wrapper
https://github.com/ringcentral/engage-voice-js
Last synced: 8 months ago
JSON representation
RingCentral Engage Voice API js wrapper
- Host: GitHub
- URL: https://github.com/ringcentral/engage-voice-js
- Owner: ringcentral
- License: mit
- Created: 2020-05-27T06:34:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T03:20:26.000Z (almost 3 years ago)
- Last Synced: 2025-08-09T15:25:42.749Z (11 months ago)
- Language: TypeScript
- Homepage: https://engage-voice-api-docs.readthedocs.io/en/latest/
- Size: 1.09 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RingCentral Engage Voice JavaScript SDK
[](https://travis-ci.com/github/ringcentral/engage-voice-js)
[](https://coveralls.io/github/ringcentral/engage-voice-js?branch=release)
RingCentral Engage Voice Client SDK for JavaScript.
## Features
- Auto refresh access token
## Use
```bash
npm i ringcentral-engage-voice-client
```
```js
const RingCentralEngageVoice = require('ringcentral-engage-voice-client').default
// or
// import RingCentralEngageVoice from 'ringcentral-engage-voice-client'
// create from ringcentral app client id /secret
// you can create app from https://developer.ringcentral.com
const ev = new RingCentralEngageVoice({
clientId: process.env.RINGCENTRAL_CLIENTID,
clientSecret: process.env.RINGCENTRAL_CLIENTSECRET
})
// auth with jwt
await ev.authorize({
jwt: process.env.RINGCENTRAL_JWT
})
// get access token
const token = ev.token().accessToken
// can also auth with password flow
// await ev.authorize({
// username: process.env.RINGCENTRAL_USERNAME,
// extension: process.env.RINGCENTRAL_EXTENSION,
// password: process.env.RINGCENTRAL_PASSWORD
// })
// can also auth with auth code flow
// check https://developers.ringcentral.com/guide/authentication for more detail
// await ev.authorize({
// code: 'xxxx',
// redirectUri: 'yyyyyy'
// })
// api request
// check all api doc from https://engage-voice-api-docs.readthedocs.io/en/latest/
let r = await ev.get('/api/v1/admin/accounts')
r = r.data
expect(r.length > 0).toBe(true)
```
For legacy server use:
```js
const RingCentralEngageVoice = require('ringcentral-engage-voice-client').default
// or
// import RingCentralEngageVoice from 'ringcentral-engage-voice-client'
// LEGACY_SERVER could be
// 'https://portal.vacd.biz',
// or 'https://portal.virtualacd.biz'
const ev = new RingCentralEngageVoice({
server: process.env.LEGACY_SERVER
})
// only support username/password auth
await ev.authorize({
username: process.env.LEGACY_USERNAME,
password: process.env.LEGACY_PASSWORD
})
// api request
// check all api doc from https://engage-voice-api-docs.readthedocs.io/en/latest/
let r = await ev.get('/api/v1/admin/accounts')
r = r.data
expect(r.length > 0).toBe(true)
// revoke api token
ev.revokeLegacyToken()
```
## Instance methods
ev.request(config)
ev.get(url, config = {})
ev.post(url, data = undefined, config = {})
ev.put(url, data = undefined, config = {})
ev.delete (url, config = {})
ev.patch(url, data = undefined, config = {})
## Test
```bash
npm i
cp env-sample.env .env
# then edit .env fill all fields
npm run test
```
## Run demo code
```bash
cd demo
npm i
cp env-sample.env .env
# then edit .env fill all fields
npm start
# edit index.js to play
```
## Credits
Based on tyler's [ringcentral-js-concise](https://github.com/tylerlong/ringcentral-js-concise)
## License
MIT