SMS API MODULE user V.3.

2
Integrate your business through SMS solution

Contents
I. Send SMS .......................................................................................................................................... 2
I.1. Send an SMS ....................................................................................................................................... 2
I.2. Simple Way to Send an SMS .............................................................................................................. 2
I.3. Send SMS by Group ............................................................................................................................ 2
II. PHONE BOOK ................................................................................................................................... 4
II.1. Add Phone Book ................................................................................................................................ 4
II.2. Edit Phone Book ............................................................................................................................. .. 4
II.3. Delete Phone Book............................................................................................................................ 5
II.4. Get Contact List ................................................................................................................................. 5
II.5. Get Contact List by Group ................................................................................................................. 5
II.6. Get Complete Data ............................................................................................................................ 6
II.6. Find Name ......................................................................................................................................... 6
II.7. Find Phone Number .......................................................................................................................... 6
III. Group............................................................................................................................................. 7
III.1. Add Group ........................................................................................................................................ 7
III.2. Edit Group ........................................................................................................................................ 7
III.3. Delete Group .................................................................................................................................... 7
III.4. Get List of Group ................................................................................................ .............................. 8
III.5. Find Group........................................................................................................................................ 8
IV. User Account .................................................................................................................................. 9
IV.1. Checking Customer Account Balance .............................................................................................. 9
IV.1. Change Password .............................................................................................................................. 9
V. Report ........................................................................................................................................... 10
V.1. Query Status .................................................................................................................................... 10
V.2. Delivery Report ............................................................................................................................... 10
VI. Return Code ................................................................................................................................. 11
VI. Example with PHP ........................................................................................................................ 12

API Documentation - http://server.dutasms.com:8080/web2sms Page 1

 I. Send SMS
I.1. Send an SMS

Purpose : To send sms by sending encrypted passwords and Client trxID to avoid duplicate sms Syntax:
http://<server_name>:8080/web2sms/api/sendSMS.aspx?username=xxx&mobile=xxx&message=xx
x&auth=xxxx&trxid=xxxx&type=x

Example:
http://<server_name>:8080/web2sms/api/sendSMS.aspx?username=sms&mobile=08126531971&me
ssage=Hallo+world&auth=cd377b32c5745f89a53f6970d2f49969&trxid=sms0000000001&type=0

Parameter Description
Username Username provided to user to connect to our service
Mobile Destination mobile number , Indonesian (08xxxxx) or international (628xxxx) format.
Message Text Message (encoded, max 5000 chars)
Auth Authentication with formula :
MD5(username+password+Mobile)
trxID Client TrxID, used to avoid duplicate sms (Optional, max 50 char, type string)
type 0 (or missing) ascii text message (normal message)
3 Unicode message (Arabic, Japan, Chinese, etc)
Note :
1. For the account type of numeric sender id (sms standard), unicode supported by all operators.
Alpha sender account, unicode is not supported by Telkomsel and XL.
2. When the type of message is Unicode (3), then the message must be in hexadecimal format.
For Example :
Hexadecimal : 30533093306B3061306F4E16754C

I.2. Simple Way to Send an SMS

Purpose : The simple way to send an SMS Syntax:

http://<server_name>:8080/web2sms/api/Send.aspx?username=xxx&mobile=xxx&message=xxx&p
assword=xxxx

Example:
http://<server_name>:8080/web2sms/api/sendSMS.aspx?username=sms&mobile=08126531971&me
ssage=Hallo+World&password=123456

Parameter Description
Username Username provided to user to connect to our service
Mobile Destination mobile number
Message Text Message (encoded, max 5000 chars)
Password Your Login Password

I.3. Send SMS by Group

API Documentation - http://server.dutasms.com:8080/web2sms Page 2

 Purpose : To Send SMS to a Group Syntax:
http://<server_name>:8080/web2sms/api/SendSMSGroup.Aspx?group=xx&msg=xx&username=xx&a
uth=xx

Example:
http://<server_name>:8080/web2sms/api/SendSMSGroup.Aspx?group=Marketing&msg=Hello+wor
ld&username=sman1&auth=ffb09fcbd7b381d0ff6ae1609111d437

Parameter Description
Group Group name (encoded)
Msg Text Message (encoded, max 160 chars)
Username Username provided to user to connect to our service
Auth Authentication with formula :
MD5(username+password)

API Documentation - http://server.dutasms.com:8080/web2sms Page 3

 II. PHONE BOOK
II.1. Add Phone Book

Purpose : Add new contact to phone book :

Syntax:
http://<server_name>:8080/web2sms/api/phbkAdd.aspx?username=xxx
&name=xxx&mobile=xxx&group=xxx&address=xxx&birth=xxx&desc=xxx&auth=xxxx

Example :
http://<server_name>:8080/web2sms/api/phbkAdd.aspx?username=sms&name=Rudi
&mobile=08123456&group=Office&address=Jl. Bali&birth=19450817&desc=Direktur
Utama&auth=cd377b32c5745f89a53f6970d2f49969

Parameter Description
Username Username provided to user to connect to our service
Name Contact Name
Mobile Contact mobile number
Group Contact Group Member
Address Contact Address
Birth Contact Birthday (YYYYMMDD)
Desc Contact Description
Auth MD5(Mobile+Password)
Note : Address, Birth and Desc are optional

II.2. Edit Phone Book

Purpose : Edit existing Contact. Syntax:

http://<server_name>:8080/web2sms/api/phbkEdit.aspx?id=xxx&username=xxx
&name=xxx&mobile=xxx&group=xxx&address=xxx&birth=xxx&desc=xxx&auth=xxxx

example :
http://<server_name>:8080/web2sms/api/phbkEdit.aspx?id=372880&username=sms&name=Yuli&
mobile=06177123454&group=Bos&address=Jl. Pati 3&birth=17 aug 2010&desc=senang main
golf&auth=3097dc123edc537e80b01b4abf1b20ef

Parameter Description
Id Contact ID Number
Username Username provided to user to connect to our service
Name Contact Name
Mobile Contact mobile number
Group Contact Group Member
Address Contact Address
Birth Contact Birthday (dd mmm yyyy)
Desc Contact Description
Auth MD5(id+password)

API Documentation - http://server.dutasms.com:8080/web2sms Page 4

 II.3. Delete Phone Book

Purpose : Delete existing contact

http://<server_name>:8080/web2sms/api/phbkDelete.aspx?id=xxx&username=xxx&
auth=xxxx

example :
http://<server_name>:8080/web2sms/api/phb_add.aspx?username=sms&name=Rudi
&mobile=08123456&group=Office&address=Jl. Bali&birth=19450817&desc=Direktur
Utama&auth= cd377b32c5745f89a53f6970d2f49969

Parameter Description
Id Contact ID Number
Username Username provided to user to connect to our service
Auth MD5(id+password)

II.4. Get Contact List

Purpose : To get contact list

http://<server_name>:8080/web2sms/api/phbk_getList.aspx?username=xxx&page=xx&size=xx
&auth=xxxx

example :
http://<server_name>:8080/web2sms/api/phbk_getList.aspx?page=6&size=10&username=sms&a
uth=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
Username Username provided to user to connect to our service
page Page Number (default=1)
size number of records per page (default=10)
Auth MD5(Username+password)

II.5. Get Contact List by Group

Purpose : To get Contact list by Group Name

http://<server_name>:8080/web2sms/api/phbk_getListbyGroup.aspx?username=xxx&page=xx&s
ize=xx &group=xxx&auth=xxxx

example :
http://<server_name>:8080/web2sms/api/phbk_getList.aspx?page=6&size=10&username=sms&g
roup=client&auth=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
Username Username provided to user to connect to our service
page Page Number (default=1)
size number of records per page (default=10)
group Group Name
Auth MD5(Username+password)

API Documentation - http://server.dutasms.com:8080/web2sms Page 5

 II.6. Get Complete Data

Purpose : To retrieve contact detail

http://<server_name>:8080/web2sms/api/phbk_getListbyGroup.aspx? ID=xx&username=xxx
&auth=xxxx

example :
http://<server_name>:8080/web2sms/api/phbk_getCompleteData.aspx?
id=6928&username=sms&auth=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
id Contact ID
Username Username provided to user to connect to our service
Auth MD5(Username+password)

II.6. Find Name

Purpose : To search contact by name

http://<server_name>:8080/web2sms/api/ phbk_findName.aspx?name=xx&username=xx&auth=xx

example : http://<server_name>:8080/web2sms/api/
phbk_findName.aspx?name=sar&username=smsoke&auth=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
name Name to search
Username Username provided to user to connect to our service
Auth MD5(Username+password)

II.7. Find Phone Number

Purpose : To search contact by Phone Number

http://<server_name>:8080/web2sms/api/phbk_findPhNumber.aspx?no
=xx&username=xx&auth=xx

example : http://<server_name>:8080/web2sms/api/
phbk_findPhNumber.aspx?no=0812653&username=smsoke&auth=ffb09fcbd7b381d0ff6ae1609111d4
37
Parameter Description
name Name to search
Username Username provided to user to connect to our service
Auth MD5(Username+password)

API Documentation - http://server.dutasms.com:8080/web2sms Page 6

 III. Group
III.1. Add Group

Purpose : Add a new Group Name Syntax

http://<server_name>:8080/web2sms/api/groupAdd.aspx?group=xx&username=xx&auth=xxx
example :
http://<server_name>:8080/web2sms/api/groupAdd.aspx?group=Calon
Client&username=sms&auth=b25a52012483379060de8618dd9d7378
Parameter Description
group Group Name
Username Username provided to user to connect to our service
Auth MD5(group+password)

III.2. Edit Group

Purpose : Edit an existing Group Syntax

http://<server_name>:8080/web2sms/api/groupEdit.aspx?id=xx&group=xx&username=xx&auth=
xxx
example :
http://<server_name>:8080/web2sms/api/groupEdit.aspx?id=849&group=Teman&username=sms&
auth=e470afc416e70a44bb4e194685777255
Parameter Description
Id Group ID
group Group Name
Username Username provided to user to connect to our service
Auth MD5(id+password)

III.3. Delete Group

Purpose : Delete an existing Group

Syntax
http://<server_name>:8080/web2sms/api/groupDelete.aspx?id=xx&username=xx&auth=xx
example :
http://<server_name>:8080/web2sms/api/groupDelete.aspx?id=849&username=sms&auth=e470a
fc416e70a44bb4e194685777255
Parameter Description
Id Group ID
Username Username provided to user to connect to our service
Auth MD5(id+password)

API Documentation - http://server.dutasms.com:8080/web2sms Page 7

 III.4. Get List of Group

Purpose : Retrieve list of existing Group Syntax

http://<server_name>:8080/web2sms/api/groupGetList.aspx?page=xx&size=xx&username=xx&a
uth=xx
example :
http://<server_name>:8080/web2sms/api/groupGetList.aspx?page=1&size=5&username=sms&au
th=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
page Page number
size Number of record per page
Username Username provided to user to connect to our service
Auth MD5(username+password)

III.5. Find Group

Purpose : Find a Group Syntax

http://<server_name>:8080/web2sms/api/groupFind.aspx?group=xx&username=xx&auth=xx
example :
http://<server_name>:8080/web2sms/api/groupFind.aspx?group=pul&username=sms&auth=ffb0
9fcbd7b381d0ff6ae1609111d437
Parameter Description
group Group Name
Username Username provided to user to connect to our service
Auth MD5(username+password)

API Documentation - http://server.dutasms.com:8080/web2sms Page 8

 IV. User Account
IV.1. Checking Customer Account Balance

Purpose : Retrieve account balance

http://<server_name>:8080/web2sms/api/creditsleft.aspx?username=xxx&auth=xxx

Parameter Description
Username Username provided to user to connect to our service
Password Password to the service
Auth MD5(username+password)

IV.1. Change Password

Purpose : To change password

http://<server_name>:8080/web2sms/api/ChangePassword.aspx?username=xxx&newpasw
=xx&auth=xxx

Parameter Description
Username Username provided to user to connect to our service
newpass New Password
Auth MD5(username+oldpassword)

API Documentation - http://server.dutasms.com:8080/web2sms Page 9

 V. Report
V.1. Query Status

Purpose : To get delivery status

http://<server_name>:8080/web2sms/api/Report.aspx?msgid=xxx

Parameter Description
msgid Msg ID

V.2. Delivery Report

For users who require Delivery Report on their URL they need to provide the URL in the form as below

http://<hostname>:port/dlr.php? msgid=%id&status=%s

Here
<hostname> means the IP or the domain name
<Port> means the Port number if given
%id means the msgid. %id will be replaced by the msgid.

%s means the status of the message. %s will be replaced by DELIVRD,UNDELIVRD, REJECTED or EXPIRED.

DLR URL will be using the get method to call the URL provided

API Documentation - http://server.dutasms.com:8080/web2sms Page 10

 VI. Return Code
HTTP Return Code:
Return Code Description
1701 Success
1702 Invalid Username or Password
1703 Internal Server Error
1704 Data not found
1705 Process Failed
1706 Invalid Message
1707 Invalid Number
1708 Insufficient Credit
1709 Group Empty

1711 Invalid Group Name

1712 Invalid Group ID
1713 Invalid msgid

1721 Invalid Phonebook Name

1722 Invalid Phonebook ID

1731 User Name already exist

1732 Sender ID not valid
1733 Internal Error please contact administrator
1734 Invalid client user name
1735 Invalid Credit Value

Notes:
1. For searching, only return the first 10 rows
2. Each field delimited with Char(128), and records delimited with char(129).

API Documentation - http://server.dutasms.com:8080/web2sms Page 11

 VI. Example with PHP
<?
function getURL($url) {
$curlHandle = curl_init(); // init curl
curl_setopt($curlHandle, CURLOPT_URL, $url); // set the url to fetch
curl_setopt($curlHandle, CURLOPT_HEADER, 0);
curl_setopt($curlHandle, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curlHandle, CURLOPT_TIMEOUT,30);
curl_setopt($curlHandle, CURLOPT_POST, 0);
$content = curl_exec($curlHandle);

if(!$content){
return 'Curl error: ' . curl_error($curlHandle);
}
Else {
return $content;
}

curl_close($curlHandle);
}

//Your Data Here

$mobile="62812xxxxxx";
$msg="Hallo World!";

$user="your user id";

$password="your password";

$auth=MD5($user.$password.$ mobile);
$msg=urlencode($msg);

$myurl=http://server.dutasms.com:8080/web2sms/api/SendSMS.aspx?username="
.$user."&mobile=".$mobile."&m essage=".$msg."&auth=".$auth;
$grab = getURL($myurl);
echo $grab;

?>

Change log:
20130515, v3.2
* SendSMS.aspx, support for long sms (up to 5000 chars) and unicode (Arabic, Japanese, Chinese, etc) sms
* Send.aspx, support long sms (up to 5000 chars)

20110322, v3.1
*sendSMS.aspx, parameters trxID added.
*Send.aspx, new api, simple way to send SMS
*Status Report

API Documentation - http://server.dutasms.com:8080/web2sms Page 12