sms: Protocol

IceWarp Server has an internal sms: protocol URI defined to allow you to forward messages (emails, XMPP, server variables) to SMS by replacing the recipient email address (To:) with sms:<number> URI.

The sms: protocol can be used anywhere in IceWarp Server where an email address can be used, within forwards, rules, filters, notifications, watchdogs and other actions, allowing an extremely flexible way to communicate instantly via SMS.

For example you, as an administrator, could set up the report email address of the remote server watchdog to send an SMS to your mobile so you are instantly aware of any problems found by the watchdog.

Another application of SMS gateway is for new email notifications – information about the arrived email (subject, sender, size of the body) that will be included in the SMS can be fully customized using the Notification account type. Then you only need to set a Forward To from the user's mailbox to this account, or the user him/her-self can set a rule in their e-mail client.

The basic format of the protocol is:

sms:<number>

Where:

<number> – is the number that you want to send the sms to REQUIRED.

Authenticated format of the protocol is:

sms:<number>?user=<username>&pass=<password>

Where:

<username> – is a valid username for authentication.

<password> – is the valid password associated with the username – only required if authentication is active.

The full format of the sms: protocol with all optional parameters is:

sms:<number>?user=<username>&pass=<password>&maxmsgs=<N>&binary=<binary>&udh=<udh>&pid=<pid>&dcs=<dcs>&sender=<sender>&authenticated=<authenticated>&reply=<reply>&id=<ID>

The sms: URI supports a set of additional HTTP-like parameters appended after the ? delimiter.

Warning:If @ (at) should occur within any parameter (username, password, etc.), it has to be replaced with %40.

See Available Parameters for details.

sms: Protocol Examples

  • sms:+15551234567

    forwards the first (by default 3) SMS-sized blocks of the email to number +15551234567.

  • sms:+15551234567?user=john&pass=johnpw

    forwards the first (by default 3) SMS-sized blocks of the email to number +15551234567, if the user/password combination is defined in SMS service authentication.

  • sms:+15551234567?user=john&pass=johnpw&maxmsgs=10

    forwards the 10 SMS-sized blocks of message data to number +15551234567, but only if the user/password combination is defined in SMS service authentication.