Hypermedia HG-7000 User manual

Release 5.5 (March 2015)
Hypermedia HG-7000
Product Manual
3U and 6U SMS Pro Gateways

Hypermedia Systems
Hypermedia Systems Ltd.
ii
Hypermedia Systems Ltd.
2b, Professor Bergman St., Rabin Science Park,
Rehovot, 7670504, Israel
Telephone: [phone]
Fax: [phone]
For general inquiries: [email protected]
For sales inquiries: [email protected]
For Technical Support: [email protected]
Web site: http://www.hyperms.com/
PROPRIETARY AND CONFIDENTIAL
Copyright © 2013 by Hypermedia Systems Ltd. All rights reserved.
No part of this document may be reproduced, transmitted or copied in any form or by
any means- graphic, electronic, or mechanical, including photocopying, typing or
information retrieval systems- without the express written permission of Hypermedia
Systems Ltd.

Hypermedia Systems
Release 5.5 (March 2015)
iii

Hypermedia Systems
Hypermedia Systems Ltd.
iv
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 electronic 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
HARDWARE 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
protected 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
Systems 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)
modification 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.
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
Release 5.5 (March 2015)
v
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 NONINFRINGEMENT. Hypermedia Systems Ltd. ASSUMES NO RISK ARISING
OUT OF THE USE OR PERFORMANCE OF THE PRODUCT.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES
IN NO EVENT SHALL Hypermedia Systems Ltd., ITS AGENTS OR ITS SUPPLIERS BE LIABLE FOR ANY
DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DIRECT, INDIRECT, SPECIAL OR OTHER
CONSEQUENTIAL 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
Hypermedia 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
incidental 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
subparagraph (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 superseded by
expressly designated 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.

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
vi
Table of Contents
Before You Begin ..........................................................1
1Hardware and Installation ......................................2
1.1 Overview ....................................................................................3
1.1.1 Package Contents.........................................................................................3
1.2 Safety Information.....................................................................4
1.3 System Components.................................................................5
1.4 Typical Board Configurations...................................................6
1.4.1 3U Series ......................................................................................................6
1.4.2 6U Series ......................................................................................................7
1.5 Pre-Installation Preparations....................................................8
1.6 Cable Connections....................................................................9
1.6.1 Standard Gateway - Hybrid Based (HBN).....................................................9
1.6.2 Heavy-Duty Gateway –PC Based..............................................................10
1.7 Inserting the SIM Cards...........................................................11
1.7.1 Inserting the SD Card (Standard Gateway).................................................12
1.8 Powering Up and LEDs Status................................................13
1.8.1 Powering Up................................................................................................13
1.8.2 LEDs Status................................................................................................13
2HMC Quick Start ...................................................18
2.1 Installation................................................................................19
2.2 Setting the IP Address ............................................................21
2.3 Start-up and Initial Connecting...............................................23
2.4 Save and Backup/Restore Configuration Settings................26
2.4.1 Save All.......................................................................................................26
2.4.2 Store Settings on Cards..............................................................................26
2.4.3 Backup/Restore...........................................................................................26

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
vii
3Configuring a Cellular Card .................................27
3.1 Cellular Card and System Terminology.................................28
3.2 Media Connections..................................................................29
3.2.1 Associating/Linking Cellular Channels ........................................................29
3.2.2 Auto Linking ................................................................................................30
3.2.3 Unlinking Cellular Allocations......................................................................31
3.3 PIN Codes.................................................................................32
3.4 Reset.........................................................................................33
3.5 Information Screens................................................................35
3.5.1 Module Info .................................................................................................35
3.5.2 Serial Numbers ...........................................................................................35
3.6 Locks........................................................................................37
3.7 SIM Select.................................................................................38
3.8 Cell Selection...........................................................................40
3.9 Settings ....................................................................................42
3.10 Network Parameters................................................................43
3.11 USSD SIM Balance...................................................................44
3.12 Monitoring Cellular Cards.......................................................45
3.12.1 All Cells.......................................................................................................45
3.12.2 Reception....................................................................................................46
3.12.3 Status..........................................................................................................46
4Configuring the SMS Server ................................48
4.1 License.....................................................................................49
4.2 Configuration...........................................................................50
4.3 Channel Selection....................................................................62
4.4 SMS Sender..............................................................................63
4.5 Advanced Call Routing (ACR).................................................65
4.5.1 ACR Rules ..................................................................................................65
4.5.2 Modifying the ACR Number List..................................................................68

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
viii
4.5.3 Creating a New ACR Number List File........................................................68
4.6 Counters...................................................................................71
4.6.1 Enabling Counters.......................................................................................71
4.6.2 Disabling Counters......................................................................................72
4.7 Slaves Manager .......................................................................73
4.7.1 Adding a Slave Gateway to a Master Gateway...........................................73
4.7.2 Configuring a Slave to have its SIM Cards used by the Master ..................75
5Scheduler ..............................................................76
5.1 Scheduler Commands.............................................................77
5.1.1 Switch SIM per Slot.....................................................................................77
5.1.2 Switch SIM per System...............................................................................78
5.1.3 Reset SIM Counter......................................................................................80
5.1.4 Set Multi SIM...............................................................................................81
5.1.5 Manual Command.......................................................................................83
6Developer’s API ....................................................85
6.1 Overview ..................................................................................86
6.2 Logging In................................................................................87
6.3 SIM Configuration....................................................................89
6.3.1 Getting the Active SIM Configuration...........................................................89
6.3.2 Setting the Active SIM Configuration...........................................................91
6.3.3 Changing the Routing Group of an Active SIM ............................................92
6.3.4 Receiving Notification of Configuration Changes.........................................93
6.4 Sending an SMS.......................................................................94
6.5 Sending Bulk SMS.................................................................103
6.5.1 Changing the Priority of Bulk Messages Already Sent...............................103
6.5.2 Deleting an Entire Bulk..............................................................................104
6.5.3 Moving a Bulk or SMS Queued to the Master Queue................................104
6.5.4 Removing a Bulk from the Master Queue..................................................104
6.5.5 Closing a Bulk Session..............................................................................104
6.6 SMS Event Notifications........................................................105

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
ix
6.7 HTTP Notifications.................................................................108
6.7.1 HTTP GET variables for Incoming SMS....................................................108
6.7.2 HTTP GET variables for Outgoing SMS....................................................108
6.8 Queue Related Operations....................................................109
6.8.1 Retrieve Queue Status and Size................................................................109
6.8.2 Deleting Queues........................................................................................110
6.9 Pausing and Continuing the Gateway Operation................111
6.10 HTTP API................................................................................112
6.10.1 Sending an SMS Using HTTP ...................................................................112
6.10.2 HTTPAPI Responses................................................................................114
6.11 CDR Support..........................................................................115
6.11.1 CDR Files..................................................................................................115
6.11.2 CDR MySQL Support................................................................................117
6.12 Error and Confirmation Codes..............................................118
7Troubleshooting..................................................126

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
x
This page is intentionally blank

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
1
Before You Begin
Conventions
The following symbols have been inserted on the left hand side of the
operating instructions in order to make it easier for the User to perform
procedures:
Symbol
Description
Note:
Information given in a note describes how the System
functions or provides a tip on how best to use it.
Caution:
Information given in a message labeled ―caution‖ refers to
the safe operation of the System and provides warnings
where the possibility for loss of data or damage to the
equipment exists.
Danger:
Information given in a message labeled ―danger‖ warns of
possible hazard to personnel and extreme hazard to the
System.
Notice
Information given in this document is subject to change without any notice.

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
2
1 Hardware and Installation
Note: 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 contains:
Package Contents (section 1.1.1)
Safety Information (section 1.2)
System Components (section 1.3)
Typical Board Configurations (see 1.4)
Pre-Installation Preparations (section 1.5)
Cable Connections (section 1.6)
Inserting the SIM Cards (section 1.7)
Powering Up and LEDs Status (section 1.8)

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
3
1.1 Overview
Hypermedia Gateways provide integrated voice and SMS communications for
both on-site and remote users of small-to-large enterprises.
The Hypermedia HG-7000 SMS Pro Gateway is part of the HyperGateway
family of flexible, scalable platforms which empower cost-effective corporate
telephony over fixed, cellular and IP networks.
The HG-7000 Pro SMS gateway enables sending text-messages via SMS,
two-way SMS texting, SMS to email, PC to SMS, and reception of text
messages via SMS. It is supplied with a built-in SMS server software package
and easy-to-use client API tools, which enable third-party applications to send
and receive SMS messages. Additional applications are also available.
1.1.1 Package Contents
Depending upon configuration, the package should contain some or all of the
following:
The Hypermedia Gateway unit
Ethernet cables
1 or 2 power cords, depending upon the configuration
1 to 8 indoor antennas, depending upon the configuration
Hypermedia Software CD-ROM
The warranty certificate
1 SD card (standard gateway)

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
4
1.2 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,
disconnect 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
movement. 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.

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
5
1.3 System Components
The Hypermedia Gateway unit is a 19" × 6U or 19" × 3U rack-mountable box
that connects to the local network. The HG-7000 Gateway comes in two main
series.
Standard: designed for the enterprise user; based on an embedded CPU.
Heavy-Duty: designed for high volumes of SMSs; based on a PC board.
The Hypermedia system contains the following:
A single power supply module. A dual power supply module is also
available.
A backplane with slots for the boards. The position of the boards varies
according to the product series.
The Hypermedia Server, which is an application that is embedded on the
HBN or on the PC1/2 board (depending upon system configuration).
The Hypermedia Server is controlled and managed by the browser-based
Hypermedia Management Console.
The Hypermedia Management Console (HMC), which is used by the
system administrator for remote configuration and monitoring of the
Hypermedia Gateway system. It connects to the gateway using TCP/IP
and is accessed via a standard WEB browser.

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
6
1.4 Typical Board Configurations
The placement of the HG-7000 boards varies according to the product series.
The names and function of the boards are described in the following table.
Table 1. HG-7000 Boards and Function
Board Name
Description
Standard Gateway Board
HBN
This Hybrid board provides the gateway management
function as well as the SMS server functionality.
Heavy-Duty Gateway Boards
PC1/PC2
The PC board runs the HyperGateway server along
with an MG 2.1 board.
MG 2.1
This board provides the media matrix functionality.
Cross-Gateway Boards
CG41/CC41/CU41
CG41 for GSM, CC41 for CDMA and CU41 for UMTS
is a single-slot board that contains four (4) cellular
channels with inbound and outbound SMS capabilities
for the various cellular networks.
S-HUB
This board provides SIM server connectivity.
1.4.1 3U Series
The following Figure 1 shows the 3U SMS Gateway supporting up to 12 ports
with API
Figure 1. 3U SMS Gateway
HBN Board
CG Boards
Power Supply
3U

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
7
1.4.2 6U Series
The following Figure 2 shows the 6U SMS Gateway, supporting up to 32 ports
Figure 2. 6U SMS Gateway, 32 ports
Power Supply
CG Boards
HBN Board
6U
Router Board

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
8
1.5 Pre-Installation Preparations
Note: The installation procedure depends on the boards included with the Hypermedia
Gateway system. Skip the sections that do not apply to your system.
1. Install the Hypermedia Gateway in a 19‖ rack. Depending upon the
physical configuration, the unit requires a height of either 3U or 6U. In
addition, 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 the device is protected against direct sunlight and heat. This
increases both the reliability of the operation as well as its service life.
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
SIM cards from your GSM operator. One SIM card is required for each
GSM channel
Notes:
The default LAN IP address for Hybrid-Based Gateways is 192.168.9.2
The default LAN IP address for PC - Based Gateways is 192.168.0.2

Hypermedia Systems
Hardware and Installation
Release 5.5 (March 2015)
9
1.6 Cable Connections
There are two types of configurations:
Standard Gateway –Hybrid based (HBN)
Heavy-Duty Gateway –PC Based
1.6.1 Standard Gateway - Hybrid Based (HBN)
Figure 3. HG7000 - HBN Connection Settings

Hypermedia Systems
Hardware and Installation
Hypermedia Systems Ltd.
10
1.6.2 Heavy-Duty Gateway –PC Based
Figure 4. HG-7000 –PC Connection Settings
Note: 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.