Page 1 Hypermedia HG-7000 Product Manual 3U and 6U SMS Pro Gateways Release 5.5 (March 2015)
Page 2 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.
Page 3 Hypermedia Systems Release 5.5 (March 2015)
Page 4 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.
Page 5 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.
Page 6: Table Of Contents
Installation ................19 Setting the IP Address ............21 Start-up and Initial Connecting ..........23 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 Ltd.
Page 7 Hypermedia Systems Hardware and Installation Configuring a Cellular Card ......... 27 Cellular Card and System Terminology ......... 28 Media Connections ..............29 3.2.1 Associating/Linking Cellular Channels ............29 3.2.2 Auto Linking ....................30 3.2.3 Unlinking Cellular Allocations ..............31 PIN Codes ................. 32 Reset ..................
Page 8 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 SMS Event Notifications ............105 Hypermedia Systems Ltd. viii...
Page 9 Hypermedia Systems Hardware and Installation HTTP Notifications ..............108 6.7.1 HTTP GET variables for Incoming SMS ............ 108 6.7.2 HTTP GET variables for Outgoing SMS ............ 108 Queue Related Operations ............ 109 6.8.1 Retrieve Queue Status and Size ..............109 6.8.2...
Page 10 Hypermedia Systems Hardware and Installation This page is intentionally blank Hypermedia Systems Ltd.
Page 11: Before You Begin
Hypermedia Systems Hardware and Installation 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.
Page 12: Hardware And Installation
Hardware and Installation 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)
Page 13: 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.
Page 14: Safety Information
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.
Page 15: System Components
Hypermedia Systems Hardware and Installation 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.
Page 16: Typical Board Configurations
Hypermedia Systems Hardware and Installation 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...
Page 17: Series
Hypermedia Systems Hardware and Installation 1.4.2 6U Series The following Figure 2 shows the 6U SMS Gateway, supporting up to 32 ports CG Boards Router Board Power Supply HBN Board Figure 2. 6U SMS Gateway, 32 ports Release 5.5 (March 2015)
Page 18: Pre-Installation Preparations
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: ...
Page 19: Cable Connections
Hypermedia Systems Hardware and Installation 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...
Page 20: Heavy-Duty Gateway - Pc Based
Hypermedia Systems Hardware and Installation 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.
Page 21: Inserting The Sim Cards
Hypermedia Systems Hardware and Installation 1.7 Inserting the SIM Cards 1. Insert the GSM SIM Cards. One SIM card should be used per each cellular channel. The SIM port is spring loaded. Slide the SIM card into the slot and it will latch in place.
Page 22: Inserting The Sd Card (Standard Gateway)
1.7.1 Inserting the SD Card (Standard Gateway) The Gateway saves Call Detail Records (CDRs) on a Secure Digital (SD) flash memory card that is supplied by Hypermedia. Insert the SD card into the SD port of the HBN card. Figure 6. SD Card and Port Note: CDRs are displaced on a FIFO basis.
Page 23: Powering Up And Leds Status
For PC Board status LEDs, see Table 3  For MG Board Status LEDs, see Table 4  For Cellular Card Green SIM LEDs, see Table 5 1.8.2 LEDs Status Following are explanations of LED behavior for each of the Hypermedia Gateway’s cards. Release 5.5 (March 2015)
Page 24 Green LAN Connection Red LED - ERR Blinking Board Error Yellow LED - RDY Power is OFF Short Blink Board Ready Fast Blink Maintenance mode Green LED - RX Internal Communication Yellow LED - TX Internal Communication Hypermedia Systems Ltd.
Page 25 Hypermedia Systems Hardware and Installation Table 3. PC Board status LEDs State Explanation LAN 1 Yellow LAN Traffic Green LAN Connection LAN 2 Yellow LAN Traffic Green LAN Connection Red LED - ERR Blinking Board Error Yellow LED - Power is OFF...
Page 26 Table 4. MG 2.1 Board Status LEDs State Explanation Red LED - ERR Blinking Board Error Yellow LED - RDY Power is OFF Short Blink Board Ready Fast Blink Maintenance mode Green LED - RX Internal Communication Yellow LD - TX Internal Communication Hypermedia Systems Ltd.
Page 27 Hypermedia Systems Hardware and Installation Table 5. Cellular Card LEDs Status State Explanation Red LED Board Error Yellow LED Short blink Board Ready SIM Cards - Green LED Flashing A SIM card is not installed in this channel or the port is still being initialized.
Page 28: Hmc Quick Start
HMC Quick Start 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. Note: The Hypermedia Management Console is customized to match the specific order.
Page 29: Installation
Hypermedia Systems HMC Quick Start 2.1 Installation To install the Hypermedia Management Console program: 1. Ensure that the computer matches the following minimum system requirements:  Windows XP, Vista, Windows 7 or 8  Internet Explorer 7 or above 2. Ensure that you have access to the installation file. It is included with the Hypermedia Gateway CD-ROM.
Page 30 . The Select Start Next Menu Folder is displayed. 7. Define the name of the program group that will be added to the Start Menu. The default name is Hypermedia. Click . The Additional Tasks Next window is displayed. 8. Optionally, select the checkbox to create a Desktop shortcut. Click Next The ―Ready to Install‖...
Page 31: Setting The Ip Address
Hypermedia Systems HMC Quick Start 2.2 Setting the IP Address To change or set the IP address: 1. From the Hypermedia program group, select . The Hyper- Server List Gateway Servers Address List screen opens in the default browser. 2. If required, click the warning bar at the top of the screen and from the dropdown menu click .
Page 32 Setting the IP address through this page will permanently affect the Gateway IP address settings once rebooted. 8. Click . Focus is returned to the HGS Setup Parameters Screen. Update 9. From the HGS Server line, click . A confirmation message indicates Start that the service started successfully. Hypermedia Systems Ltd.
Page 33: Start-Up And Initial Connecting
Hypermedia Systems HMC Quick Start 2.3 Start-up and Initial Connecting To run the Hypermedia Management Console: 1. Click the Windows button . The Start > Programs > Hypermedia Hypermedia program group expands. 2. Click . The program opens in the default Hypermedia Management Console browser.
Page 34 Figure 19. HMC Login Authorization Request Note: admin The default password is 6. Enter the password and click . A confirmation message is Submit displayed, indicating you have successfully connected to the Hypermedia. The Connection State screen is displayed. Hypermedia Systems Ltd.
Page 35 Hypermedia Systems HMC Quick Start Figure 20. HMC Connection State Display A list of all services is displayed, including their versions and current activation/installation state. Release 5.5 (March 2015)
Page 36: Save And Backup/Restore Configuration Settings
HyperGateway 2.4.2 Store Settings on Cards Use this option to permanently save all the configuration settings in the Hypermedia Gateway. This process might take up to 60 seconds. Figure 21. Save All Settings configuration branch 2.4.3 Backup/Restore Use this option to download the entire configuration of the Gateway to your PC.
Page 37: Configuring A Cellular Card
Hypermedia Systems Configuring a Cellular Card 3 Configuring a Cellular Card This section contains:  ‎ Cellular Card and System Terminology (section 3 .1)  ‎ Media Connections (section 3 .2)  ‎ PIN Codes (section 3 .3)  ‎...
Page 38: Cellular Card And System Terminology
3.1 Cellular Card and System Terminology A cellular card has 4 modules, each of which can have 1 to 4 SIM holders. Therefore, each card can hold up to 16 SIM cards. The Hypermedia Gateway can include several cards. The first SIM cards of each module are loaded into the spring-loaded SIM ports from the front of the Cellular Card.
Page 39: Media Connections
Hypermedia Systems Configuring a Cellular Card 3.2 Media Connections Use the Media Connection screen to configure the connections from the Cellular card channels to other cards and channels of the system, including the PRI cards (E.1) and the VoIP cards (MG). Connections can be either static or dynamic, as in the case of LCR.
Page 40: Auto Linking
Enables associating all channels of one media card to another media card. To create an auto-link: 1. From the Cellular Cards branch of the HMC navigation pane, click the sub-branch. The Media Matrix is displayed. Media Connections Hypermedia Systems Ltd.
Page 41: Unlinking Cellular Allocations
Hypermedia Systems Configuring a Cellular Card Figure 27. Auto Media connecting 2. If more than one slot is displayed, select a specific cellular card. The Media Matrix of that cellular card is displayed. 3. Click within a channel row. The row turns yellow.
Page 42: Pin Codes
2. If more than one slot is displayed, select a specific Cellular Card. The PIN Codes screen of that cellular card is displayed. 3. Enter the PIN code into the associated Module’s field. and wait for ―Configuration Saved‖ to be displayed. 4. Click Apply Settings Hypermedia Systems Ltd.
Page 43: Reset
Hypermedia Systems Configuring a Cellular Card 3.4 Reset Use the Cellular Card Reset screen to reset either the entire cellular card or a specific cellular module. To reset a cellular card or module: 1. From the Cellular Cards branch of the HMC navigation pane, click the sub-branch.
Page 44 Hypermedia Systems Configuring a Cellular Card Figure 31. Reset screen after sending the Reset command Hypermedia Systems Ltd.
Page 45: Information Screens
Hypermedia Systems Configuring a Cellular Card 3.5 Information Screens Several HMC screens display information. 3.5.1 Module Info Use the Module Info screen to review information about the modules of a cellular card. 1. From the Cellular Cards branch of HMC navigation pane, click the Module sub-branch.
Page 46 Hypermedia Systems Configuring a Cellular Card Figure 33. HMC Serial Numbers Screen 2. If more than one slot is displayed, select a specific Cellular Card. Hypermedia Systems Ltd.
Page 47: Locks
Hypermedia Systems Configuring a Cellular Card 3.6 Locks Use Locks to restrict access to specific GSM operators and/or a specific SIM card. When a lock is defined, the Gateway will only accept calls from an operator or a SIM card that matches the Lock number.
Page 48: Sim Select
2. If more than one slot is displayed, select a specific Cellular Card. The SIM Select screen of that cellular card is displayed. 3. Select an application option: Module Settings Applies the SIM configuration to the specific module. Hypermedia Systems Ltd.
Page 49 Hypermedia Systems Configuring a Cellular Card Entire Card Applies the SIM configuration to all the modules on the card. Figure 36. HMC SIM Select Screen – selection for entire card Entire System Applies the SIM configuration to all the cards in the system.
Page 50: Cell Selection
3. From the Select module dropdown box, select a module. This is the module that the Camp selection will be applied to. 4. In one of the CellID boxes, click . The screen indicates Camp Cell Camp and new controls are displayed at the top of the screen. Hypermedia Systems Ltd.
Page 51 Hypermedia Systems Configuring a Cellular Card Figure 38. HMC Cellular Cell Selection with Options Screen 5. Optionally, to camp all the card’s modules on the same cell, click Camp all modules on Release 5.5 (March 2015)
Page 52: Settings
Figure 39. HMC Cellular Card Settings Screen 2. If more than one slot is displayed, select a specific Cellular Card. The Cellular Card Settings screen of that cellular card is displayed. 3. Click and wait for Configuration Saved to be displayed. Apply Settings Hypermedia Systems Ltd.
Page 53: Network Parameters
Hypermedia Systems Configuring a Cellular Card 3.10 Network Parameters Use the Network Parameters screen to define the bandwidth used by a carrier. 1. From the Cellular Cards branch of the HMC navigation pane, click the sub-branch. The Cellular Card Network Parameters Network Parameters screen is displayed.
Page 54: Ussd Sim Balance
Balance checking USSD string 4. Enter the Recharging USSD string 5. Select or clear the checkbox. When selected, the Hypermedia Check All Management Console will check the balance of all the SIM cards. 6. Click (Check Balance). The balance is displayed in the USSD Reply column.
Page 55: Monitoring Cellular Cards
3.12 Monitoring Cellular Cards To monitor the status of cellular cards, open the Monitor > Cellular branch of the Hypermedia Management Console. There are three views. 3.12.1 All Cells To view information about all the cellular modules on all the cards, expand the Monitor >...
Page 56: Reception
(see more details in above ‎ section 3 .12.1). 3.12.3 Status To view information about the status of SIM slots on a specific cellular module: 1. Expand the Monitor > Cellular Cards sub-branch and select Status Hypermedia Systems Ltd.
Page 57 Hypermedia Systems Configuring a Cellular Card 2. Select a specific slot. The Cellular Cards Status screen for that card is displayed. Figure 44. Cellular Cards Status Screen 3. Review the status. Common possibilities include:  Module doesn’t exist or is faulty ...
Page 58: Configuring The Sms Server
‎ ‎ Channel Selection (section 4 .3)  ‎ SMS Sender (section 4 .4)  ‎ Advanced Call Routing (ACR) (section 4 .5)  ‎ ‎ Counters (section 4 .6)  ‎ Slaves Manager (section 4 .7) Hypermedia Systems Ltd.
Page 59: License
Use the License screen to upload and apply the license of the SMS Server. To license the SMS server: 1. Ensure you have an authorized license. Licenses are delivered via email from Hypermedia Technical Support. For assistance, contact Technical Support. 2. From the SMS Server branch of the HMC navigation pane, click the sub-branch.
Page 60: Configuration
Sets the status of the SMS Gateway. The actual state of the SMS Gateway is displayed below the selection box, and can have one of three values:  Running: In this state the Gateway will process and send SMS requests. Hypermedia Systems Ltd.
Page 61 Hypermedia Systems Configuring the SMS Server  Paused: In this state the Gateway will not send out SMS's. Any new send requests will be queued and sent only when the 'Running' state is resumed.  Disconnected: Indicates the Gateway service is down.
Page 62 Allows receiving incoming SMS messages on any of the available SIM cards (set by counter), by mapping each of the SIMs during off-peak time for a short predefined time period.  Start Time: time of day (hours) at which this feature should be activated. Hypermedia Systems Ltd.
Page 63 Hypermedia Systems Configuring the SMS Server  Timeout for first SMS: the amount of time (in seconds) to wait for an incoming SMS once a SIM has been registered to the network using this feature.  Timeout for additional SMS: the amount of time (in seconds) to wait for additional messages after at least one incoming message was received.
Page 64 Set the URL that will be notified whenever an SMS is sent or received. The message content, including additional parameters, is sent in an HTTP GET Developer’s API request (the parameter names are specified in the chapter). Hypermedia Systems Ltd.
Page 65 Hypermedia Systems Configuring the SMS Server E-mail notifications from SMS Gateway  Server: The SMTP server through which the e-mail notification will be sent. Note: TLS is only supported on PC-based systems.  Port: The SMTP server port (usually 25).
Page 66 Password: The password for above account.  Identification period: When replying by SMS to an email received by SMS without explicitly specifying the target recipient code in the SMS body, the system attempts to deduce the intended e-mail recipient by Hypermedia Systems Ltd.
Page 67 Hypermedia Systems Configuring the SMS Server the mobile number of the replier. This identification period defines how long (in hours) the system should associate this number with an intended recipient. Note that this method is not fail safe, and in most cases it is recommended to leave this value as zero, which disables it.
Page 68 Orig-User: According to Binding port group and Message Tagging rules.  User Data: For incoming SMS send the User Data in (GSM to SMPP): message_payload: Enabling data larger than 254 octets. short_message: Requiring all messages be shorter than 255 octets. Hypermedia Systems Ltd.
Page 69 Hypermedia Systems Configuring the SMS Server  Log Level Only use values other than Error when in a session with Technical Support. Binding port group to sender Groups of ports may be bound to the identity of the message sender (client or username).
Page 70 Note that this feature is not fail safe, and in most cases it is recommended to leave it disabled (value set to zero). Hypermedia Systems Ltd.
Page 71 Hypermedia Systems Configuring the SMS Server  Outbound SMS validity: The duration (in days) during which outbound messages are stored for statistical calculation purposes. Note: This feature is not yet functional when binding port groups to user_name. SIM reply timeout (in seconds) Number of seconds to wait for a reply from the SIM before failing.
Page 72: Channel Selection
. There are two options: Group  Click to create a new Group, and enter the Group name in the field.  Click to select an existing Group, and select a Group from the Select dropdown list. 6. Click Apply Settings Hypermedia Systems Ltd.
Page 73: Sms Sender
Hypermedia Systems Configuring the SMS Server 4.4 SMS Sender Use the SMS Sender screen to make online SMS tests with any of the SIMs preconfigured for use with the SMS Server. The ―Outgoing Message‖ section allows sending a message through any of the predefined SIMs to any phone number.
Page 74 Hypermedia Systems Configuring the SMS Server Figure 49. SMS Sender Screen Hypermedia Systems Ltd.
Page 75: Advanced Call Routing (Acr)
Hypermedia Systems Configuring the SMS Server 4.5 Advanced Call Routing (ACR) Use the ACR to define special actions to be performed on a Number List. For example, white lists and black lists. The ACR enhances the SMS server’s capabilities such that rules may be applied for outbound SMS messages in a similar manner to outbound calls on voice-enabled systems.
Page 76 Ends With The rule checks if the Destination number ends with specific digits or with a tag that appears on the list. In Range The rule checks if the Destination number is within a specific range. Hypermedia Systems Ltd.
Page 77 Hypermedia Systems Configuring the SMS Server Identical to The rule checks if the Destination number is exactly the specific digits or tag that appears on the list. Operator is To be used in conjunction with the Local Number Portability (LNP) application which looks up the destination number in a pre-loaded database of numbers and the cellular operator these were ported to.
Page 78: Modifying The Acr Number List
1. Create a file in a text-editor, such as Notepad, with the extension .csv. 2. Enter the words as the first row of the list. tag,number In following step 3, the term ―list‖ indicates all entries that share the same tag. Note: Hypermedia Systems Ltd.
Page 79: Release 5.5 (March
Hypermedia Systems Configuring the SMS Server 3. Add a tag and number, with a comma between them, to each entry. Ensure a comma separates the tag from the number. Following is an example of five lists: tag,number XYZ,0774445004 XYZ,0509080704 XYZ,0523030303...
Page 80 : The old .csv file is replaced by the new file. Overwrite  : The entries on the new .csv file are added to the old .csv file. Append 8. Click . The report of total lists and total numbers is updated. Import Hypermedia Systems Ltd.
Page 81: Counters
Hypermedia Systems Configuring the SMS Server 4.6 Counters Use SMS Counters to allocate the use of SIM cards. 4.6.1 Enabling Counters 1. Ensure that on the Channel Selection screen the module is SMS enabled (see ―Channel Selection‖ in section ‎...
Page 82: Disabling Counters
1. Ensure that on the Channel Selection screen the module is SMS disabled (see ―Channel Selection‖ in section ‎ 4 .3). 2. Select the checkbox. Delete 3. Click . The row is deleted from the Counters screen. Update Configuration Hypermedia Systems Ltd.
Page 83: Slaves Manager
Hypermedia Systems Configuring the SMS Server 4.7 Slaves Manager In a network of multiple SMS PRO Gateways, one Gateway can be defined as the Master. Slave Gateways are entered on the Master Gateway’s Slave Manager page. It is neither required nor possible to define the Master Gateway from the Slave Gateway.
Page 84 IP address used to access the HyperGateway Server. SMS Port The default port is 63333. SMS Password Enter the password that will enable access to the SMS application, as configured on the Slave system. Hypermedia Systems Ltd.
Page 85: Configuring A Slave To Have Its Sim Cards Used By The Master
Hypermedia Systems Configuring the SMS Server 4. Click . Focus returns to the Slave Manager screen and the new Slave is displayed in the list. 4.7.2 Configuring a Slave to have its SIM Cards used by the Master Once a Slave Gateway has been successfully added to the master (see...
Page 86: Scheduler
Use the Task Scheduler to configure the Gateway to repeat commands at scheduled intervals. Several commands are preconfigured. In addition, it is possible to manually configure a command. Figure 59. Dropdown Menu of Tasks and Table of Scheduled Tasks Hypermedia Systems Ltd.
Page 87: Scheduler Commands
Hypermedia Systems Scheduler 5.1 Scheduler Commands 5.1.1 Switch SIM per Slot Use the Switch SIM per Slot task to configure a GSM slot to use specific SIM cards for a defined period of time. 1. From the HMC navigation pane, expand the branch.
Page 88: Switch Sim Per System
1. From the HMC navigation pane, expand the branch. Manage 2. Click the Scheduler sub-branch. The Task Scheduler screen is displayed. 3. From the dropdown menu, select Add New Command Switch SIM per . The Task Scheduler automatically advances to the next screen. System Hypermedia Systems Ltd.
Page 89 Hypermedia Systems Scheduler Figure 62. Task Scheduler Switch SIM per System Screen 4. From the Set Active SIM per System dropdown menu, select the SIM card that the entire system will use. 5. Click . The Set Command screen, with the command syntax, is Next displayed.
Page 90: Reset Sim Counter
From the module’s SIM dropdown menu, select the SIM card for which the count will be reset. Select All to reset the count on all of the module’s SIM cards. Note: 5. Click . The Set Command screen, with the command syntax, is Next displayed. Hypermedia Systems Ltd.
Page 91: Set Multi Sim
Hypermedia Systems Scheduler Figure 65. Task Scheduler Set Command Screen Caution: Clicking menu deletes the new task. The table of schedules tasks is redisplayed. 6. Configure the task’s schedule: Click (calendar icon). A calendar opens in a new browser tab.
Page 92 Lock Period Enter an amount of time measured in minutes after which the SIM cards can no longer be used to place calls. 5. Click . The Set Command screen, with the command syntax, is Next displayed. Hypermedia Systems Ltd.
Page 93: Manual Command
Hypermedia Systems Scheduler Figure 67. Task Scheduler Set Command Screen Caution: Clicking menu deletes the new task. The table of schedules tasks is redisplayed. 6. Configure the task’s schedule: Click (calendar icon). A calendar opens in a new browser tab.
Page 94 Start Time field. Enter the command. For help with command syntax, contact Hypermedia technical support. From the Repeat drop-down menu, select either Yes or No. If the task is configured to repeat, select a .
Page 95: Developer's Api
Hypermedia Systems Developer’s API 6 Developer’s API This section defines the API for the Hypermedia SMS PRO Gateway. The API is designed to enable development of third party applications that wish to utilize the Hypermedia SMS PRO Gateway. Use the developer’s API to control the SMS server and send and receive SMS messages using commands over a TCP connection.
Page 96: Overview
SMS PRO Gateway API from any programming language.  Termination of Lines Every line sent to the server should be terminated with a CR LF. All replies and events received from the SMS PRO Gateway are also terminated by a CR LF pair. Hypermedia Systems Ltd.
Page 97: Logging In
Replace the value for the server_password field with the password assigned to the gateway via server_password the SMS server’s configuration page of the Hypermedia Management Console. Set the client_id field value to an ID that will identify your session. This ID enables you to client_id...
Page 98 ID. Note that if no ID is given, a unique ID will be generated for the client by the Gateway.  For each JSON line sent to the server, any unrecognized fields are returned in the reply with their values. Hypermedia Systems Ltd.
Page 99: Sim Configuration
Hypermedia Systems Developer’s API 6.3 SIM Configuration This section describes available SIM configuration methods. 6.3.1 Getting the Active SIM Configuration The SIM configuration can indicate a single, local connection between one HGS system and the SMS PRO Gateway to which it is connected. In addition, the SMS PRO Gateway can also connect to multiple HGS systems.
Page 100 SIM is located. On the master SMS PRO Gateway, this will always be master_sys. The name assignment of a slave system (slave_2 in the above example) is done using the HMC user interface of the master SMS Hypermedia Systems Ltd.
Page 101: Setting The Active Sim Configuration
Hypermedia Systems Developer’s API PRO gateway. This enables assigning an IP of a slave SMS PRO Gateway with a unique system name. 6.3.2 Setting the Active SIM Configuration Using the set_sim_config method it is possible to add or remove SIM cards to the pool of available SIMs and also assign groups to SIM ports.
Page 102: Changing The Routing Group Of An Active Sim
SMS group parameter (and not through SIM channels that have not been assigned a group name) the recommended method is to assign the group name to all the SIM channels that have no group sms_gen assigned to them. Hypermedia Systems Ltd.
Page 103: Receiving Notification Of Configuration Changes
Hypermedia Systems Developer’s API 6.3.4 Receiving Notification of Configuration Changes To receive notification each time the active SIM configuration changes, issue the following command: {"method":"register_for_config_change"} And the gateway will respond with: {"reply": "ok", "method_reply": "register_for_config_change"} Once this is done, each time a SIM is added or removed from the SIM pool, the SMS PRO Gateway will send the following notification: {"notification": "config_change"}...
Page 104: Sending An Sms
SMS. The following table displays and defines the fields given in the above example. Table 7: Fields for Sending an SMS Field Name Field Meaning number Mandatory. The destination number to which the SMS should be sent. Hypermedia Systems Ltd.
Page 105 Hypermedia Systems Developer’s API Field Name Field Meaning Mandatory. The message itself, in one of several encoding methods, depending on the value of the parameter unicode (below). Mandatory. Defines the message format. Can be one of the following values: unicode is a hexadecimal representation of a GSM03.38-...
Page 106 SMS could be sent via those cards. Since the priority algorithm prefers time to deliver over economy, take great care when sending an SMS with a priority if there are multiple groups in the system. Hypermedia Systems Ltd.
Page 107 Hypermedia Systems Developer’s API Field Name Field Meaning There are two queue types used by the SMS PRO Gateway: the regular queue and the master queue. The master queue is queue_type meant for circumventing the regular queue if there are urgent SMS requests or bulks to be sent.
Page 108 A detailed list of confirmation codes is available in Table 15, ―Confirmation Codes‖. If the reply was either ―ok‖ or ―error‖, a field named ―retry_num‖ will contain the number of attempts made until this result was achieved. number The requested destination number. Hypermedia Systems Ltd.
Page 109 Hypermedia Systems Developer’s API Field Name Field Meaning The requested message to be sent. Table 9b: Additional fields in the reply message Field Name Field Meaning retry_num The number of retries made prior to successful sending of the message Number of concatenated SMS’s used to send the pdu_num_of_sms requested message.
Page 110 "client_id": "192.168.123.2042013-12-30 07:31:18.695932", "msg": "043F04400438043204350442", "reply": "ok", "card_add": "21", "pdu_cnt": 1, "pdu_seq": 1, "ccid": "89972080091094690670"} And finally, a ―delivery receipt‖ reply (if configured to receive one): {"confirmation_final": "yes", "client_id": "192.168.123.2042013-12-30 07:31:18.695932", "sms_reference_list": [4179], "sim_data": "3,73,100,100,100,7,50", "config_confirmation": "yes", Hypermedia Systems Ltd.
Page 111 Hypermedia Systems Developer’s API "msg_id": 3433, "port_num": "4", "number": "0544331124", "retry_num": "0", "pdu_mode": "yes", "active_sim": 3, "pdu_num_of_sms": 1, "pdu_seq": 1, "unicode": "1", "msg": "043F04400438043204350442", "reply": "confirmation", "card_add": "21", "confirmation_val": "0", "pdu_cnt": 1, "ccid": "89972080091094690670"} Unicode mode 20 (transparent PDU): {"pdu_len":29,"unicode":"20","msg":"0031000A8150320434330000 FF12C83CBC2C6F96C9E930084AAC82CA7838","send_to_sim":"21#1"}...
Page 112 "89972080091094690670", "sms_reference_list": [4183], "sim_data": "3,75,100,100,100,9,50", "config_confirmation": "yes","port_num": "4", "number": "+972544331124", "retry_num": "0", "pdu_mode": "yes", "active_sim": 3, "msg": "47736D", "pdu_num_of_sms": 1, "pdu_seq": 1, "unicode": "21", "client_id": "192.168.123.2042013-12-30 07:31:18.695932", "reply": "confirmation", "card_add": "21", "confirmation_val": "0", "pdu_cnt": 1, "pdu_dest_port": "8091"} Hypermedia Systems Ltd.
Page 113: Sending Bulk Sms
Hypermedia Systems Developer’s API 6.5 Sending Bulk SMS To send a large number of SMS with the same message to various destinations, use bulk mode. The following is a sample method for sending SMS in bulk mode: {"method":"start_bulk", "bulk_id": 453, "msg": "6B656C6C6F", "unicode": "0"...
Page 114: Deleting An Entire Bulk
- this will close a bulk session, but will not delete the bulk until all the pending messages in the bulk have been sent by the gateway. Example: {"method":"end_bulk", "bulk_id":453}  this will immediately delete a bulk session, including all “stop_bulk” pending messages for this bulk. Example: {"method":"stop_bulk", "bulk_id":453} Hypermedia Systems Ltd.
Page 115: Sms Event Notifications
Hypermedia Systems Developer’s API 6.6 SMS Event Notifications It is possible to receive notifications whenever an SMS is sent from the gateway or received by the gateway. When registering for incoming or outgoing SMS notifications, any such event will be sent to the client and will include the full details of the SMS.
Page 116 The incoming SMS in the next example contains also Unicode characters {"direction": "in", "notification": "cdr", "port_num": "2", "number": "+972547893166", "datetime": "2009-09-21 15:23:29", "card_add": "21", "message": "Hypermedia \u05d9\u05d5\u05e4\u05d9"} The following is an example of a notification of an outgoing SMS event (as a result of registering for outgoing SMS notifications): {"direction": "out", "notification": "cdr", "msg_id":...
Page 117 Hypermedia Systems Developer’s API Field Applies to Meaning datetime Both incoming For incoming messages: and outgoing The date and time when the SMS was received by the gateway. For outgoing messages: The date and time the message was sent. result Outgoing only if no errors.
Page 118: Http Notifications
. " | "; print "retry_num-" . $_GET["retry_num" ] . " | "; print "msg_id-" . $_GET["msg_id" ] . " | "; print "client_id-" . $_GET["client_id" ] . " | "; print "sending_time-" . $_GET["sending_time" ]; ?> Hypermedia Systems Ltd.
Page 119: Queue Related Operations
Hypermedia Systems Developer’s API 6.8 Queue Related Operations The following methods address aspects of the queue. 6.8.1 Retrieve Queue Status and Size To get the status of the queues in the gateway, issue the following method: {"method":"get_q_size"} The following is an example of a queue status reply.
Page 120: Deleting Queues
To remove all pending messages from the master queue, use the following method: { "method":"delete_queue","queue_type":"master" } To remove all pending messages from the regular queue, use the following method: {"method":"delete_queue"} WARNING: All messages kept in the queue will be lost. Hypermedia Systems Ltd.
Page 121: Pausing And Continuing The Gateway Operation
Hypermedia Systems Developer’s API 6.9 Pausing and Continuing the Gateway Operation To cause the Gateway to stop sending messages, regardless of which queue they were added to, use the following method: { "method":"pause_server" } The gateway will continue to accept requests to send out messages, but the messages will just accumulate on the queue.
Page 122: Http Api
 omitted—as in the above example—the SMS Gateway PRO will use a default value of 5, i.e. attempt to convert the message to GSM 03.38, and upon failure to do so will send the message using UCS-2. Hypermedia Systems Ltd.
Page 123 Hypermedia Systems Developer’s API  The server_password value is the same as that of the server_password value that would have been set to log-in via the JSON authentication ―Logging command (see the In‖ section). Release 5.5 (March 2015)
Page 124: Http Api Responses
<JSON content> example, the command. get_sim_config In this case, <JSON content> would contain the same reply which would have been returned had the command been issued using the JSON API. Hypermedia Systems Ltd.
Page 125: Cdr Support
Hypermedia Systems Developer’s API 6.11 CDR Support Following are the methods for obtaining SMS CDR-related information. 6.11.1 CDR Files The SMS PRO gateway writes SMS CDR in two files – one contains the records of incoming messages and the other stores records of outgoing messages.
Page 126 The mobile phone number of the sender of the SMS Thanks The message body Status code. Possible values are OK, Err, Confirmation The format of a call record for an outgoing SMS is as follows: 2009-08-19 18:11:37|24|1|+972111111111|Thanks|OK|0| Unknown|192.168.123.82009-08-19 18:11:32.050555|00:00:04 Hypermedia Systems Ltd.
Page 127: Cdr Mysql Support
Hypermedia Systems Developer’s API 6.11.2 CDR MySQL Support The PC-based version of the HG7000 line of products also supports using an external MySQL database to store incoming and outgoing SMS events. The MySQL connection details should be entered in the relevant fields on the SMS...
Page 128: Error And Confirmation Codes
HLR (i.e. IMSI or directory number is not allocated to a subscriber). Normal unspecified. The GSM engine refused to send the message but no reason was stated. Note that this can also be the result of a message that was Hypermedia Systems Ltd.
Page 129 Hypermedia Systems Developer’s API Code Code Meaning (Dec) (Hex) recently sent to the card, before a reply was received for the previous message. Module Error. Module has either no SIM or no reception, is faulty or is still handling the sending of a previous message.
Page 130 Telematic interworking not supported. Short message Type 0 not supported. Cannot replace short message. Unspecified TP-PID error. Data coding scheme (alphabet) not supported. Message class not supported. Unspecified TP-DCS error. Command cannot be auctioned. Hypermedia Systems Ltd.
Page 131 Hypermedia Systems Developer’s API Code Code Meaning (Dec) (Hex) Command unsupported. Unspecified TP-Command error. TPDU not supported. SC busy. No SC subscription. SC system failure. Invalid SME address. Destination SME barred. SM Rejected-Duplicate SM. TP-VPF not supported. TP-VP not supported.
Page 132 PH-SIM PIN required. SIM failure. SIM busy. SIM wrong. SIM PUK required. SIM PIN2 required. SIM PUK2 required. Memory failure. Invalid memory index. Memory full. SMSC address unknown. No network service. Network timeout. NO +CNMA ACK EXPECTED. Hypermedia Systems Ltd.
Page 133 Hypermedia Systems Developer’s API Code Code Meaning (Dec) (Hex) Unknown error. MM establishment failure. Lower layer failure. CP error. Release 5.5 (March 2015)
Page 134 SM Deleted by SC Administration. SM does not exist. The SM may have previously existed in the SC but the SC no longer has knowledge of it or the SM may never have previously existed in the SC. Hypermedia Systems Ltd.
Page 135 Hypermedia Systems Developer’s API Code Code Meaning (Dec) (Hex) 74-79 4A-4F Reserved. 80-95 50-5F Values specific to each SC. Temporary errors, SC is not making any more transfer attempts. Congestion. SME busy. No response from SME. Service rejected. Quality of service not available.
Page 136: Troubleshooting
If problem continues replace the card. Ready LED (Yellow) Card is either not Reinsert the card and does not light inserted correctly, or restart the system. If faulty problem continues replace the card. Hypermedia Systems Ltd.
Page 137: Release 5.5 (March
Hypermedia Systems Troubleshooting Table 18. MG Card Display Problem Solution Error LED (Red) is Card is faulty Reinsert the card and blinking (50% duty restart the system. cycle, not twinkling) If problem continues replace the card. Ready LED (Yellow) Card is either not...

Hypermedia HG-7000 Product Manual

Before You Begin

1 Hardware and Installation

2 HMC Quick Start

3 Configuring a Cellular Card

4 Configuring the SMS Server

5 Scheduler

6 Developer's API

7 Troubleshooting

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Hypermedia HG-7000

Summary of Contents for Hypermedia HG-7000

Table of Contents