Have ideas to improve npm?Join in the discussion! »

ringcentral-engage-voice-clientTypeScript icon, indicating that this package has built-in type declarations

1.37.3 • Public • Published

RingCentral Engage Voice JavaScript SDK

Build Status Coverage Status

RingCentral Engage Voice Client SDK for JavaScript.

Features

  • Auto refresh access token

Use

npm i ringcentral-engage-voice-client
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 password flow
await ev.authorize({
  username: process.env.RINGCENTRAL_USERNAME,
  extension: process.env.RINGCENTRAL_EXTENSION,
  password: process.env.RINGCENTRAL_PASSWORD
})

// get access token
const token = ev.token().accesToken

// 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:

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

npm i
cp env-sample.env .env
# then edit .env fill all fields
npm run test

Run demo code

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

License

MIT

Install

npm i ringcentral-engage-voice-client

DownloadsWeekly Downloads

59

Version

1.37.3

License

MIT

Unpacked Size

68.4 kB

Total Files

9

Last publish

Collaborators

  • avatar