Command Line Utilities

This respository contains a set of command line utilities that can be used to query or remotely control a Cisco IP Phone.

• cgiexecute - Execute a URI on the phone (eg: Dial:).
• mediastream - Play a .wav file on one or more phones at the same time using the new RTP streaming API.
• rtptransmit - Play a .wav file on one more phones at the same time using the legacy RTP streaming API.
• screenshot - Download a screenshot of the phones screen.
• setbackground - Set the background image on the phone.
• setringtone - Set the ring-tone on the phone.
• xmlinfo - Get call, line, settings, mode, device, network, ethernet, port, log and streaming information from the phone as XML.
• cipimage - Convert a PNG to an grayscale 4-color CIP image.

Requirements

The following non-standard Python modules are required: requests, lxml and PIL.

You can use the packages provided by your OS distribution or run sudo pip3 install -r requirements.txt to satisfy those dependancies.

To use mediastream or rtptransmit you will need to also install GStreamer and the Glib object bindings. Installation is OS dependant, the following example shows how to install those packages on Debian/Ubuntu:

sudo apt install python3-gi python3-gst-1.0 \
  libgstreamer-plugins-good-1.0 libgstreamer-plugins-bad-1.0

Installation

sudo cp cgiexecute mediastream rtptransmit setbackground setringtone \
  screenshot xmlinfo cipimage /usr/local/bin

Optionally, install the bash tab-completion helpers.

sudo cp bash_completion /etc/bash_completion.d/usecallmanagernz-commands