Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 

README.md

freemobile-smsapi-client

API client for the Free Mobile SMS notification service

Theses clients send SMS notifications via Free Mobile mobile broadband company native SMS-notification API. This service can only send SMS to line's owner: it cannot be used to send SMS to any mobile number, group or massive spam.

Shell Client

Possible usages:

send-notification.sh [options] "All your base are belong to us"
uptime | send-notification.sh [options]

See send-notification.sh -h.

Configuration :

Script can be configured using the following variables:

  • USER_LOGIN: The login to use the API.
  • API_KEY: The secret key associated to USER_LOGIN.
  • MESSAGE_HEADER (Optional): Will be prepended to all the messages.
  • MESSAGE_FOOTER (Optional): Will be appended to all the messages.
  • NEWLINE_CHAR (Optional): Char to use to create a new line (it depends on receiving terminal).

Theses can be directly changed in the send-notification.sh file or set in a separate configuration file named .freemobile-smsapi next to the script or in the user's home directory. A given filepath can also be specify using the -c script at runtime (send-notification.sh -c foobar).

Configuration load process is as follows:

  1. Uses what's in send-notification.sh file.
  2. If -c option is set, test given file existence and uses what's inside. Will not load any other configuration file (stops load process here).
  3. Checks if a .freemobile-smsapi file exists next to the script and uses what's inside. Will not load any other configuration file (stops load process here).
  4. Checks if a .freemobile-smsapi file exists in user's home directory (${HOME}) and uses what's inside. Will not load any other configuration file (stops load process here).

PHP Client

Soon

About

API client for the Free Mobile SMS notification service

Topics

Resources

License

Releases

No releases published

Packages

No packages published

Languages

You can’t perform that action at this time.