Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/C-Duv/freemobile-smsapi-client
API client for the Free Mobile SMS notification service
https://github.com/C-Duv/freemobile-smsapi-client
freemobile sms-notifications
Last synced: 2 months ago
JSON representation
API client for the Free Mobile SMS notification service
- Host: GitHub
- URL: https://github.com/C-Duv/freemobile-smsapi-client
- Owner: C-Duv
- License: gpl-2.0
- Created: 2014-06-11T20:59:52.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-11-21T21:47:07.000Z (about 3 years ago)
- Last Synced: 2024-08-07T09:11:29.960Z (6 months ago)
- Topics: freemobile, sms-notifications
- Language: Shell
- Size: 16.6 KB
- Stars: 57
- Watchers: 12
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
freemobile-smsapi-client
========================API client for the Free Mobile SMS notification service
Theses clients send SMS notifications via [Free Mobile](http://mobile.free.fr) 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*