Update 'README.md'

This commit is contained in:
Ben D
2022-01-20 15:36:28 -08:00
parent b0db22cef8
commit 040586834b

View File

@@ -1,3 +1,19 @@
# E911_helper
Helper script for creating E911 addresses using api.nwsip.com and for setting caller ID and call routing in Switchvox PBX using api.switchvoxuc.com
## Intended User(s)
This script is provided as working demo to document for users how they can create simple automations for managing their E911 addresses and setting correct caller id information on systems hosted at switchvoxuc.com.
You are encourgaged to create your own automation workflows using the provided API's and integrate them to your other existing services.
**WARNING** Changes made with API's are realtime. There is no rolling back. You should make sure that you are positive of your actions before commiting to them.
## Requirement
- You must have an active account with api.nwsip.com
- You must have an active account with api.switchvoxuc.com
-- Your permission level must allow access to view and modify incoming and outgoing call routes.
## Install
You must have python3.9+ installed to fun this script. Additionally you will need the `requests` and `loguru` library installed.