extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_voipms
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
6 Notify_voipms
Chris Caron edited this page 2024-11-01 20:07:27 -04:00
Table of Contents

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):
Screenshot from 2024-10-27 09-44-48

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
email 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.

Quick Links: