mirror of https://github.com/caronc/apprise
Created Notify_sfr (markdown)
parent
19ea635307
commit
cf0fe71a9d
|
@ -0,0 +1,40 @@
|
||||||
|
## Société Française du Radiotéléphone (SFR)
|
||||||
|
* **Source**: https://nexmo.com/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Message Format**: Text
|
||||||
|
* **Message Limit**: 160 Characters per message
|
||||||
|
|
||||||
|
### Account Setup
|
||||||
|
To use Vonage, you will need to acquire your _API Key_ and _API Secret_. Both of these are accessible via the [Vonage Dashboard](https://dashboard.nexmo.com/getting-started-guide).
|
||||||
|
|
||||||
|
The **{FromPhoneNo}** must be a number provided to you through Nexmo
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
Valid syntax is as follows:
|
||||||
|
* `sfr://{user}:{password}@{space_id}/{PhoneNo}`
|
||||||
|
* `sfr://{user}:{password}@{space_id}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}`
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
| Variable | Required | Description
|
||||||
|
| --------------- | -------- | -----------
|
||||||
|
| user | Yes | The user associated with your SFR account.
|
||||||
|
| password | Yes | The password associated with your SFR account.
|
||||||
|
| space_id | Yes | The Space ID associated with your SFR account.
|
||||||
|
| PhoneNo | **\*No** | The phone number you wish to notify
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
Send a SFR Notification:
|
||||||
|
```bash
|
||||||
|
# Assuming our {user} is foo
|
||||||
|
# Assuming our {password} is bar
|
||||||
|
# Assuming our {space_id} is 1234
|
||||||
|
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
|
||||||
|
# - identifies as 800-555-1223
|
||||||
|
apprise -vv -t "Test Message Title" -b "Test Message Body" \
|
||||||
|
sfr://foo:bar@1234/18005551223
|
||||||
|
|
||||||
|
# the following would also have worked (spaces, brackets,
|
||||||
|
# dashes are accepted in a phone no field):
|
||||||
|
apprise -vv -t "Test Message Title" -b "Test Message Body" \
|
||||||
|
sfr://foo:bar@1234//1-(800) 555-1223
|
||||||
|
```
|
Loading…
Reference in New Issue