Voip.ms Notifications

Overview

• Source: https://voip.ms/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 160

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

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

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.