Custom SMS gateway

Help files

Thank you for choosing SMShosting.Biz as your SMS gateway host

Your Service is hosted on a Powerful carrier grade Linux Platform and utilizes the Inflow data center that is known for its world class quality

Your Server uses the MDEX (Mobile data Exchange ) Platform designed by our in-house team of Software engineers

SMS ORIGINATION METHODS

Understanding your SMS server

Your SMS server comes with the following components to enable your users to send SMS

SMPP SMS Server

This is located on Port 2775 of your server and supports the sending and receiving of SMS by a SMPP client or server capable of running the SMPP protocol version 3.4. Your users can connect to that port and authenticate with their user/id and password bind with that port and send text or binary SMS to mobiles around the world

IP or Domain if used	Port Number	Port type	Username	Password	system type	SMPP version
66.179.181.59	2775	Transceiver	As registered by your user	As registered by your user	APPL	3.4

___________________________________________________________________________________________________________

HTTP SMS Server

This is basically a Post/Get request sent to your server along with userid password Sender id Destination number and message text along with a message type flag

IP	http://66.179.181.59:8080/smsc/general/sendsms.jsp?userid=testusr&password=test&submit_name=555555555555& send_to=666666666666&message_type=0&message_text=Hello%20world%20%21%21%21
or Domain if used	http://your resolved domain or sub-domain.com:8080/smsc/general/sendsms.jsp?userid=testusr&password=test&submit_name=555555555555& send_to=666666666666&message_type=0 &message_text=Hello%20world%20%21%21%21

___________________________________________________________________________________________________________

Web SMS Server

This is the customizable part of your gateway and can be customized to your liking this is the web interface that your users can use to accomplish and almost anything can be accomplished for customization purposes an FTP access to your HTML directory is required

If using an IP	http://66.179.181.59/Yourvirtualdirectory/ ie http://66.179.181.59/mydirectory/
If using a sub/domain name	http://www.smshosting.biz/ or http://sms.yourdomain.com

FTP Access

Any FTP client should do the trick and get you connected to the server there are some including the very popular WS FTP that can be downloaded

IP number 66.179.181.59

Port number 21

User name XXXXXX as given to you

Password YYYYYYY as given to you

On successful login you will see

An HTML directory that contain your default HTML pages that can be customized by the administrator
An images directory for your images that you want to use in your pages

___________________________________________________________________________________________________________

IMPORTANT

Your gateway contains a fully functional set of pages

Download the directory onto your local Hard drive so you have a default set of pages saved. In case you have a problem the best way to restart would be from that default page

These pages contain a set of variables that pull in certain values from the database while your user is in the control panel These variables are embedded in the HTML Your default directory comes with a fully functional control panel

The Variable names and the HTML page names along with the links (Keys) to the existing pages are static cannot be changed edited or modified in any manner

The best way to customize the pages is to edit the pages one at a time

Bring one page at a time into a HTML editor and edit them Image sources and links to external can be inserted

When a user logs in a session is created for the user and the server keeps track of the user while he or she is logged in to the WebSMS control panel when placing links (Only to external pages) It is advisable to place links that open up a new browser page so as not to break or interfere with the users session in any manner Links within the gateway must open in the same window

Some pages contain Javascripts it is advisable to maintain those scripts in order to maintain the functions that they were originally designed to perform within that page

It is not necessary to use all pages simply link to the pages in the gateway that you will be using for example if you just want to provide a text SMS form you need not link to any of the other pages for unicode or ring tones or WAP PUSH

___________________________________________________________________________________________________________

Page Hierarchy

REGISTRATION PAGE (register.html)

This is the page that your users will use for online registration of their accounts on your gateway. This form is designed to capture certain registration details and submit it to the registration script

REGISTRATION ACCEPTED (registrationaccepted.html)

On submission the data is accepted and a thank you page is displayed

REGISTRATION ERROR PAGE (replayregistration.html)

On submission the data is not accepted and a resubmit page is displayed

ACTIVATION PAGE

This is a page that is automatically generated from a single use link that is sent to the user This page has a form and is designed to be used to activate the account with a activation code sent as a text message to the users mobile device

SEND A TEST SMS (loadtestcoverage.html)

This is a page where a website user can test service to his/her mobile phone without having to register for service this is an open form that sends a fixed message which can be configured thru the VAS section of the control panel. This form is limited to one message to a mobile number only during a 24 hour period

TEST SMS SENT (testsmssent.html)

Thank you page when an SMS is sent

ERROR PAGE (noservice.html)

Error page that is displayed when a message was already sent to that number in the past 24 hours

LOST PASSWORD PAGE (loadlostpassword.html)

This is a page where a website user can enter the original email address used at the time of registration the account login details will be sent by email to that email address

___________________________________________________________________________________________________________

CONTROL PANEL LOGIN SECTION

This section contains the following

LOGIN SECTION

This is the page where your users encounter a login form to enter their user id and password

This page is displayed with a message of failed login and the login form is displayed again giving the user a second chance to login again

WELCOME PAGE (welcome.html)

If login is successful the user will be displayed a welcome page that includes a section that displays account details and ideally may contain the following links along with a welcome message banners text ads links etc

WebSMS

This section contains links to the pages containing forms for the various SMS formats along with links to the

Inbox

This is the inbox of the account (used with Virtual numbers)

Phonebook (AddressBook.html)

This is the phonebook that the user can use when sending the values of this is populated in the send SMS forms allowing the user to conveniently select and send

Phone book editing (AddressBookedit.html)

This is where the phone book entry selected by the user can be edited or deleted

sent folder (sent.html)

This is the list of sent items the list is populated using a variable

help (help.html)

Help page for the gateway for convenience of the user

web2U (reverse.html)

A easy form that allows users to receive reversed billed SMS from the internet on the registered mobile number

HTTP SMS (posturl.html)

This section displays the HTTP SMS instructions

SMPP SMS (smpp.html)

This section displays the HTTP SMS instructions

Value added services VAS1.html to VAS9.html

This section allows the creation of other services

___________________________________________________________________________________________________________

Reference to an image

From your images directory provided

websms/images/a.gif

Images uploads into your image directory is referenced as above in your HTML pages

Referencing an Image from an external source

From external sources (not recommended if you are using SSL)

http://www.yoursite.com/images/images.gif

___________________________________________________________________________________________________________

LINKS

Links to internal Gateway pages

Links to pages that are placed as default in your directory can be called with a simple HTML tag that includes a KEY

Example index.jsp?KEY=COMPOSE

The HTML tag for the Compose SMS page would look like this

Links to internal HTML pages

Links to additional pages that are placed as HTML in your directory can be called with a simple HTML tag. You can choose this to place help files

Links to external HTML pages (Must open in a separate window)

Links to external links anywhere on the internet can be called with a simple HTML tag. You can choose this to link from banners . Since the session is open it is recommended to open in a separate window

___________________________________________________________________________________________________________

MAIN GATEWAY PAGES (Dynamic)

These are your main gateway pages that are loaded as default in your directory. These pages are unique in their functionality and purpose which must be maintained You can populate any database value on these pages these values that are created by the user , system or administrator can be used or displayed as values on the page or to populate form fields and anything else in your gateway

There are two sets of pages in your gateway one type can be called via a URL ie index.jsp?KEY=HOME while there are others that cannot be called but are displayed as error or intercept pages when a user is using the control panel The list below are of pages that can be called via a URL while the complete list of pages is given further down this page

These pages can only be called after login

File name

Key

using POST or GET Method to index.jsp with a KEY

Page Should Contain the following forms

welcome.html

HOME

Welcome page after successfully logging in

compose.html

COMPOSE

This is a index page to the compose section which gives the user the option of sending in different formats

textmessage.html

TXTMSG

A Text message form that can be found on the default page loaded in your HTML Folder

flashmessage.html

FLAMSG

A Flash message form that can be found on the default page loaded in your HTML Folder

unicodemessage.html

UCSMSG

A Unicode message form that can be found on the default pabe loaded in your HTML Folder

wapmessage.html

WAPMSG

A WAP Push form that can be found on the default page loaded in your HTML Folder

ringtonemessage.html

RNGMSG

A Ring Tone send form that can be found on the default page loaded in your HTML Folder

inbox.html

INBOX

Only applies to Gateways that provide 2 way SMS

posturl.html

URL

Contains instructions for HTTP gateway

smpp.html

SMPP

Contains Instructions for SMPP

tools.html

TOOLS

Contains SMPP tools and clients

AddressBook.html

ADDRESS_BOOK

A Address book entry form that can be found on the default page loaded in your HTML Folder

<%= DrawPhoneBookTable %> is used in this page to print address book table

AddressBookEdit.html

ADDRESS_BOOK&TRAN=EDIT

A Address book Edit form that can be found on the default page loaded in your HTML Folder

sent.html

SENT

This page contains two sets of Variables

<%=DrawTable%> used to print table of all the messages sent

<%=LinkStaring%> Page link for table page 1,2,3 4 Etc

Links from external sources

File name

KEY

HTML of the form on the page

loadtestcoverage.html

LOADTESTCOVERAGE

Form to send a test message without login a form for the test can be found on the default page loaded in your HTML folder

lostpassword.html

LOADLOSTPASSWORD

Form to send a request to retrieve the lost password a form can be found on the default page loaded in your HTML folder

LOADREGISTRATION

Form to register a new user. This is the page where some of the variables are created a form can be found on the default page loaded in your HTML folder

CONTROLPANEL

Login page for users to login to your control panel this contains a form for user to enter a userid/password The default page contains a form and a java cookie script to save the userid and password on the users local PC Both these can be found on your default pages

___________________________________________________________________________________________________________

DATABASE VARIABLES

Some values are created when a subscriber registers him/her self using the registration form while others are generated by the system and some are created by the administrator

Within the pages of your gateway you can pull up values from the database that can be populated in your pages in form fields or on the HTML page using HTML tags for color size fonts etc

Here is the list of Variables to populate them in your pages or forms insert the contents of the variable box below

Variables can only be populated in the above mentioned pages

While you can load additional pages in HTML Variables cannot be populated in any extra pages that you load

Case sensitive *

Description of registered Value	Variable* to populate the value in your pages	Type of Variable
Username	<%=Account.getSMSUserName()%>	User created/Registration page
Password	<%=Account.getSMSPassword()%>	User created/Registration page
Customer Code	<%=Account.getCustomerCode()%>	User created/Registration page
Registration Date	<%=Account.getRegistrationDate()%>	User created /Registration page
Customer Name	<%=Account.getCustomerName()%>	User created/Registration page
Personal Name	<%=Account.getPersonalName()%>	User created/Registration page
Mobile No	<%=Account.getMobileNumber()%>	User created/Registration page
Email	<%=Account.getEmailAddress()%>	User created/Registration page
Postal Address	<%=Account.getPostalAddress()%>	User created/Registration page
Monthly Usage	<%=Account.getMontlyUsage()%>	User created/Registration page
Balance Credits	<%=Account.getAccountBalance()%>	System generated/Account details
Total Credit	<%=Account.getSMSAccountSize()%>	Adminstrator generated/Account limit
Used Credit	<%=Account.getSMSCurrentSize()%>	System generated/Account details
Sent message details	<%=DrawTable%>	System generated/Account details
Sent message details Pages	<%=LinkStaring%>	System generated/Account details Paging link for table
Expiry Date	<%=Account.getExpiryDate()%>	Adminstrator generated/Account limit
IP Address	<%=Account.getIpAddress()%>	System generated/security details
Service Type	<%=Account.getServiceType()%>	Adminstrator generated/Account limit
Max Credit Limit per message	<%=Account.getUnifiedMaxCredit()%>	Adminstrator generated/Account limit per SMS
Account Activate	<%=Account.getUserActivation()%>	Adminstrator generated/Account Expiry date
Address book entries	<%= DrawPhoneBookTable %>
Account not activated	<%=ErrMessage%>	On welcome page
Registration errors	<%=ErrMessage%>	On Registration page

___________________________________________________________________________________________________________

Listing and description of all pages in your directory

AddressBook.html

This is where the listing of your users phonebook contents are listed this page contains the <%= DrawPhoneBookTable %> and can be inserted in a table and resized

___________________________________________________________________________________________________________

AddressBookEdit.html

This is where a phone book entry is edited or deleted This page contains a form (refer above)

___________________________________________________________________________________________________________

activatesuccess.html

This page is displayed to a user after the mobile number is confirmed On registering an account a user is sent an email and a text/SMS to activate the account this is basically done to confirm and validate email address and mobile number that the user registered The email contains a “single use” link and when called in a browser opens up a form that the user enters the code that was sent to his/her mobile if these two steps are done the user activates the account this page typically contains

“your account has been activated” along with a link to your login page

___________________________________________________________________________________________________________

chkmail.html

chkmail.html for successfully sent e-mail for lost password

___________________________________________________________________________________________________________

composesms.html

This page is the index page that list links the various send sms forms ie flashmessage.html, unicodemessage.html,textmessage.html etc

___________________________________________________________________________________________________________

errmail.html

This page displays an error occurred while retrieving the lost password this is normally an incorrect email format

___________________________________________________________________________________________________________

flashmessage.html

Page that contains a form that is designed to send a flash message

___________________________________________________________________________________________________________

inbox.html

This is a page that contains the received SMS inbox of the user

___________________________________________________________________________________________________________

invalidreq.html

A intercept page when a invalid link URL or a KEY has been detected or when a session has expired typically the message on this page conveys the following

“ Invalid request or your session has expired “ please close this window.

You can also try to put a logout link on that page

___________________________________________________________________________________________________________

loadtestcoverage.html

A page that contains a test SMS form that allows a user to send a test message to a mobile without login or registering an account this sends a fixed message and limits 1 message a day per number to prevent abuse

___________________________________________________________________________________________________________

login.html

Your login page that contains a form. The default page in the directory contains a cookie function that allows the saving of login on the users PC

___________________________________________________________________________________________________________

loginfaild.html

___________________________________________________________________________________________________________

lostpassword.html

Form that allows the user to retrieve the login details the page includes a form that requests the user to enter the email address that was registered. The login details are then sent out to that email address if found on the server

___________________________________________________________________________________________________________

noservice.html

Intercept page to indicate that the test message to the mobile number has already been sent the test page can only be used once per mobile number to prevent abuse

___________________________________________________________________________________________________________

outofcredit.html

Page that tells the user that the account has expired or has no message credits to proceed you could add a link to your prices and payment pages

___________________________________________________________________________________________________________

paymentpage.html

Your payment details you can also populate account values into a form and post that information to a payment gateway

___________________________________________________________________________________________________________

posturl.html

Instructions to your users on using the HTTP post method to send SMS or text messages from applications

___________________________________________________________________________________________________________

register.html

Registration for for service that contains fields and saves them as variables that can be pulled (see above)

___________________________________________________________________________________________________________

registrationaccepted.html

If the registration has been accepted “Thank you your account is registered but not yet activated“ an email and SMS has been sent out “ Please proceed to activate your account

___________________________________________________________________________________________________________

replayregistration.html

Should a field be blank or any other error is found the registration page form will be displayed along with the errors that occurred <%=ErrMessage%> Place the errors on top of the form

___________________________________________________________________________________________________________

reverse.html

Reverse SMS instructions and URL that your users can cut and paste to receive SMS from your site

___________________________________________________________________________________________________________

reversesms.html

Reverse SMS form that your users can use to receive SMS from your site

___________________________________________________________________________________________________________

ringtonemessage.html

Page that contains a form to send ring tones

___________________________________________________________________________________________________________

sent.html

Your Sent folder that contains two variables that you can place in a table The first table populates the sent message details and limits it to the number of entries per page . The second populates the multiple pages (page numbers)

___________________________________________________________________________________________________________

smpp.html

This is where you can put your technical info on connecting to the SMPP port

___________________________________________________________________________________________________________

submitactivation.html

This page includes a form where the user enters the activation code this page also includes an error message in case the activation code is incorrect the error message gets displayed

___________________________________________________________________________________________________________

testsmssent.html

Page that confirms that a test SMS has been sent

___________________________________________________________________________________________________________

textmessage.html

Page contains a form to send text messages. Default page contains a character limit javascript

___________________________________________________________________________________________________________

tools.html

Page that contains Links to tools clients and technical documents

___________________________________________________________________________________________________________

unicodemessage.html

Send Unicode message form ie SMS in Arabic etc

___________________________________________________________________________________________________________

vas1.html

Any service that you would like to add including fixed messages “love messages” Jokes etc Values can be populated an Example of a fixed text message form that can be used for predefined fixed text messages such as "love SMS" Astro SMS" "Funny SMS" etc can be setup using this form

___________________________________________________________________________________________________________

vas10.html