mirror of https://github.com/caronc/apprise
6
Notify_voipms
Chris Caron edited this page 2024-11-01 20:07:27 -04:00
Voip.ms Notifications
- Source: https://voip.ms/
- Icon Support: No
- Message Format: Text
- Message Limit: 160 Characters per Message
Setup
Sign up for Voip.ms from here. From your dashboard, you will have to enable API access and create a password at the following link: here
You must edit your DID and enable SMS/MMS ($0.0075/SMS, and $0.02/MMS):
Syntax
Valid syntax is as follows:
voipms://{password}:{email}/{fromPhoneNo}voipms://{password}:{email}/{fromPhoneNo}/{toPhoneNo}voipms://{password}:{email}/{fromPhoneNo}/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}/
Parameter Breakdown
| Variable | Required | Description |
|---|---|---|
| Yes | The email associated with your Voip.ms account | |
| password | Yes | The password for API access, this is different from your Voip.ms account password |
| fromPhoneNo | Yes | Specify the phone number you registered with Voip.ms you wish the message to be identified as being sent from. |
| toPhoneNo | No | A phone number and/or group you wish to send your notification to. You can use comma's to separate multiple entries if you wish. |
Example
Send a Voip.ms notification to ourselves:
# Assume:
# - our {email} is test@example.com
# - our {password} is abc123
# - The {toPhoneNo} and {fromPhoneNo} is 6135551234
apprise -vv -t "Test Message Title" -b "Test Message Body" \
voipms://abc123:test@example.com/6135551234
Send a Voip.ms notification to another device:
# Assume:
# - our {email} is test@example.com
# - our {password} is abc123
# - The {fromPhoneNo} is 6135551234
# - The {ToPhoneNo} is 5645554321
apprise -vv -t "Test Message Title" -b "Test Message Body" \
voipms://abc123:test@example.com/6135551234/5645554321
Troubleshooting
There have been cases where error messages would be sent back from the VoipMS Server that are not very descriptive to what the issue is. The key things you need to verify for this service to work is:
- Account has credits available to use
- SMS/MMS is enabled (see Setup section above)
In certain cases, it's possible that the Carrier you were delivering to was unable to send the message.