r4vi/python-sipgate-xmlrpc

Easy to use Python bindings for the Sipgate XML-RPC API.

python-sipgate-xmlrpc – Easy to use Python bindings for the sipgate XML-RPC API.

python-sipgate-xmlrpc is a package of Python bindings to simplify and leverage the communication with the XML-RPC API of Sipgate, the documentation file of which is XML-RPC API documentation v1.06 2007-08-21.

Project Information

This software (python-sipgate-xmlrpc) provides an easy way to use the XMLRPC API offered by Sipgate to its customers. The software consists of a class to leverage the use of the API and example code to show how to use it.

If you have an idea for the software or want to report a bug, let me know via email! Or you can use the issue tracker on GitHub to report bugs or request features.

About the API.

Nowadays, Sipgate also offers a more modern RESTful web API the documentation of which can be found on http://www.live.sipgate.de/api/rest. But users with a Basic Account can't use it. Only customers with a Sipgate one or Sipgate team account may use the RESTful API.

On the end user information site for the API, the user is being displayed version of the API documentation file: XML-RPC API documentation v1.06 2007-08-21.
And on the Sipgate team API help site they link a more up-to-date version 1.09 of the document: XML-RPC API documentation v1.09 2009-06-22 which seems to be availbale only for Sipgate one and Sipgate team customers with the newer URL https://api.sipgate.net/RPC2 as indicated in a post on the API discussion.
As this Python module is intended primarily for basic / plus customers at the moment, the API version is still at 1.06.

Required Python modules

The software is tested and known to work well on Python 2.7.1 on Mac OS X 10.6.7.

Installation and Usage

1. Get the source code of the project (via .tar.gz or .zip download or via git).
2. Have a look into the example useage file example-usage.py and change the credentials or save the credentials in a local settings file settings.py (file will be ignored by git).
3. Run the examples to find out if it's working.
4. Have look at the API documentation PDF to find out what other calls you send to the API.

You may also have a look at my blog post, where I presented the class: http://blog.philippklaus.de/2011/06/python-sipgate-xmlrpc_easy-to-use-python-bindings-for-the-sipgate-xml-rpc-api/.

License

python-sipgate-xmlrpc is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

python-sipgate-xmlrpc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with python-sipgate-xmlrpc. If not, see http://www.gnu.org/licenses/.

Author

• Philipp Klaus
  • Web site: http://blog.philippklaus.de
  • Email: philipp.klaus →AT→ gmail.com