This library allows for you to integrate with Five9 Cloud Contact Center using Python.
Project description
|License MIT| | |Build Status| | |Coverage| | |Code Climate|
============
Python Five9
============
This library allows you to interact with the Five9 Settings and Statistics Web
Services using Python.
* `Read The API Documentation <https://laslabs.github.io/python-five9>`_
Installation
============
Installation is easiest using Pip and PyPi::
pip install five9
If you would like to contribute, or prefer Git::
git clone https://github.com/LasLabs/python-five9.git
cd python-five9
pip install -r requirements.txt
pip install .
Usage
=====
Connect
-------
.. code-block:: python
from five9 import Five9
client = Five9('user', 'password')
Configuration Web Services
--------------------------
Documentation:
* `Five9 <http://webapps.five9.com/assets/files/for_customers/documentation/apis/config-webservices-api-reference-guide.pdf>`_
* `API Docs <https://laslabs.github.io/python-five9/AdminWebService.html>`_
Example:
.. code-block:: python
client.configuration.getSkills()
# Returns
[{
'description': None,
'id': 266184L,
'messageOfTheDay': None,
'name': 'TestSkill',
'routeVoiceMails': False
}]
Statistics Web Services
-----------------------
Documentation:
* `Five9 <http://webapps.five9.com/assets/files/for_customers/documentation/apis/statistics-webservices-api-reference-guide.pdf>`_
* `API Docs <https://laslabs.github.io/python-five9/SupervisorWebService.html>`_
Example:
.. code-block:: python
# Setup a session - required for most things
client.supervisor.setSessionParameters({
'forceLogoutSession': True,
'rollingPeriod': 'Minutes30',
'shiftStart': 28800000,
'statisticsRange': 'CurrentWeek',
'timeZone': -25200000,
})
Credits
=======
Images
------
* LasLabs: `Icon <https://repo.laslabs.com/projects/TEM/repos/odoo-module_template/browse/module_name/static/description/icon.svg?raw>`_.
Contributors
------------
* Dave Lasley <dave@laslabs.com>
Maintainer
----------
.. image:: https://laslabs.com/logo.png
:alt: LasLabs Inc.
:target: https://laslabs.com
This module is maintained by LasLabs Inc.
.. |Build Status| image:: https://api.travis-ci.org/LasLabs/python-five9.svg?branch=master
:target: https://travis-ci.org/LasLabs/python-five9
.. |Coverage| image:: https://codecov.io/gh/LasLabs/python-five9/branch/master/graph/badge.svg
:target: https://codecov.io/gh/LasLabs/python-five9
.. |Code Climate| image:: https://codeclimate.com/github/LasLabs/python-five9/badges/gpa.svg
:target: https://codeclimate.com/github/LasLabs/python-five9
.. |License MIT| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: License: MIT
============
Python Five9
============
This library allows you to interact with the Five9 Settings and Statistics Web
Services using Python.
* `Read The API Documentation <https://laslabs.github.io/python-five9>`_
Installation
============
Installation is easiest using Pip and PyPi::
pip install five9
If you would like to contribute, or prefer Git::
git clone https://github.com/LasLabs/python-five9.git
cd python-five9
pip install -r requirements.txt
pip install .
Usage
=====
Connect
-------
.. code-block:: python
from five9 import Five9
client = Five9('user', 'password')
Configuration Web Services
--------------------------
Documentation:
* `Five9 <http://webapps.five9.com/assets/files/for_customers/documentation/apis/config-webservices-api-reference-guide.pdf>`_
* `API Docs <https://laslabs.github.io/python-five9/AdminWebService.html>`_
Example:
.. code-block:: python
client.configuration.getSkills()
# Returns
[{
'description': None,
'id': 266184L,
'messageOfTheDay': None,
'name': 'TestSkill',
'routeVoiceMails': False
}]
Statistics Web Services
-----------------------
Documentation:
* `Five9 <http://webapps.five9.com/assets/files/for_customers/documentation/apis/statistics-webservices-api-reference-guide.pdf>`_
* `API Docs <https://laslabs.github.io/python-five9/SupervisorWebService.html>`_
Example:
.. code-block:: python
# Setup a session - required for most things
client.supervisor.setSessionParameters({
'forceLogoutSession': True,
'rollingPeriod': 'Minutes30',
'shiftStart': 28800000,
'statisticsRange': 'CurrentWeek',
'timeZone': -25200000,
})
Credits
=======
Images
------
* LasLabs: `Icon <https://repo.laslabs.com/projects/TEM/repos/odoo-module_template/browse/module_name/static/description/icon.svg?raw>`_.
Contributors
------------
* Dave Lasley <dave@laslabs.com>
Maintainer
----------
.. image:: https://laslabs.com/logo.png
:alt: LasLabs Inc.
:target: https://laslabs.com
This module is maintained by LasLabs Inc.
.. |Build Status| image:: https://api.travis-ci.org/LasLabs/python-five9.svg?branch=master
:target: https://travis-ci.org/LasLabs/python-five9
.. |Coverage| image:: https://codecov.io/gh/LasLabs/python-five9/branch/master/graph/badge.svg
:target: https://codecov.io/gh/LasLabs/python-five9
.. |Code Climate| image:: https://codeclimate.com/github/LasLabs/python-five9/badges/gpa.svg
:target: https://codeclimate.com/github/LasLabs/python-five9
.. |License MIT| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: 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
five9-0.0.1b44.tar.gz
(4.3 kB
view hashes)