VOICE1-Public/switchvox-did-usage-report
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
Ben D.
2023-01-23 13:04:19 -08:00
parent 53f49e5a34
commit 6e169e5e20
1 changed files with 27 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,2 +1,28 @@
# switchvox-did-usage-report # Switchvox DID Usage Report
Takes a list of DID's from a `csv` file and pulls usage report from `api.switchvoxuc.com`.
## CSV File.
The file should have the following headers
The file should have a single header `csv` or can be a document with one number per line with no headers.
## Usage
Set your authentication information as a shell variable.
```
SWVX_API_USERNAME=<YOUR API USERNAME>
SWVX_API_PASSWORD=<YOUR API PASSWORD>
```
`switchvox-did-usage-report --csv=<PATH TO CSV FILE>`
Alternatively you can store your credentials in a file and pass that file to the script.
>This should be kept only accessable by administrators. As the contents are not encrypted.
Store your username password as such:
`<USERNAME>:<PASSWORD>`
`switchvox-did-usage-report --csv=<PATH TO CSV FILE> --credentials=<CREDENTIALS FILE>`