|
General
Mobildev Web Service is developed for enabling client end requests to be sent to Mobildev Service –which has a physical three layer architecture- according to certain standards. These requests utilize XML technology and HTTP protocol.
Software developers can access the service at http://gateway.mobilus.net/soap/API.asmx
Notice:Mobildev Web Service is a solution designed for sending BULK SMS. The messages must be sent to the Web Service in one go as much as possible. |
Notice: With SOAP SMS API, you can send Concat SMS messages over 160 characters. |
Following is the minimum system requirements list in order to use Mobildev SOAP SMS API solution.
Windows 98 SE, ME, 2000, XP, 2003, Linux, UNIX or MAC OS
Internet Explorer 6 SP1 (for Windows Platform)
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.
public UserInfo GetInfo(string username, string company_code, string password)
Values Sent
string username: refers to user name associated with your Mobildev SMS account.
string company_code: refers to your channel code associated with your Mobildev SMS account.
string password: refers to password for your SMS user name.
Sample SOAP
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:xsd=http://www.w3.org/2001/XMLSchema
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetInfo xmlns="http://tempuri.org/">
<username>mobildev</username>
<company_code>mb1000</company_code>
<password>1234</password>
</GetInfo>
</soap:Body>
</soap:Envelope>
Return Values
The Gateway will return the following values:
int status: Refers to the numeric representation of the process status.
string StatusString: Refers to the process status description.
int credit: Refers to the credit balance remaining.
String[] Originators: Refers to the sender information list associated with your account.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:xsd=http://www.w3.org/2001/XMLSchema
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetInfoResponse xmlns="http://tempuri.org/">
<GetInfoResult>
<Credit>int</Credit>
<Originators>
<string>string</string>
<string>string</string>
</Originators>
<Status>int</Status>
<StatusString>string</StatusString>
</GetInfoResult>
</GetInfoResponse>
</soap:Body>
</soap:Envelope>
Mobildev Web Service offers 4 methods for sending SMS:
SMSToMany
public SMSResult SMSToMany(string username, string company_code, string password, string originator, string sendDate, string message, string numbers)
SmsToMany method is used for sending the same message to different GSM numbers. Recommended package size is 30.000.
Notice: When sending SMS with SMSToMany, if the text is longer than 160 characters, the first 160 characters of the message will be sent. |
Values Sent
string username: refers to user name associated with your Mobildev SMS account..
string company_code: refers to the channel code associated with your Mobildev SMS account.
string password: refers to password for your SMS user name.
string originator: refers to the value displayed as the sender on recipient’s device.
string sendDate: refers to the sending time in ddmmyyyyhhmm format (DayMonthYearHourMinute) If left blank, sending will start immediately. If you want to send at a later date, input this specific date.
string message: Refers to the text to send.
string numbers: Refers to the numbers that the messages will be sent. You can use commas “,” between numbers to send the same message to different GSM numbers quicker. Valid phone number formats: 05321234567,5321234567 and 905321234567.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:xsd=http://www.w3.org/2001/XMLSchema
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSToManyResponse xmlns="http://tempuri.org/">
<SMSToManyResult>
<StatusCode>int</StatusCode>
<StatusText>string</StatusText>
<TimerID>11</TimerID>
</SMSToManyResult>
</SMSToManyResponse>
</soap:Body>
</soap:Envelope>
Return Values
int Status: Refers to the numeric representation of the process status.
string StatusString: Refers to the process status description.
string TimerID: Refers to the ID of the message package sent. TimerID is the number that is automatically assigned to the SMS packages.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:xsd=http://www.w3.org/2001/XMLSchema
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSToManyResponse xmlns="http://tempuri.org/">
<SMSToManyResult>
<StatusCode>int</StatusCode>
<StatusText>string</StatusText>
<TimerID>string</TimerID>
</SMSToManyResult>
</SMSToManyResponse>
</soap:Body>
</soap:Envelope>
SMSToManyConcat
public SMSResult SMSToManyConcat(string username, string company_code, string password, string originator, string sendDate, string message, string numbers)
SMSToManyConcat is used for sending the same message to different GSM numbers. Recommended package size is 30.000. With SMSToManyConcat, you will be able to send messages with more than 160 characters
Notice: The Operator will reject the messages if they are less than 160 characters. |
Notice Regarding Character Control When Sending Messages Over 160 Characters (Concat SMS)
1 to 153 characters 1 SMS |
153 to 306 characters 2 SMS |
306 to 459 characters 3 SMS |
459 to 612 characters 4 SMS |
Notice: For messages exceeding 160 characters, each message sent will be 153 characters. |
Values Sent
string username: Refers to your user name associated with your Mobildev SMS account.
string company_code: Refers to your channel code associated with your Mobildev account.
string password: Refers to your SMS user password.
string originator: Refers to the value that will be displayed as the sender on the recipient’s device.
string sendDate: refers to the sending time in ddmmyyyyhhmm format (DayMonthYearHourMinute) If left blank, sending will start immediately. If you want to send at a later date, input this specific date.
string message: Refers to the text to send.
string numbers: Refers to the numbers that the messages will be sent. You can use commas “,” between numbers to send the same message to different GSM numbers quicker. Valid phone number formats: 05321234567,5321234567 and 905321234567.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSToManyConcat xmlns="http://tempuri.org/">
<username>test</username>
<company_code>mb1000</company_code>
<password>1234</password>
<originator>mobildev</originator>
<sendDate>2012-06-18</sendDate>
<message>happy new year</message>
<numbers>05321234567</numbers>
</SMSToManyConcat>
</soap:Body>
</soap:Envelope>
Return Values
int Status: Refers to the numeric representation of the process status.
string StatusString: Refers to the process status description.
string TimerID: Refers to the ID of the message package sent. TimerID is the number that is automatically assigned to the SMS packages.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSToManyResponse xmlns="http://tempuri.org/">
<SMSToManyResult>
<StatusCode>int</StatusCode>
<StatusText>string</StatusText>
<TimerID>string</TimerID>
</SMSToManyResult>
</SMSToManyResponse>
</soap:Body>
</soap:Envelope>
SMSMultiSenders
public SMSResult SMSMultiSenders(string username, string company_code, string password, string originator, string senddate, SMSInfo[] smsInfoArray)
SmsMultiSenders is used for sending different messages to different GSM numbers. Recommended SMS package size is 30.000.
Notice: When sending SMS with SMSMultiSenders, if the text is longer than 160 characters, the first 160 characters of the message will be sent. |
Values Sent
string username: refers to user name associated with your Mobildev SMS account..
string company_code: refers to the channel code associated with your Mobildev SMS account.
string password: refers to password for your SMS user name.
string originator: refers to the value displayed as the sender on recipient’s device.
string sendDate: refers to the sending time in ddmmyyyyhhmm format (DayMonthYearHourMinute) If left blank, sending will start immediately. If you want to send at a later date, input this specific date.
SMSInfo[] smsInfoArray: refers to SMSInfo object, where the message information is kept.
SMS Info Object:
string GSMNo: refers to the number that the message will be sent. Valid phone number formats: 05321234567,5321234567 and 905321234567.
string Message: refers to the text to send.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSMultiSenders xmlns="http://tempuri.org/">
<username>test</username>
<company_code>mb1000</company_code>
<password>1234</password>
<originator>mobildev</originator>
<senddate>2012-06-18</senddate>
<smsInfoArray>
<SMSInfo>
<GSMNo>05321234567</GSMNo>
<Message>happy new year</Message>
</SMSInfo>
<SMSInfo>
<GSMNo>05329876543</GSMNo>
<Message>happy birthday</Message>
</SMSInfo>
</smsInfoArray>
</SMSMultiSenders>
</soap:Body>
</soap:Envelope>
Return Values
int status: Refers to the numeric representation of the process status.
string StatusText: Refers to the process status description.
string TimerID: Refers to the ID of the message package sent. TimerID is the number that is automatically assigned to the SMS packages.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSMultiSendersResponse xmlns="http://tempuri.org/">
<SMSMultiSendersResult>
<StatusCode>int</StatusCode>
<StatusText>string</StatusText>
<TimerID>11</TimerID>
</SMSMultiSendersResult>
</SMSMultiSendersResponse>
</soap:Body>
</soap:Envelope>
SMSMultiSendersConcat
public SMSResult SMSMultiSendersConcat(string username, string company_code, string password, string originator, string senddate, SMSInfo[] smsInfoArray)
SmsMultiSenders is used for sending different messages to different GSM numbers. Recommended SMS Package size is 30.000.
Notice: When sending SMS with SMSMultiSenders, if the text is longer than 160 characters, the first 160 characters of the message will be sent. |
Values Sent
string username: refers to user name associated with your Mobildev SMS account..
string company_code: refers to the channel code associated with your Mobildev SMS account.
string password: refers to password for your SMS user name.
string originator: refers to the value displayed as the sender on recipient’s device.
string sendDate: refers to the sending time in ddmmyyyyhhmm format (DayMonthYearHourMinute) If left blank, sending will start immediately. If you want to send at a later date, input this specific date.
SMSInfo[] smsInfoArray: refers to SMSInfo object, where the message information is kept.
SMS Info object:
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSMultiSenders xmlns="http://tempuri.org/">
<username>test</username>
<company_code>mb1000</company_code>
<password>1234</password>
<originator>mobildev</originator>
<senddate>2011-12-31</senddate>
<smsInfoArray>
<SMSInfo>
<GSMNo>05321234567</GSMNo>
<Message>We will be pleased to see you at our grand opening which will take place on 01.Jan.2012 Monday at 10.00 at STOP&SHOP NOW! Shopping centre in Parsons Green in London.</Message>
</SMSInfo>
<SMSInfo>
<GSMNo>05329876543</GSMNo>
<Message>New branch, new customers, discounted prices! Pay a visit to our new shop at STOP&SHOP NOW! shopping centre in Parsons Green in London and get 10% extra discount ticket for your next shopping!</Message>
</SMSInfo>
</smsInfoArray>
</SMSMultiSenders>
</soap:Body>
</soap:Envelope>
Return Values
int status: Refers to the numeric representation of the process status.
string StatusText: Refers to the process status description.
string TimerID: Refers to the ID of the message package sent. TimerID is the number that is automatically assigned to the SMS packages.
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SMSMultiSendersResponse xmlns="http://tempuri.org/">
<SMSMultiSendersResult>
<StatusCode>int</StatusCode>
<StatusText>string</StatusText>
<TimerID>11</TimerID>
</SMSMultiSendersResult>
</SMSMultiSendersResponse>
</soap:Body>
</soap:Envelope>
Notice Regarding Characters To Be Used
During sending, the below is not allowed:
Turkish characters (ç,ş,ü,ö,ğ,Ç,Ü,Ş,Ğ,Ö,İ) .
~, ^^, &, <, >, €, £, ã, Ã, ‰, €, ©, ®, ∞, ° signs
LineFeed, Enter, Tab commands
Within a message, only the following characters are allowed: ( ) [ ] { } = * ? \ / % + # ! ” : ; _ |
Notice Regarding GSM Number Format
GSM numbers must be formatted as 05321234567, 5321234567, 905321234567 and written within Numbers parameter node.
Notice: You cannot send should you format numbers as +905321234567, 532 123 45 67, +05321234567 and use -, ( ), [ ], { } and etc. characters. |
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: The Originator statement cannot contain Turkish characters and &, <, >, -, ( ), [ ], / signs. |
Mobildev Web Services offers 2 reporting options for the SMS sent:
Reporting For A Period Of Time
public ReportResult DateReport(string username, string company_code, string password, string fDate, string eDate)
Used for reporting between 2 dates specified.
Values Sent:
string username: refers to user name associated with your Mobildev SMS account..
string company_code: refers to the channel code associated with your Mobildev SMS account.
string password: refers to password for your SMS user name.
string FDate: refers to the starting date of the report. Valid format: 2012-01-25 (YearMonthDay)
string eDate: refers to the ending date of the report. Valid format: 2012-01-31 (YearMonthDay)
Sample SOAP Object
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DateReport xmlns="http://tempuri.org/">
<username>test</username>
<company_code>mb1000</company_code>
<password>1234</password>
<fDate>2012-01-25</fDate>
<eDate>2012-01-31</eDate>
</DateReport>
</soap:Body>
</soap:Envelope>
Return Values
TimerID: Refers to the ID of the message package sent. TimerID is the number that is automatically assigned to the SMS packages.
GSMNo: Refers to the GSM number that the message is sent to. Example GSM No 00905321234567
StatusCode: Refers to the status of the message. Status information "1" means that the message is waiting, "2" means that it is sent, "3" means that the message was not sent.
Status Text: Refers to the text format of status information.
Sample SOAP Object:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DateReportResponse xmlns="http://tempuri.org/">
<DateReportResult>
<Status>int</Status>
<StatusString>string</StatusString>
<ReportInfos>
<ReportInfo>
<TimerID>11</TimerID>
<GSMNo>05321234567</GSMNo>
<StatusCode>string</StatusCode>
<StatusText>string</StatusText>
</ReportInfo>
<ReportInfo>
<TimerID>11</TimerID>
<GSMNo>05321234567</GSMNo>
<StatusCode>string</StatusCode>
<StatusText>string</StatusText>
</ReportInfo>
</ReportInfos>
</DateReportResult>
</DateReportResponse>
</soap:Body>
</soap:Envelope>
Notice Regarding OTP Service Usage
API integration for both the OTP Service and the Bulk SMS are exactly the same. While activating the Bulk SMS account, definitions will also be made for OTP Service.
Notice: As OTP SMS is used in only sending passwords and instant notification passwords, no Bulk SMS should be sent. |
Error Code | Description |
01 | Incorrect User Name |
02 | Insufficient credits |
06 | Undefined Originator Information |
07 | Missing message code (ID) |
08 | No SMS were sent for the given dates |
09 | Date fields are empty - incorrect |
10 | SMS was not sent |
11 | Unidentified error |
13 | No user was specified for the report |
14 | Message length exceeds 160 characters |
15 | Package size cannot exceed 30.000 |
Get A Test AccountI Have a Project! |