From 040586834bc637fd5ec2ff050ab84a627ae20d33 Mon Sep 17 00:00:00 2001 From: Ben D Date: Thu, 20 Jan 2022 15:36:28 -0800 Subject: [PATCH] Update 'README.md' --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ea79914..3704608 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file +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. +