RingCentral Engage Voice client Python
Project description
RingCentral Engage Voice API wrapper for Python
Installation
PIP
pip install ringcentral_engage_voice
Usage
from ringcentral_engage_voice import RingCentralEngageVoice
# create from ringcentral app client id /secret
# you can create app from https://developer.ringcentral.com
ev = RingCentralEngageVoice(
'RINGCENTRAL_CLIENT_ID',
'RINGCENTRAL_CLIENT_SECRET'
)
# auth with password flow
ev.authorize(
username = 'USERNAME',
password = 'PASSWORD',
extension = 'EXTENSION' # optional
)
# // can also auth with auth code flow
# // check https://developers.ringcentral.com/guide/authentication for more detail
ev.authorize(
code = 'xxxx',
redirectUri = 'yyyyyy'
)
# get access token, will expire in 5 minutes
token = ev.token['accessToken']
# // api request
# // check all api doc from https://engage-voice-api-docs.readthedocs.io/en/latest/
r = ev.get('/api/v1/admin/accounts')
assertEqual(len(r.json()) > 0, True)
For legacy server use:
from ringcentral_engage_voice import RingCentralEngageVoice
# LEGACY_SERVER could be
# 'https://portal.vacd.biz',
# or 'https://portal.virtualacd.biz'
ev = 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 = ev.get('/api/v1/admin/accounts')
r = r.json()
expect(len(r) > 0).toBe(true)
# revoke api token
ev.revokeLegacyToken()
Instance methods
ev._request(
method,
endpoint,
params = None,
json = None,
data = None,
files = None,
multipart_mixed = False,
headers = None
)
ev.get(endpoint, params = None)
ev.post(endpoint, json = None, params = None, data = None, files = None, multipart_mixed = False)
ev.put(endpoint, json = None, params = None, data = None, files = None, multipart_mixed = False)
ev.patch(endpoint, json = None, params = None, data = None, files = None, multipart_mixed = False)
ev.delete(endpoint, params = None)
Test
bin/init
source venv/bin/activate
pip install -r requirements.txt
cp env-sample.env .env
# edit .env fill all fields
./bin/test
Credits
Based on Tyler's https://github.com/tylerlong/ringcentral-python.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for ringcentral_engage_voice-0.2.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 014054584cfba51939a1fc5754bba9afaac257244b386400ce20fb4281f23455 |
|
MD5 | bd34af815648727819cad78eb6902196 |
|
BLAKE2b-256 | 6689186a895d4751cf3af17abba3fc705bed86bf95b3891fd18fd0b4b9b5f135 |
Close
Hashes for ringcentral_engage_voice-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8a28970021a3240b31aae95f7c1642b1d8e31c833678d3e8630ab9956cccfd5 |
|
MD5 | b1291373bde70f20d29afe85cab0c6c7 |
|
BLAKE2b-256 | cd260a974c1098f24a399753d936d486099baac2f2fef014e5fd5321e46f76bf |