Updated Notify_d7networks (markdown)

Chris Caron 2022-12-28 10:02:15 -05:00
parent c65c5f10b5
commit 57196e0cb5

@ -7,18 +7,18 @@
### Account Setup ### Account Setup
To use this service you will need a D7 Networks account from their [website](https://d7networks.com/) To use this service you will need a D7 Networks account from their [website](https://d7networks.com/)
After you've established your account you can get your api login credentials (both _user_ and _password_) from the API Details section from within your [account profile area](https://d7networks.com/accounts/profile/). After you've established your account you can get your API Token from the API Details section from within your [account profile area](https://d7networks.com/accounts/profile/).
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntax is as follows:
* `d7sms://{user}:{password}@/{PhoneNo}` * `d7sms://{token}@/{PhoneNo}`
* `d7sms://{user}:{password}@/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}` * `d7sms://{token}@/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}`
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| --------------- | -------- | ----------- | --------------- | -------- | -----------
| user | Yes | The _username_ associated with your D7 Networks account. This is available to you via the **API Details** section from within your [account profile area](https://d7networks.com/accounts/profile/). | token | Yes | The _API Token_ associated with your D7 Networks account. This is available to you via the **API Details** section from within your [account profile area](https://d7networks.com/accounts/profile/).
| password | Yes | The _API Secret_ associated with your D7 Networks account. This is available to you via the **API Details** section from within your [account profile area](https://d7networks.com/accounts/profile/).
| PhoneNo | Yes | At least one phone number MUST identified to use this plugin. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion. | PhoneNo | Yes | At least one phone number MUST identified to use this plugin. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion.
| from | No | Originating address,In cases where the rewriting of the sender's address is supported or permitted by the SMS-C. This is used to transmit the message, this number is transmitted as the originating address and is completely optional. | from | No | Originating address,In cases where the rewriting of the sender's address is supported or permitted by the SMS-C. This is used to transmit the message, this number is transmitted as the originating address and is completely optional.
| priority | No | By default a priority of zero (0) is set (low). You can set 0, 1, 2, or 3 if you wish to adjust this value where as 3 represents a high priority. | priority | No | By default a priority of zero (0) is set (low). You can set 0, 1, 2, or 3 if you wish to adjust this value where as 3 represents a high priority.
@ -27,15 +27,14 @@ Valid syntaxes are as follows:
#### Example #### Example
Send a D7 Network Notification as an SMS: Send a D7 Network Notification as an SMS:
```bash ```bash
# Assuming our {user} is l2g # Assuming our {token} is AJfkafjA4Baghkr0Zkjk
# Assuming our {password} is appriseIsAwesome
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1 # Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223 # - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
d7sms://l2g:appriseIsAwesome@18005551223 d7sms://AJfkafjA4Baghkr0Zkjk@18005551223
# the following would also have worked (spaces, brackets, # the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field): # dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
d7sms://l2g:appriseIsAwesome@1-(800) 555-1223 d7sms://AJfkafjA4Baghkr0Zkjk@1-(800) 555-1223
``` ```