General

COM Object API, developed by Mobildev SMS Services, is a COM solution provided for software developers who wish to develop SMS solutions with the software development platforms they use.

Though IDE is independent, it is the method preferred by software developers who make use of Microsoft technologies, as it operates basing on operating system support –only Windows platform-. With this tool, you can send up to 30.000 SMS messages having the same or different content.

COM API is accessing http://gateway.mobilus.net/com.mobilus address via HTTP port 80 and thus accessing Mobildev SMS Gateway. If your network is behind a firewall, the computer that uses Mobildev COM API must be enabled accessing this address with data transmission in both ways.

System Requirements

Following is the minimum system requirements list in order to use Mobildev COM Object API solution.

User Information Control

Before starting with sending SMS, SMS user information control must be carried out. If you don’t have a current SMS account please CLICK HERE to obtain a test account from Mobildev Customer Services.

When Gateway receives the user information, the system verifies it and sends credit and originator information associated with it. During verification of the user information, username, company and password information is checked.

After checking the information sent to Gateway, 01 Error Code will be returned if the information is not correct. Error Code 01 means that one or all of the following is incorrect: user name – password – company code. In this case, please contact with Mobildev Technical Support Team and check your login details.

COM provides a method called getinfo for checking user information.

Syntax:

getinfo “UserName,”PassWord”

In this method:
UserName parameter refers to your user name, associated with your Mobildev SMS account.
Password parameter refers to your password for SMS user name.

Sample getinfo Method:

<%
Set sms = Server.CreateObject("MobilusSMS.Gateway")
"test-mb1000","1234")
%>

After calling the getinfo method as specified in the example and submitting it to the Gateway, the below values will be returned:

1. If successful:
Credits remaining<10>
Originator1<10>
Originator2<10>
OriginatorN

2. If an error occurred: Please consider checking the Error Codes section.

Notice Regarding Characters To Be Used

During sending, the below is not allowed:

• Turkish characters (ç,ş,ü,ö,ğ,Ç,Ü,Ş,Ğ,Ö,İ)
• ~, ^^, &, <, >, €, £, ã, Ã, ‰, €, ©, ®, ∞, ° signs
• LineFeed, Enter, Tab commands

Notice Regarding GSM Number Format

GSM numbers must be formatted as 05321234567, 5321234567, 905321234567 and written within Numbers parameter node. If the GSM numbers are not written in this format, 04 Error Code will be returned. Error Code 04 means that that GSM number format is not correct. In this case, please consider checking the Notice Regarding GSM Number Format section.

Sample Usage:

<Numbers>05321234567</Numbers>
<Numbers>5321234567</Numbers>
<Numbers>905321234567</Numbers>

Notice Regarding Sender Information Usage

Sender Information (Alphanumeric/Originator), is the sender name in the messages. This name is 11 characters long and is company dependant. While sending, the exact sender information –provided by the activation unit during account activation- must be quoted within the Originator Parameter node. 06 Error Code will be returned should Sender Information does not match. Error Code 06 means that the Originator information is not defined.

Notice Regarding Bulk SMS Sending Method

Mobildev COM Object API provides 3 methods that depend on each other. These methods must be used in a specific order; namely:

1) addtosmsbasket

2) sendsms

3) clearsmsbasket

addtosmsbasket Method

addtosmsbasket method is utilized in preparing sending of the SMS package. Each time that this method is called, GSM number and the text you specified as parameter will be added to the current SMS package.

Syntax:addtosmsbasket “message”,”gsmno”
In this method:
message parameter refers to the String value of 160 character long SMS message.
gsmno parameter refers to the GSM number that the message will be sent to.

sendsms Method

sendsms method is utilized in sending SMS package –built with addtosmsbasket method- with the user information specified as parameter to the Gateway.

Syntax:sendsms “UserName”,”PassWord”,”Originator”,”SendDate”
In this method:
UserName parameter refers to user name associated with your Mobildev SMS account.
PassWord parameter, refers to password for your SMS user name.
Originator parameter, refers to  user name that will be displayed on recipient’s GSM number.
SendDate parameter refers to the sending time in ddmmyyyyhhmm format.

If you submit the SMS sending URL as specified above, the Gateway will return the following values:

If successful: TimerID information in “ID: 1234567” format will be returned.

If an error occurred, please consider checking Error Codes Section.

clearsmsbasket Method

clearsmsbasket method is utilized in clearing the package contents once SMS package –built with addtosmsbasket method- is submitted with the sendsms method.

SMS Sending <%
Set sms = Server.CreateObject("MobilusSMS.Gateway")
sms.addtosmsbasket “message1”,"number1”
sms.addtosmsbasket “message1”,"number2”
sms.addtosmsbasket “message1”,”number3”
sms.addtosmsbasket “message2”,”number4”
sms.sendsms “username-company-_code”,”password”,”Originator”
sms.clearsmsbasket
%>

Sample SMS Sending <%
Set sms = Server.CreateObject("MobilusSMS.Gateway")
sms.addtosmsbasket “happy new year”,”05358838710”
sms.addtosmsbasket “happy new year”,”05554562312”
sms.addtosmsbasket “happy new year”,”05054215263”
sms.addtosmsbasket “happy birthday”,”05426532110”
sms.sendsms “test-mb1000”,”1234”,”MOBILDEV”,”311220121530”
sms.clearsmsbasket
%>

Notice Regarding Reporting

Mobildev COM Object API provides 2 methods for reporting the SMS sent:

For date basis: getmsgstatustodate method

For sent message basis: getmsgstatus method

Date Basis Reporting (getmsgstatustodate method)

Date basis reporting is utilized in reporting SMS sending transactions for a period specified.

Syntax: getmsgstatus “UserName”,”PassWord”,”FDate”,“LDate”
In this method:
UserName parameter refers to user name associated with your Mobildev SMS account.
PassWord parameter, refers to password for your SMS user name.
FDate parameter refers to starting date of the report (in “Year-Month-Date” format).refers to  user name that will be displayed on recipient’s GSM number.
LDate parameter refers to ending date of the report (in “Year-Month-Date” format)

Sample getmsgstatustodate Method <%
Set sms = Server.CreateObject(“MobilusSMS.Gateway”)
prmdonus = sms.getmsgstatus(“test-mb1000”,”1234”,”2012-06-18”,“2012-06-19”)
%>

Once the information is received by Gateway, there will be 2 values returned:

1. If successful: “TimerID<32>GSM Number<32>Status<10>”

Date Basis Reporting Return Value 1234<32>905358838799<32>2<10>
1234<32>905428838799<32>3<10>
1234<32>905558838799<32>1<10>

2. If an error occurred, please consider checking the Error Codes Section.

Sent Message Basis Reporting (getmsgstatus method)

Sent message basis reporting, also known as TimerID basis reporting, is utilized in reporting message sending transactions of a SMS package.

Syntax: getmsgstatus “UserName”,”PassWord”,”TimerID”
In this method:
UserName parameter refers to user name associated with your Mobildev SMS account.
PassWord parameter refers to password for your SMS user name.
TimerID parameter refers to the TimerID information of the SMS package.

Sample getmsgstatus Method <%
Set sms = Server.CreateObject("MobilusSMS.Gateway")
prmdonus = sms.getmsgstatus(“test-mb1000”,”1234”,”1423567”)
%>

Once the information is received by Gateway, there will be 2 values returned:

1. If successful:

“TimerID<32>GSM Number<32>Status<10>”
Sent Message Basis Reporting Return Value 1234<32>905448838799<32>2<10>
1234<32>905378838799<32>3<10>
1234<32>905058838799<32>1<10>

2. If an error occurred, please consider checking the Error Codes Section.

Notice Regarding Status Information Control

During reporting, 3 different status values will be returned for a successfully sent SMS package :

"1" means the message is awaiting;

"2" means the message was sent;

"3" means the message was not delivered.

Error Codes

COM Object API Sample Codes

	ASP Script		PHP Script
	VB Project		Delphi Project
	DLL File		C# Project