FusionPBX Pilot Python Library

Gnovit

email: fusionpbx-pilot@gnovit.com

This python library is intended to automate FusionPBX administrative tasks. This library is based on Selenium WebDriver and abstracts FusionPBX objects as python objects. Should be used in an API to manage FusionPBX. This is licensed under the terms of the GNU GPL v3 license.

Examples

Install the library:

python3 -m venv .venv
source .venv/bin/activate
pip install fusionpbx-pilot

Install webdriver_manager to automatically manage the browser driver:

pip install webdriver_manager

Install GeckoDriver and instantiate the FusionPBX class:

from selenium import webdriver
from selenium.webdriver.firefox.service import Service as FirefoxService
from webdriver_manager.firefox import GeckoDriverManager
from selenium.webdriver.firefox.service import Service as FirefoxService
from fusionpbx_pilot.page_objects import FusionPBX


service = FirefoxService(GeckoDriverManager().install())
driver = webdriver.Firefox(service=service)

f = FusionPBX(driver, '<https://addr>', '<login_user>', '<login_password>')

• Set domain object: If domain no exist, raises DomainNotFound exception.

d = f.domain('<domain_name>')

• To create a new domain, use the following:

d = f.domain('<domain_name>', create=True)

Returns a new domain object.

Domain manipulate

• Domain rename:

d.name = '<new_domain_name>'

• Domain get uuid:

d.uuid

• Domain delete: You must to add domain delete permission to the user used to login to FusionPBX.

del f.domain.name

Extensions manipulate

• List all extensions of a domain:

d.extensions.list()

• Set or create an extension object:

e = d.extension('<extension_name>')

Generally extension name is a number...

If extension no exist, the lib will create it.

• Rename extension object

e.name = '<new_extension_name>'

• Get or set password

e.password

Returns password

e.password = '<new_password>'

Set the password

• Get or set voicemail enabled:

e.voicemail_enabled

• Get or set voicemail_mail_to:

e.voicemail_mail_to

• Get UUID:

e.uuid

• Delete extension

del d.extension.name

Contributions

Contribuitions are welcome. Please fork the project and send a pull request.