Sipgate-CLI/README.md

Sipgate CLI

This is a small hack to send faxes via the sipgate REST API from the command line.

Deployment

Add your login credentials to login_credentials_muster.sh and rename the file to .env If you use Letterheads Address database, uncomment the last line of that file and add your/path/to/Letterhead

Usage

./fax.sh <letter.pdf> <recipient>

sipgate doesn't accept pdf files larger than 30 pages or 10MB.

For now, <recipient> has to be numbers-only, starting with +49. It is planned to parse different number formats. Should be done. Spaces in filename seem to make trouble at the moment - avoid them.

status.sh shows ID, Date and Status of the last ten fax set from this device.

balance.sh just gives your account balance.

faxreport.sh [options] [id] loads the report of a given fax id (as shown by status.sh). If no id ist given, it takes the last fax sent from this machine.

Options:

• -p to only print and not save the report
• -d to delete the given id from .fax_history

Recommendation

Put

alias fax="/your/path/to/this/project/fax.sh"
alias faxstatus="/your/path/to/this/project/status.sh"
alias faxbalance="/your/path/to/this/project/balance.sh"
fax-from-handle () { fax $1 "$(/your/path/to/this/project/Letterhead/Adressen/address.sh -f $2)"; }

into your .bashrc or .bash_aliases