Interpage Messaging, OutPage, SMS Gateway Protocol and Other Commands
[Main] |
[Messaging/Paging Services] |
[SMS Gateway] |
[Voice/WAV Dispatch] |
[Fax Dispatch Svcs] |
[Overview] |
[Messaging/Paging Trial & Signup] |
[Contact Interpage]
The command list and examples below are used in conjuction with the Messaging and Paging Gateway, and associated messaging plans, and SMS Gateway services.
I N T E R P A G E (TM) Mail-Config Use Instructions // Updated: 04/10/2023
____________________________________________________________________________
This section details how to send pages and SMS messages for group/gateway
accounts using the OutPage(sm) Protocol as well as some additional
administrative commands.
Enterprise/group messaging/gateway accounts are those which have a single
"gateway" account with Interpage and use it to process all Messaging, Paging,
and SMS / Voice / Faxing traffic to send to variable destinations (unlike
fixed or semi-fixed destination "individual"/personal accounts). This page
details the paging component thereof and the syntax used in a given e-mail
message to send a page or SMS message.
Interpage's Paging/SMS Gateway accepts "regular" port 25 mail, TLS via 25 or
customer selected private port, or legacy SSL mail via port 465.
All commands are to be placed in the BODY of a given e-mail message unless
otherwise noted (in which case commands are placed in the Subject: header)
Additionally, other than paging, paging gateway, SMS and other associated
services, customers may use the Interpage mail configuration server to:
-Set/create a reminder schedule
-Request a copy of all your user settings and billing information
-Enable Message or Page Holding
-Send Faxes (*)
-Store Faxes (*)
-Resend received (FaxUp) or stored faxes (*)
-Send OutVoice(sm) Messages (*)
-Set Autoresponse entries
-Access detailed Interim Billing information (restricted use)
-Select Palm of wireless PDA devices to conform to your schedule
(* = Some of these services require specialized accounts or additional
monthly and/or per-use charges.)
To communicate with the E-Mail configuration server on our system, you
will need to address all mail to:
[email protected]
So if your account is "john" you would mail [email protected].
The mail must be sent from your configured email address; email from
all other addresses will be ignored and you will receive an error
message. This is to maintain the security on your account. You may add an
alternate site which our system will recognize mail from and respond
accordingly (ie, not reject it) by telneting to the User Configuration
menu, selecting "User Preferences", and adding your alternate account
where indicated.
When using the E-Mail Configuration Server, the subject is generally
ignored, except as noted below for specific command. The important
part to watch out for is the body. Thus, for example, a typical e-mail
message to add a Reminder Schedule would have in it's body:
-------------------------------------------------------------------------
+Remind 01/01/95 0001 once alpha "Happy new year!"
show
done
-------------------------------------------------------------------------
This would schedule a new reminder at a minute past midnight on January
one (on your currently configured timezone) for your alpha pager to wish
yourself a happy new year. It would then show a complete account profile.
A confirmation message will be sent directly to your configured email
address; any errors encountered will be displayed there. All commands
(EXCEPT Fax commands), should be in the body of the message.
Please note that quotes ("") are very important. Most arguments ARE
case sensitive, so if one of your pagers is called "alpha" then using
"ALPHA" or "Alpha" will not work. The commands themselves, however, are
NOT case sensitive, so "done", "Done", "DONE" and "DoNe" are equivalent.
Multiple commands may be included on SEPARATE carriage-return delimited
lines, followed by DONE on a line by itself.
The [ and ] are NOT used when sending messages; they are used below to
simplify the examples. All quotes ("") MUST be used where indicated.
Key: Arguments in [] (e.g., [Outpager]) are required
Arguments in {} (e.g., {PagerID}) are required in certain circumstances
The commands are:
DONE
Tells the mail account editor that you are done. This is not
strictly necessary, but if your mailer inserts a signature
file this will avoid getting an error message when the editor
cannot understand your signature file.
SHOW
Prints a complete profile of your account
(no longer available for most accounts)
HOLD { ON | OFF | [HH:MM] }
Enables or disables the page hold feature. When the page hold feature
is enabled, all regular "Page" schedule options will be disabled.
Reminders and direct pages WILL still work, however. This feature
may be useful, for example, when you log in, you would send a
"hold on" message, because you'll know when you get email. Then when
you log out, you can do a "hold off" message.
ON Enables the page hold feature until midnight of the
current day.
OFF Disables any page holding currently in effect.
[HH:MM] Enables the page hold feature for the next HH hours
and MM minutes.
PAGING/SMS/MMS Commands:
OUTSYS [system name] [pager ID] "[Message]"
Used to send alpha messages to alpha pagers, alpha-capable cell
phones, and GSM mobile phones operated by service providers on the
OUTSYS service provider list. Please go to http://wwww.interpage.net/
sub-new.html for a complete and updated carrier list.
If you wish to message a customer(s) on any system on the OUTSYS list,
simply provide Interpage with the system name (from the OUTSYS list),
the pager ID or telephone number of the alpha pager or cellphone you
wish to message, and enclose the text message in quotes.
Please be mindful that some systems will entirely reject messages
which are too long, so generally, allow only 160 characters for most
cell/GSM phones and 220 for most US/Canada alpha pagers.
Outsys DATABSE assumes your account has access to the Paging
Database, BATABSE should be in CAPS (currently US-only).
Thus:
[system name] The name of one of the systems listed on the
OUTSYS list, such as "skytel6366". The current
list is located at https://interpage.net/sub-new.html
[pager ID] The pager ID number or in some cases the telephone
number of the pager you wish to message. In the
case of a cellphone or GSM mobile, it is usually
the 10 digit US/Canada phone number or the
International number for GSM mobiles
["Message"] The message to be sent. This MUST be enclosed
in quotes and no quotes may be used in the message.
OUTSYS SMSGATE [Country Code OR route/display code][SMS Mobile Number] "[Message]"
Used to send an alpha message to any SMS/MMS-capable device worldwide.
SMSGATE should be in CAPS.
There is *NO SPACE* character between the Country Code/Route Code and
the subscriber/destination mobile SMS or MMS recipient.
The SMSGATE is carrier-agnostic and does not require any information
regarding the destination carrier -- only the destination mobile
telephone number is required.
SMSGATE does not have a character limitation, but many SMS carriers
and/or mobile devices still limit SMS messages to 160 characters.
Thus:
[SMS/MMS # ] The country code of the mobile subscriber to receive
the message followed by the mobile number.
For North America, use "1" followed by the 10-digit
mobile number. For the UK, use 44 followed by the
mobile number, etc.
NOTE: For US/Canada/+1 SMS and MMS messages, the
leading "1" may be replaced by a Command Character
to force specific routes and/or display different
(non-default) sender information. Please consult
the "Welcome" message received upon account
activation for details on available Command
Characters on your Messaging/Paging account. For
example, placing a "0" in front of a 10-digit
US/Canada mobile number will result in a test
confirmation being sent to the sender, but no
actual SMS/MMS message being sent out.
["Message"] The message to be sent. This MUST be enclosed
in quotes, and no quotes may be used in the message.
Examples: OUTSYS SMSGATE 12135551212 "Hello" --> Send US
mobile # (213) 555-1212 the message "Hello"
OUTSYS SMSGATE 442075551212 "Test" --> Send UK
mobile # (207) 555-1212 the message "Test"
OUTSYS SMSGATE 02135551212 "Test2" --> Send to
the *sender only* a test confirmation that a
message of "Test2" was sent to (213) 555-1212
OUTSYS SMSGATE G2135551212 "Test3" --> Send to
(213) 555-1212 the message "Test3" via a special
messaging and/or backup route desginated as "G"
for your Interpage account
OUTSYS MEDGATE [Hospital/Medical Group] [Doctor/PagerID] ["Message"]
Used to send an alpha or voice message to a pre-defined private
medical alpha messaging system or telephone station.
[Hospital] The 10-character code for the hospital or medical
group private/segregated system to be paged.
[PagerID] A 3-14 digit code for the specific recipient or
station for voice notification (blank sends to
common capcode or system-wide call alert)
["Message"] The message to be sent. This MUST be enclosed
in quotes and no quotes may be used in the message.
NOTE: Hospital/Medical Group Paging/Messaging requires special
access to send via the Medical Access Database. Hospital
IDs which begin with "P" will accept a PagerID as the
subsequent field, those which begin with a "V" will accept
a 10-digit phone number (US/Canada) or International
destination preceded by 011. To send to Interpage MEDGate
Service PIN-based non-standalone accounts, preface the
Hospital or Practice ID with "M".
OUTANY IXO [number] [pager ID] ["Message"]
Used to send an alpha message to a TAP/IXO system without pre-
registration of the pager or system.
[number] Any directly dialable TAP/IXO number in the US/Canada
and certain other countries which your account
has access to. The number MUST be 10 numeric
characters in the NPANXXXXXX format, with no
spaces, dashes, or any other punctuation.
[pager ID] The pager ID of the given pager unit (blank sends
to the system's common capcode, if any)
["Message"] The message to be sent. This MUST be enclosed
in quotes and no quotes may be used in the message.
NOTE: Outany IXO use assumes a valid TAP/IXO number is used and is thus
not pre-tested by Interpage. Calls to non-TAP/IXO numbers
are billed as completed calls.
OUTANY SMS assumes a valid 10 digit US/Canada SMS or valid
IDDD format International SMS -without- the 011 or "+". This
command is depricated in favor of OUTSYS SMSGATE, above.
For details on current OUTANY systems, please refer to:
https://www.interpage.net/sub-new.html
OUTPAGE [Outpager] "[Message]"
Used ONLY to send to customized/pre-configured alpha systems or
systems not supported by the automated OUTSYS command, above.
Sends a message to a configured out pager which has been specially
set up or configured with custom name/branding/etc information for
a given Interpage account.
NOTE: Charges may apply for the manual addition and/or storage
of these pagers; please contact Interpage for details. Addition/
modification and storage charges may be avoided by utilizing the
OUTANY command, above.
[Outpager ] A name of a configured out pager or pager
["Message"] The message to be sent. This MUST be enclosed
in quotes and no quotes may be used in the message.
OUTNUM [SysType] [Phone] {PagerID} "[Message]"
Sends a page to any numeric pager with the specified phone number
and pager ID. There are many types of numeric paging services, and
you must specify the type with the [SysType] argument. The {PagerID}
argument is only necessary with some of the [SysType]s.
[SysType] The pager system type, one of NUM, NUM-A, or NUM-B:
NUM Standard numeric pager- waits for the other side to
answer and dials the message. {PagerID} should be
omitted.
NUM-A Skytel-style numeric pager- waits for the other side
to answer, dials the {PagerID} and a pound sign (#),
then dials the message and then two pound signs. Ex:
800-SKY-PAGE (800-759-7243) uses this.
NUM-B PageUSA-style numeric pager- waits for the other side
to answer, dials the {PagerID}, waits again, and dials
the message and then a pound sign. Ex: 800-589-9770
uses this.
[Phone] The phone number to dial. This must be exactly 10
digits, without a leading 1 or 0. Area code 809 is
restricted, as are some other numbers non-US/Canadian
destinations, which may be utilized on Enterprise
plans only.
{PagerID} Used with NUM-A and NUM-B only, this is the user's
Pager ID number.
["Message"] The message to be paged. This MUST be in quotes.
ADMINISTRATIVE Commands:
To promote uniformity between the various Interpage messaging and
notification services and their messaging protocols (eg, OutFax,
OutVoice, SMSGate, etc.), the following commands may be placed in
the Subject: header; note that Basic and Entry (Tier I and II)
accounts will accept these commands (or not "fail" them), but will
not echo any back due to the class of servers which process Tier I
and II messaging/paging requests).
page -code [string] Will return [string] in success/fail queues
and success/fail send messages
sms -status 1 Will return delivery status, if available,
for US/Canada SMS messages
sms -status 2 Will return delivery status, if available,
for International SMS messages
all -cost Will return cost of a given page or SMS if
NOT on an unlimited plan
all -dq Will force a de-queue of pages or SMS messages
which were held due a given terminal being
unavailable, will fail messages if the terminal
is then again unavailable after the -dq command
+REMIND [MM/DD/YY] [HHMM] [Freq] [Pager] "[Message]"
Adds a reminder to your reminder schedule, for your locally
configured timezone. The arguments are:
[MM/DD/YY] The date. All characters must be there, e.g.,
01/01/95 or 12/09/94.
[HHMM] The time in 24-hour notation. All characters must
be there, e.g., 0001 or 0945.
[Freq] One of: ONCE DAILY WEEKLY WEEKDAILY
[Pager] One of your configured pager names
"[Message]" The message to be paged out. This MUST be enclosed
in quotes and no quotes may be used in the message.
INTERIM Sends an interim billing statement to the Registered Account Holder.