User Guide SMS Connect Wireless Maingate AB

Size: px

Start display at page:

Download "User Guide SMS Connect Wireless Maingate AB"

Mark Gregory
8 years ago
Views:

1 Web: User Guide SMS Connect

2 Document name: SMS Connect User Guide Revision: 1.0 Date: Information class: Open Address: Box KARLSKRONA Sweden Phone number: Copyright 2009 The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. shall have no liability for any error or damages of any kind resulting from use of this document.

+46455363700 Copyright 2009 The contents of this document are subject to revision without notice due

3 TABLE OF CONTENTS 1 INTRODUCTION Functional Overview Quick Start General SMS 5 2 FUNCTIONAL DESCRIPTION SMS Reversed Billing Quick start Maingate API Software tools 8 3 TECHNICAL SPECIFICATION Prerequisites Restrictions & Product Limitations Characteristics 9 4 TROUBLESHOOTING Can not login to API 10 5 APPENDIX Document history References Terminology 12

1 Prerequisites 9 3.2 Restrictions & Product Limitations 9 3.3 Characteristics 9 4 TROUBLESHOOTING 10 4.

4 1 INTRODUCTION 1.1 FUNCTIONAL OVERVIEW Maingate Service Platform enables integration to SMS through a single integration, providing easier development and lower costs. User application is integrated via internet and http/xml to Maingate API. FIN Maingate web S N SMS Maingate Service Platform XML API Transparent User Application DK NL Figur 1 Functional overview It is important to have a reliable TCP/IP connection between the User application and Maingate communication platform. The TCP/IP connection can be implemented in several ways and Maingate supports Internet access and leased line. Please note that the actual access to Internet is not a part of this product. Regardless of the Internet access method used, there is one single point of access to the Maingate platform. info@maingate.se Web: 4 (12)

FIN Maingate web 89470 80087 00000 0483 S N SMS Maingate Service Platform XML API Transparent Communication @ User Application DK NL Figur 1 Functional overview It is important to have a reliable

5 1.2 QUICK START General At you will find our specifications. The Maingate XML/HTTP Interface Description [1] is the general specification. For detailed information about the services read the specifications for the respective service. The primary URL to Maingate API is As a backup address during operation disturbances use SMS To send and fetch short messages via Maingate API attach to the following services: 1. Send a short message to terminal with Maingate SIM: Specification: Maingate Message, Interface Description [2] XML Document: Message_v1.2 Service: Message 2. Fetch message from a terminal with Maingate SIM: Specification: Maingate Message, Interface Description [2] XML Docoument: Container_v1.1 Service: Container Container ID: Message 3. Send message to a terminal with other operators SIM: Specification: Maingate Broadcast, Interface Description [3] XML Document: Message_v1.2 Service: BroadcastSMS To send a short message from a terminal with Maingate SIM to the container, use the short code and SMSC address specified in chapter info@maingate.se Web: 5 (12)

As a backup address during operation disturbances use http://api2.maingate.se:4100/execute. 1.2.2 SMS To send and fetch short messages via Maingate API attach to the following services: 1.

6 2 FUNCTIONAL DESCRIPTION 2.1 SMS The Message and Container services are used for sending and receiving short messages to/from cellular terminals using Maingate SIM cards and the Broadcast service is used to send short messages to phones/terminals that are not using Maingate SIM cards. The customer application sends the short message by using the Maingate HTTP/XML Interface, which is an HTTP and XML based API that is accessible via the Internet. The Maingate service platform processes the request by sending the short message to the cellular terminal using one or more of its SMS- Centrals (SMS-C). Data 9026 Customer Application Internet VPN A P I MSP SMS-C ServiceNumber MMG Maingate Platform GSM Figur 2 Overview SMS info@maingate.se Web: 6 (12)

messages to phones/terminals that are not using Maingate SIM cards.

7 2.2 REVERSED BILLING When communicating with a terminal that is using a Maingate SIM-card it is possible to reverse the billing, i.e. when the API account is communicating with the terminal using SMS, the SIM-card is charged with the cost. If you want to use reversed billing you must use the specific reversed billing services. Note: It is only possible to use reversed billing when communicating with terminals that are using your own Maingate SIM-cards Quick start 1. Send a short message to a terminal with Maingate SIM using reversed billing: Specification: Maingate Message, Interface Description XML Document: Message_v1.2 Service: MessageRB info@maingate.se Web: 7 (12)

Note: It is only possible to use reversed billing when communicating with terminals that are using your own Maingate SIM-cards. 2.2.1 Quick start 1.

8 2.3 MAINGATE API The Maingate API is an integration point for business systems, web applications etc. to use Maingate services. The API publishes the services as XML-based web services, so they can be used over internet. Maingate XMLAPI is an XML and HTTP based interface used by applications that are connected to Maingate using TCP/IP. It is a service-oriented interface where all operations are executed through web services attached to authorized users. Customer Application JavaSDK Maingate XMLAPI (XML/HTTP) Service M2M Service Framework Service Service Figur 3 Maingate API Software tools Maingate provides a software tool to simplify the integration. Java SDK - Development kit for easy integration in Java applications. This tool can be downloaded from info@maingate.se Web: 8 (12)

Maingate XMLAPI is an XML and HTTP based interface used by applications that are connected to Maingate using TCP/IP.

9 3 TECHNICAL SPECIFICATION 3.1 PREREQUISITES If a firewall is active, it must be configured so the system can set up a TCP/IP session to port Requires a TCP/IP connection. 3.2 RESTRICTIONS & PRODUCT LIMITATIONS TCP/IP connection between User application and Maingate communication platform is not included. 3.3 CHARACTERISTICS Swedish SIM cards (ICC number starting with ): SMSC address SMSC account 9026 Capacity Scalable Default validity period 72h Max validity period 72h Norwegian SIM cards (ICC number starting with 8947 ): SMSC address SMSC account 2063 Capacity Scalable Default validity period 24h Max validity period 72h MVNO SIM cards(icc number starting with ): SMSC address SMSC account 9026 Capacity Scalable Default validity period 24h Max validity period 72h info@maingate.se Web: 9 (12)

SIM cards (ICC number starting with 8947 ): SMSC address +4792001000 SMSC account 2063 Capacity Scalable Default validity period 24h Max validity period 72h MVNO SIM cards(icc number starting with

10 4 TROUBLESHOOTING 4.1 CAN NOT LOGIN TO API a) Verify that the connection to Maingate Server is functional by connecting via Telnet. Start a command prompt (DOS) and type: > telnet <server name> <control port> Press space and then enter. A number of HTML tags will be written on the screen. info@maingate.se Web: 10 (12)

11 Try the functionality of the pipe port by typing: > telnet <server name> <pipe port> Press : (colon) which interrupts the connection.. Failing to receive the expected result might come from a problem with your firewall not passing traffic through to the connected port. If the firewall is open, the problem can be that the connection to Maingate Server is not operational. info@maingate.se Web: 11 (12)

. Failing to receive the expected result might come from a problem with your firewall not passing traffic

12 5 APPENDIX 5.1 DOCUMENT HISTORY Revision Date Signature Comments HS First version 5.2 REFERENCES Reference Document name 1 MG AU Rev D Maingate HTTP/XML v1.2 Interface Specification 2 MG AU Rev A Maingate Message Interface Description 3 MG SL Rev D Maingate Broadcast Interface Description 5.3 TERMINOLOGY API Application Programming Interface GSM Global System for Mobile communications LAN Local Area Network SDK Software Development Kit SIM Subscriber Identity Module TCP/IP Transmission Control Protocol / Internet Protocol XML Extended Markup Language info@maingate.se Web: 12 (12)

2 Interface Specification 2 MG030136 AU Rev A Maingate Message Interface Description 3 MG001011 SL Rev D Maingate Broadcast Interface Description 5.

Network Configuration Settings

Network Configuration Settings Many small businesses already have an existing firewall device for their local network when they purchase Microsoft Windows Small Business Server 2003. Often, these devices