HTTP API
Reference Document
Date
Version
28.11.2014
1.0
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 1 / 7
Table of Contents
Features ......................................................................................................................................................... 3
Parameters .................................................................................................................................................... 3
Return Value .................................................................................................................................................. 4
Sample Function Calls.................................................................................................................................... 4
Table - Sending Status ................................................................................................................................... 5
Table - MessageID Code ................................................................................................................................ 6
Reporting ....................................................................................................................................................... 6
Table – Reporting Status ............................................................................................................................... 7
Table – MessageState Code .......................................................................................................................... 7
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 2 / 7
Features
HTTP SMS has following features:



Send a single text message to a single mobile number
Send a single text messages to multi mobile numbers (For each time 150 mobile number limit
applies – This value is subject to change if required)
Send muti text messages to multi mobile numbers (For each time 10 mobile number limit applies
– This value is subject to change if required)
Parameters
There should be a POST sent operation using http/https and related parameters to the URL below.
Parameter values should be URLencoded.
HTTP URL : http://www.biotekno.biR:8080/SMS-Web/HttpSmsSend
List of Parameters
Name
Type
Username
Password
String
String
Msisdns
String
Max
Length
20
20
Required
/Optional
Definition
R
R
User name as defined in the system
Password as defined in the system
Mobile numbers to receive sms.
Use “| “ charecter as seperator.
R
Message list
Messages
String
R
A single message should’nt exceed 160
charecters long. Turkish characters are
not allowed. Also other non-sms
standard characters are not allowed.
If you send many messages to many numbers
use Use “| “ charecter as seperator.
TransmissionID
String
11
R
For defining multiple messages, Use “| “
charecter as seperator.
This is the same as originator.
Orginator should be alpha numeric
only.
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 3 / 7
SendDate
String
19
O
Shows time and date that sending will
begin.
Format: yyyy-MM-dd HH:mm:ss
Warning: If this parameter is missing, the
messages will be sent early as possible.
Return Value
Name
Type
Status
int
MessageIDs
int []
Max Length
Required Definition
/Optional
3
R
10
(for each
MessageID )
R
This is the response for function
call. Please see table “Status
Codes” for more info.
A different Message ID value will
be returned for each message to
be sent.
“| “ charecter is used as
seperator.
Please see “Message ID codes”
table for more information.
Sample Function Calls
•
A single text message to a single mobile number
(url encoded) http://www.biotekno.biz:8080/SMS-Web/HttpSmsSend?Password=testpasswd
&Username=testuser&Msisdns=905057047745&Messages=deneme+mesajidir&Transmissio
nID=test&SendDate=2005-10-21+14%3A05%3A08
Response:
Status=0
MessageIDs=756464245

Single message to multi mobile numbers
(url encoded)
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 4 / 7
http://www.biotekno.biz:8080/SMSWeb/HttpSmsSend?Password=testpasswd&Username=testuser&Msisdns=905057047745|90
7774455&Messages=deneme+mesajidir&TransmissionID=test&SendDate=2005-1021+14%3A05%3A08
Response:
Status=0
MessageIDs=756464245|756464246
•
Multi messages to multi mobile numbers
(url encoded)
http://www.biotekno.biz:8080/SMSWeb/HttpSmsSend?Password=testpasswd&Username=testuser&Msisdns=905057047745|90
7774455&Messages=deneme+mesajidir|selamlar&TransmissionID=test&SendDate=200510-21+14%3A05%3A08
Response::
Status=0
MessageIDs=756464245|756464246
Table - Sending Status
Status Code
0
-5
-6
-7
-8
-9
-10
-15
-99
Definition
Successful
Login error: Problem with one of the following, Username, Password or
TransmissionID
Any of the message values have an error.
SendDate error. It may be due to format is wrong. And SendDate should be
bigger than now.
Msisdn information is missing. None entered.
Message value is missing. None entered.
In order to send multiple messages to multiple mobile numbers.
Msisdn and Message counts should match.
System fault
Unknown error
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 5 / 7
Table - MessageID Code
Return Code
********* (represents code value)
-1
-2
Definition
Every valid message gets a a message ID
Invalid Msisdn
Invalid message text
Reporting
Reporting provides delivery information for messages.
There should be a POST sent operation using http/https and related parameters to the URL below.
Parameter values should be URLencoded.
HTTP URL : http://www.biotekno.biR:8080/SMS-Web/HttpSmsSend
Reporting Parameters
Parameter
Type
Max Length
Required Definition
/Optional
Username
Password
String
String
20
20
R
R
TransmissionID
String
11
R
int []
10 (For each
message ID
value)
R
MessageIDs
Defined Username
Defined Password
Originator ID
The requested message id list.
Use “|” charecter as seperator.
Return Values
Value
Type
Max Length
Required Definition
/Optional
Status
İnt
3
R
MessageStates
int []
2
Z
Response to function call.
Please use status code table.
For each message ID, a
messageState information is
returned. This value shows the
delivery status.
“|” charecter is used as seperator.
Please use MessageState codes
table
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 6 / 7
Sample Function Call
(url encoded)
http://www.biotekno.biz:8080/SMSWeb/HttpSmsReport?Password=testpasswd&Username=testuser&MessageIDs=765464245|76
5464246&TransmissionID=test
Response:
Status=0
MessageStates=2|2
Table – Reporting Status
Code
Definition
0
-3
-4
-5
-15
-99
Successful
Some values don’t match integer definition for MessageID
No MessageID is given.
Login error: Username, Password problems
System failure
Unknown exception
Table – MessageState Code
Codes
Definition
-1
0
1
2
Invalid MessageID
Delivered
Not delivered
In progress
Biotekno Bütünleşik İş Operatörü Teknolojik Çözümler Ticaret Ltd. Şti.
Kayışdağı Cad. Kayaoğlu Plaza No:119 P.K. 34750 Ataşehir / İstanbul
Tel : +90 216 576 38 48 Fax : +90 216 572 62 90 Email : [email protected] Web : www.biotekno.biz
Sayfa 7 / 7
Download

HTTP API Reference Document Date 28.11.2014 Version 1.0 Table