Skip to main content

Manages your Poly VVX powered by RESTAPIs based on (UCS>=6.1), with CLI Menu or simply use the available VVX class to develope your own applications.

Project description

vvxme

version: 1.0.0

Manages your Poly VVX powered by RESTAPIs based on (UCS>=6.1), with CLI Menu or simply use the available VVX class to develope your own applications.

Prerequisite:

  • Install python 3.7 or above
  • Install the project: 'pip install vvxme'
  • Full features tested on VVX (non-touch models) running UCS 6.1. Earlier version will exibit some API errors.

OS security notes:

  • For Windows users: Run the console in Administrator mode to use VVX class in interactive mode.
  • For Mac users: Requires sudo mode to run CLI Menu - 'sudo python -m vvxme'

Using the inbuilt CLI Menu

To invoke the CLI Menu, simply open a console and type command: 'python -m vvxme'

Available menus in this version:

Main Selection Menu:

  1. Show Device Information Menu (Useful information of your VVX using standard RestAPI queries)
    • Show Device Info
    • Show Device Stats
    • Show Network Info
    • Show Network Stats
    • Show Line Info
    • Show Session Stats
  2. Quick Configuration Menu (Quick fix to enabled/disable specific features on your VVX)
    • Acoustic Fence Menu
    • Headset Configuration Menu
    • Message Waiting Indicator (LED)
    • Network Discovery - CDP
    • Network Discovery - LLDP
    • Remote Packet Capture
    • Screen Capture
    • SIP Autoanswer
    • SIP Debug & Logging
  3. Web Call Controls Menu (Remote dial-out using either TEL/SIP dialstrings from specified Line with specified duation)
    • Call Dial
  4. Simulate Key Events Menu (Drive the VVX using your keyboard)
    • Simulate Keys

Using the VVX Class

Example:
# python
>>> import vvxme
>>> dev = vvxme.vvx( '192.168.1.10', ('Polycom', '789') )

Class for VVX based on UCS 6.1.0 REST APIs.
INPUTS for instance creation:
    - ipaddr = IP address of phone
    - auth = username and password in tuple
Attributes:
    .ipaddr
    .auth_credentials
    .use_https
    .verify_secure
    .model
    .firmware
    .macaddress
    .baseprofile

Methods:
   .getDeviceInfoV2() - calls "/api/v2/mgmt/device/info"
   .getNetwork() - calls "/api/v1/mgmt/network/info"
   .getLineInfoV2() - calls "/api/v2/mgmt/lineInfo"
   .getCallStatusV2() - calls "/api/v2/webCallControl/callStatus"
   .getRunningConfig() - calls "/api/v1/mgmt/device/runningConfig"
   .getDeviceStats() - calls "/api/v1/mgmt/device/stats"
   .getNetworkStats() - calls "/api/v1/mgmt/network/stats"
   .getSessionStats() - calls "/api/v1/mgmt/media/sessionStats"
   .callDial() - "/api/v1/callctrl/dial"
   .callEnd() - "/api/v1/callctrl/endCall"
   .getConfig() - calls "/api/v1/mgmt/config/get"
   .setConfig() - calls "/api/v1/mgmt/config/set"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for vvxme, version 1.0.0.post1
Filename, size File type Python version Upload date Hashes
Filename, size vvxme-1.0.0.post1-py2.py3-none-any.whl (24.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size vvxme-1.0.0.post1.tar.gz (16.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page