Hypermedia HG-7000 User manual

Hypermedia HG-7000
Product Manual
3U and 6U SMS PRO Gateways

HMC Product Manual
Release 5.2: April 2011
Contact Information
2b, Professor Bergman St.,
Rabbin Science Park,
Rechovot, 76100,
Israel
Phone: [phone]
Fax: [phone]
For general inquiries: [email protected]
For sales inquiries: [email protected]
For Technical Support: [email protected]
Web site: http://www.hyperms.com/
Document Information
© January 2011 Hypermedia Systems, Ltd. All rights reserved.
No part of this document may be reproduced or transmitted in any form or
by any means, electronic or mechanical, for any purpose, without the
express written permission of Hypermedia, Inc. Under the law, repro-
ducing includes translating into another language or format.
Every effort has been made to ensure that the information in this manual
is accurate. Hypermedia, Inc. is not responsible for printing or clerical
errors. Information in this document is subject to change without notice.
Trademarks and Software Information
Hypermedia ® and the Hypermedia logo design are registered trade-
marks of Hypermedia, Inc. in the United States and various other coun-
tries. All other trademarks are the property of their respective owners.
Software Protection
As between the parties, Hypermedia Systems, Ltd. retains title to, and
ownership of, all proprietary rights with respect to the software contained
within its products. The software is protected by United States copyright
laws and international treaty provision. Therefore, you must treat the soft-
ware like any other copyrighted material (e.g. a book or sound recording).

HMC Product Manual
Release 5.2: April 2011
Hypermedia Systems Ltd. LICENSE AGREEMENT AND WARRANTY
IMPORTANT — READ CAREFULLY
This Hypermedia Systems Ltd. License Agreement (the "AGREEMENT") is a legal agreement between you (either
an individual or a single entity) and Hypermedia Systems Ltd. for the product accompanying this AGREEMENT.
The product includes computer software, associated media and printed materials, and may include "online" or elec-
tronic documentation (the "SOFTWARE"). The PRODUCT may also include hardware (the “HARDWARE”). The
SOFTWARE and the HARDWARE are referred to, collectively, as the PRODUCT.
BY INSTALLING AND/OR USING THE PRODUCT YOU AGREE TO BE BOUND BY THE TERMS OF THIS
AGREEMENT.
IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, PROMPTLY ERASE ALL COPIES OF THE
SOFTWARE IN YOUR POSSESSION, AND RETURN THE SOFTWARE AND ANY ACCOMPANYING HARD-
WARE TO THE PLACE FROM WHICH YOU OBTAINED IT.
COPYRIGHT.
All title and copyrights in and to the PRODUCT are owned by Hypermedia Systems Ltd. The PRODUCT is pro-
tected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties.
GRANT OF LICENSE FOR THE SOFTWARE.
The SOFTWARE is licensed, not sold. Hypermedia Systems Ltd. grants to you a non-exclusive, non-transferable,
royalty-free right to install and use the SOFTWARE, provided that the SOFTWARE will be used by a single person
on a single computer and for personal non-commercial, internal use only. If accompanied by a proof-of-purchase
document specifying "site license," "company license," or any other multiple-user type license scheme, then the
terms of that document shall override this single-user restriction. Any rights not expressly granted herein are
retained by Hypermedia Systems Ltd.
OTHER RESTRICTIONS.
This AGREEMENT is your proof of license to exercise the rights granted herein and must be retained by you. You
may not rent, lease, reverse engineer, decompile, modify, or disassemble the PRODUCT, or create derivative
works based on the PRODUCT.
LIMITED HARDWARE WARRANTY
The HARDWARE is protected against defects in material and workmanship, under normal use, for one (1) year
from the original purchase date.
If the HARDWARE fails to perform within the abovementioned warranty period, you must return the PRODUCT to
Hypermedia Systems Ltd. and prepay any shipping charges, export taxes, custom duties and taxes, or any
charges associated with transportation of the Product. In addition, you are responsible for insuring the PRODUCT
shipped or returned and assume the risk of loss during shipment.
All returned PRODUCTS must be accompanied by a description of the problem, a proof of the place and date of
purchase, and the original shipping and packing materials.
Hypermedia Systems Ltd. shall, at its sole discretion, either repair the PRODUCT or replace it with a product of the
same functionally. Replacement products may be refurbished or contain refurbished materials. If Hypermedia Sys-
tems Ltd. cannot repair or replace the PRODUCT, Hypermedia Systems Ltd. will refund the depreciated purchase
price of the PRODUCT.
This limited warranty does not apply to any PRODUCT not purchased from Hypermedia Systems Ltd., or from a
Hypermedia Systems Ltd. authorized reseller, or on which the serial number has been removed or defaced. This
limited warranty also does not cover any PRODUCT that has been damaged or rendered defective as a result of
(a) improper transportation or packing when returning the PRODUCT to Hypermedia Systems Ltd.; (b) use of the
PRODUCT other than in accordance with its instructions, or other misuse or abuse of the PRODUCT; (c) modifica-
tion of the PRODUCT; (d) service by anyone other than a Hypermedia Systems Ltd.-approved agent; (e) unusual
physical or electrical stress or interference, failure or fluctuation of electrical power, lightning, static electricity,
improper temperature or humidity, fire, or acts of God.

HMC Product Manual
Release 5.2: April 2011
The maximum liability of Hypermedia Systems Ltd. under this limited warranty is limited to the purchase price of the
PRODUCT covered by the warranty.
Hypermedia Systems Ltd. reserves the right to refuse PRODUCTS (i) that are not covered by the warranty; or (ii)
for which there is no problem found. Such PRODUCTS shall be returned to the purchaser at purchaser’s expense.
DISCLAIMER.
EXCEPT AS EXPRESSLY STATED ABOVE OR AS REQUIRED BY LAW, Hypermedia Systems Ltd. DISCLAIMS
ANY WARRANTY FOR THE PRODUCT. THE PRODUCT IS PROVIDED "AS IS" WITHOUT REPRESENTATION
OR WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THE
IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-
INFRINGEMENT. Hypermedia Systems Ltd. ASSUMES NO RISK ARISING OUT OF THE USE OR PERFOR-
MANCE OF THE PRODUCT.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES.
IN NO EVENT SHALL Hypermedia Systems Ltd., ITS AGENTS OR ITS SUPPLIERS BE LIABLE FOR ANY DAM-
AGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DIRECT, INDIRECT, SPECIAL OR OTHER CON-
SEQUENTIAL OR INCIDENTAL DAMAGES; DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING
DIRECTLY OR INDIRECTLY OUT OF THE USE OF OR INABILITY TO USE THE PRODUCT, EVEN IF Hyper-
media Systems Ltd. HAS BEEN ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH DAMAGES.
Because some states or jurisdictions do not allow the exclusion or limitation of liability for consequential or inci-
dental damages, the above limitation may not apply to you.
U.S. GOVERNMENT RESTRICTED RIGHTS.
For purchases made in the United States: The SOFTWARE and any accompanying documentation are provided
with restricted rights. Use, duplication or disclosure by the Government is subject to restrictions as set forth in sub-
paragraph (b) (3) and (c) (1) (ii) of The Rights in Technical Data and Computer Software clause at DFARS
252.227-7013 or subparagraphs (c) (1) and (2) of the Commercial Computer Software-Restricted Rights at 48 CFR
52.227-19, as applicable.
AMENDMENTS.
Hypermedia Systems Ltd. may amend these terms and conditions at any time by posting a notice on one or more
of its websites. Your continued use of the PRODUCT shall constitute your acceptance of such amended terms.
Accordingly, we urge you to visit our websites periodically to review the current and effective terms and conditions
for use of our products. Certain provisions of these terms and conditions may be superceded by expressly desig-
nated legal notices or terms outlined on our websites.
GOVERNING LAW.
This AGREEMENT and any and all claims relating to the PRODUCT shall be governed by the laws of the State of
Israel, without regard to or application of choice of law or principles, and the courts of Tel-Aviv Jaffa shall have sole
and exclusive jurisdiction over any dispute arising in connection with this Agreement and/or the use of the
PRODUCT.
NO WAIVER.
No delay or failure to take action under these terms and conditions will constitute a waiver by Hypermedia Systems
Ltd. unless expressly waived in writing by a duly authorized officer of Hypermedia Systems Ltd.

HMC Product Manual i
Release 5.2: April 2011
Table of Contents
Hardware and Installation............................................................................ 1
Overview ............................................................................................................................... 2
Contents of Package ...................................................................................................... 2
Safety Information................................................................................................................. 3
System Components.............................................................................................................. 4
Installation............................................................................................................................. 6
Pre-Installation Preparation ........................................................................................... 6
Inserting the SIM Cards................................................................................................. 7
Inserting the SanDisk Card............................................................................................ 9
Powering Up and LEDs....................................................................................................... 10
HMC Quick Start ........................................................................................ 11
Installation........................................................................................................................... 12
Setting the IP Address ......................................................................................................... 14
Start-up and Initial Connection ........................................................................................... 16
Save/Load Configuration .................................................................................................... 19
Configuring a Cellular Card ...................................................................... 21
Cellular Card and System Terminology.............................................................................. 22
Volume Settings .................................................................................................................. 23
Media Connections.............................................................................................................. 24
Associating/Linking Cellular Channels....................................................................... 24
Unlinking Cellular Allocations.................................................................................... 26

HMC Product Manual ii
Release 5.2: April 2011
PIN Codes ........................................................................................................................... 27
MSN Values ........................................................................................................................ 28
Reset .................................................................................................................................... 29
Information Screens ............................................................................................................ 30
Module Info ................................................................................................................. 30
Serial Numbers ............................................................................................................ 30
Locks ................................................................................................................................... 31
SIM Select ........................................................................................................................... 32
SIM Counters ...................................................................................................................... 33
SIM Auto Manage............................................................................................................... 34
Call Counter Steps............................................................................................................... 36
CLI Blocking....................................................................................................................... 37
Call Limits........................................................................................................................... 38
Cell Selection ...................................................................................................................... 39
Settings ................................................................................................................................ 41
Network Parameters ............................................................................................................ 42
USSD SIM Balance............................................................................................................. 43
Monitoring Cellular Cards .................................................................................................. 44
All Cells ....................................................................................................................... 44
Reception ..................................................................................................................... 45
Status............................................................................................................................ 46
SMS PRO Gateway ..................................................................................... 47
PCB and System Terminology............................................................................................ 48
Configuration ...................................................................................................................... 49
License ................................................................................................................................ 52
Channel Selection................................................................................................................ 53
Advanced Call Routing (ACR) ........................................................................................... 54

HMC Product Manual iii
Release 5.2: April 2011
ACR Rules ................................................................................................................... 54
Modifying the Existing ACR Number List ................................................................. 56
Creating a New ACR Number List File ...................................................................... 57
Counters .............................................................................................................................. 59
Enabling Counters ....................................................................................................... 59
Disabling Counters ...................................................................................................... 60
Slave Managers ................................................................................................................... 61
Adding a Slave Gateway to a Master Gateway ........................................................... 61
Configuring a Slave to Display its SIM Cards on the Master ..................................... 62
SMS CDRs .......................................................................................................................... 63
Deciphering the SMS CDR Files................................................................................. 63
CDR MySQL Support ................................................................................................. 65
Managing via the HMC............................................................................... 67
Scheduler............................................................................................................................. 68
Switch SIM per Slot..................................................................................................... 68
Switch SIM per System ............................................................................................... 70
Reset SIM Counter ...................................................................................................... 71
Set Multi SIM .............................................................................................................. 73
Manual Command ....................................................................................................... 75
Developer’s API ........................................................................................... 77
The SMS Server .................................................................................................................. 78
Auto-open an Info Web Page ...................................................................................... 78
Overview ............................................................................................................................. 79
Logging In ........................................................................................................................... 80
SIM Configuration .............................................................................................................. 81
Getting the Active SIM Configuration ........................................................................ 81
Setting the Active SIM Configuration......................................................................... 83

HMC Product Manual iv
Release 5.2: April 2011
Changing the Routing Group of an Active SIM.......................................................... 84
Receiving Notification of Configuration Changes ...................................................... 84
Sending an SMS .................................................................................................................. 85
Sending Bulk SMS .............................................................................................................. 90
Changing the Priority of Bulk Messages Already Sent............................................... 90
Deleting an Entire Bulk ............................................................................................... 91
Moving a Bulk or SMS Queued to the Master Queue................................................. 91
Removing a Bulk from the Master Queue................................................................... 91
Closing a Bulk Session ................................................................................................ 91
SMS Event Notifications..................................................................................................... 92
HTTP Notifications ............................................................................................................. 95
Queue Related Operations................................................................................................... 96
Retrieve Queue Status and Size................................................................................... 96
Deleting Queues........................................................................................................... 96
Pausing and Continuing the Gateway Operation ................................................................ 97
HTTP API ........................................................................................................................... 98
Sending an SMS Using HTTP..................................................................................... 98
HTTP API Responses .................................................................................................. 99
Error and Confirmation Codes .......................................................................................... 100
Index ........................................................................................................... 109

HMC Product Manual 1
Release 5.2: April 2011
Chapter 1
HARDWARE and INSTALLATION
Hardware and installation vary depending upon the features included with
the Hypermedia Gateway system. Skip the sections that do not apply to your
system.
This section includes:
• “Contents of Package” on page 2
• “Safety Information” on page 3
• “System Components” on page 4
• “Pre-Installation Preparation” on page 6
• “Inserting the SIM Cards” on page 7
• “Inserting the SanDisk Card” on page 9
• “Powering Up and LEDs” on page 10

HMC Product Manual 2Overview
Release 5.2: April 2011
Overview
Hypermedia's Messaging Solutions harness today’s cutting-edge technology in
order to provide instant communication product tools.
Corporate businesses and service providers can leverage their use of the SMS
Pro Gateway (HG-7000) infrastructure via its advanced set of API interfaces.
The SMS Pro Gateway also supports seamless integration of market standrds
such as SMPP, SMTP, and HTTP.
The SMS Pro Gateway infrastructure enables development of, or use of, other
3rd party SMS applications and services. Alternately, it enables customers to
utilize a wide range of Hypermedia's applications, such as:
• SMS Corporate (HG-7200)
• SMS Campaigner (HG-7300)
Contents of Package
Depending upon configuration, the package should contain some or all of the
following:
• The Hypermedia Gateway unit
• One SanDisk flash memory card
• Ethernet cables
• 1 or 2 power cords, depending upon the configuration
• 1 to 8 indoor antennas, depending upon the configuration
• 1 control cord
• The Hypermedia CD
• The warranty certificate

HMC Product Manual 3 Safety Information
Release 5.2: April 2011
Safety Information
Hypermedia Gateway works with a nominal mains supply voltage of 110–
240V AC. Hazardous voltages are present inside of this equipment. Some of
the parts can also have high operating temperatures.
To avoid injury and prevent equipment damage, observe the following safety
precautions:
• Installation, service, and maintenance of the Hypermedia Gateway should
be done by qualified technicians only.
• Do not connect the Hypermedia Gateway to any power source other than
the indicated nominal source.
• The power supply cord must be connected to a socket with a valid ground.
This equipment should only be used in buildings with proper safety
ground.
• When connecting the equipment, first, ensure that the ground connection
is connected to the rack ground or building ground.
• When disconnecting the equipment, disconnect the ground connection
last.
• Opening the housing may be dangerous and invalidates the warranty.
Only a qualified technician should open the housing. Before opening, dis-
connect the power cable from the equipment.
• The Hypermedia Gateway complies with all necessary safety standards.
Equipment connected to the Hypermedia Gateway must also comply with
the applicable safety standards.
• The packaging is designed to protect against mechanical damage and
should be stored. Do not ship equipment unless it is properly packed in its
original wrapping and shipping containers.
• Make sure that the equipment top and bottom are not blocked to air move-
ment. Leave 1U under and on top of the equipment for proper ventilation.
• Do not operate the Hypermedia Gateway in close proximity to potentially
hazardous areas. These includes areas such as, but not exclusively, fuel
stations, fuel depots, chemical works or during blasting.
• The operation of radio transmitters, which includes cellular engines, can
impair the function of medical devices that have not been properly
shielded. Please ask the advice of your doctor or the manufacturer of the
medical device.
• To avoid moisture condensation, allow time for the unit to adapt to the
ambient temperature before switching it on.

HMC Product Manual 4 System Components
Release 5.2: April 2011
System Components
The Hypermedia Gateway system consists of the components described below:
• The Hypermedia Gateway unit is a 19" x 6U or 19" x 3U rack-mountable
box that connects to the local PBX or network. The system enables any
combination of connectivity between its PRI, BRI, VoIP, and cellular
interfaces.
• The unit contains a back-plan and slots for the boards described in
Table 1, “Hypermedia Gateway Boards,” on page 5. Placement of the
boards varies according to product.
• The unit contains a single power supply module. A dual power supply
module is also available.
Figure 1: Boards within an SMS PRO Gateway
6U
HBN Board
CG Boards Power Supply
3U
HBN Board
CG Boards
Power
Supply

HMC Product Manual 5 System Components
Release 5.2: April 2011
• The Hypermedia Management Console (HMC) is used by the system
administrator for remote configuration and monitoring of the Hypermedia
Gateway system. It runs over TCP/IP and is accessed via a standard WEB
browser.
Table 1: Hypermedia Gateway Boards
Board Name Description
PC1/2
Control Board
The PC1/2 is a double-slot computer designed for use
by alternative carriers. It enables TCP/IP access and
supports the VoIP Gateway.
The PC1/2 runs the Hypermedia PRI Server for direct
remote access, and provides a SIP/H323 interface
when VoIP is implemented.
CG41/CC41
Cellular Gateway
CG41 for GSM and CC41 for CDMA is a single-slot
card that enables inbound and outbound cellular voice
calls for GSM and CDMA networks.
HBN
Hybrid Card
The HBN card is a single-slot card that enables flexi-
ble, pre-defined, and dynamic allocation of channels.
These cards can also support VoIP, PRI and dual PRI
functionality depending upon the system ordered.

HMC Product Manual 6 Installation
Release 5.2: April 2011
Installation
Installation varies depending upon the boards included with the Hypermedia
Gateway system. Skip the sections that do not apply to your system.
This section is subdivided into:
• “Pre-Installation Preparation” on page 6
• “Inserting the SIM Cards” on page 7
• “Powering Up and LEDs” on page 10
Pre-Installation Preparation
1. Install the Hypermedia Gateway in a 19” rack. Depending upon the phys-
ical configuration, the unit requires a height of either 3U or 6U. In addi-
tion, we recommend:
• Avoid installing the device near computer rooms, computer monitors,
electrical cabinets, metal objects, and windows with fold aluminum
sheet.
• Perform a cellular signal check before mounting the system. This can
be done by checking the Signal Strength and the Bit Error Rate ratio
on another mobile phone's display from the same operator and
system.
• Ensure that the device is protected against direct sunlight and heat.
This increases both the reliability of the operation as well as its
service life.
• The antennas are for indoor use only.
• The cables to the devices should be installed so that they do not cause
any physical risk. Power cables should be installed separate from the
signal cables.
2. Depending upon the configuration of your system, verify that you have
some or all of the following:
• an Ethernet or WAN socket with a fixed IP address
• a spare PRI card in your PBX
• SIM cards from your GSM operator. One SIM card is required for
each GSM channel
• in case of CDMA network, a MIN or NAM from your local operator
3. To configure the Router, get the following information from your Internet
Service Provider:

HMC Product Manual 7 Installation
Release 5.2: April 2011
• WAN IP Address
• Subnet Mask, and WAN Gateway
Inserting the SIM Cards
1. Insert the GSM SIM Cards. One SIM card should be used per each cellu-
lar channel.
Version 4.1 of the CG board does not have SIM drawers.
Instead, the SIM port (pictured to the right) is spring
loaded. Slide the SIM card into the slot and it will latch in
place. To remove a SIM card, press the SIM card and it
will pop out.
a. Push the small yellow button. This pushes SIM drawer out of the slot.
b. Remove the SIM drawer.
c. Place the SIM card in the SIM drawer.
d. Replace the SIM drawer.
Push small,
yellow button
to extract the
SIM drawer.
Insert the SIM
card into the
SIM drawer.

HMC Product Manual 8 Installation
Release 5.2: April 2011
e. Optionally, to use the CG board’s multi-SIM extender:
i. Pull out the CG board.
Figure 2: CG Card Multi-SIM Extender
ii. Slide back and pull up the SIM socket.
Warning
Do not use force on the SIM sockets.
iii. Slide in the SIM cards.
iv. Lock the SIM sockets.
2. Install the antennas. Each cellular card requires one antenna.
a. Locate the antenna socket ( ). The socket is above the SIM
drawers.
b. Fasten the antenna using the SMA connector. Do not use excess
force.
c. Tether all cables securely. Tethering helps prevents breakage of
connectors and damage to cellular cards.
Warning
The antennas are for indoor use only. The antennas will be irreversibly
damaged if placed outdoors.
d. Place the antenna indoors, where the reception level is high.
e. Optionally, to improve reception, place the magnetic back of the
antenna on a metal plate larger than 20 x 20 cm.
Multi-SIM
Extender

HMC Product Manual 9 Installation
Release 5.2: April 2011
Inserting the SanDisk Card
The Gateway saves Call Detail Records (CDRs) on a SanDisk (SD) flash
memory card that is supplied by Hypermedia. Insert the SD card into the SD
port in the HBD card.
Figure 3: SanDisk Card and Port
The SD port is spring-loaded. To remove the SD card, press it quickly. The
spring will push it out.
CDRs are displaced on a FIFO basis.

HMC Product Manual 10 Powering Up and LEDs
Release 5.2: April 2011
Powering Up and LEDs
1. Turn on the unit. The power panel is located at the top right corner of the
system.
Figure 4: Power Panel
Redundant power supplies are optional. When installed, if one fails, or if you
power up the system with just one power supply, an alarm will sound. To stop
the alarm, press the Alarm Reset button at the top left of the panel.
2. Check the LEDs. LED behavior is explained in the following tables:
Table 2: Cellular Card Green SIM LEDs
State Explanation
Flashing No SIM card. The channel does not contain
an installed SIM card.
LED is off No reception. The channel is not connected
to a cellular network.
Short blink Stand by. The channel is connected but there
is no call in progress.
Long blink Dialing out or receiving a call. User is either
dialing out or receiving a call in this channel.
Constantly on In use. A call is in progress.

HMC Product Manual 11
Release 5.2: April 2011
Chapter 2
HMC QUICK START
Use the Hypermedia Management Console (HMC) to configure and monitor a
Hypermedia Gateway from a remote location. Access to the Gateway is over
TCP/IP using a standard version of Internet Explorer.
The Hypermedia Management Console is customized to match the specific
order. Some branches of the HMC may or may not appear based upon the
customization.
This section includes:
• “Installation” on page 12
• “Setting the IP Address” on page 14
• “Start-up and Initial Connection” on page 16
• “Save/Load Configuration” on page 19

HMC Product Manual 12 Installation
Release 5.2: April 2011
Installation
To install the Hypermedia Management Console program:
1. Ensure that the computer matches the following minimum system require-
ments:
• Windows 2000, XP, or Vista
• Internet Explorer 6 or 7
2. Ensure that you have access to the installation file. It is included with the
Hypermedia Gateway CD-ROM.
Figure 5: Hypermedia Gateway CD-ROM
The installation file name begins with the letter HMC and ends with the
extension .exe. The specific name depends upon the type of installation.
3. Double-click the file HMCxxx-xxx.exe file. The Setup program starts.
Figure 6: Setup Welcome Screen
4. Click Next. The License Agreement is displayed.