HTTP API
SMS API MODULE -user V.3
Integrate your business through SMS solution
Contents
I.
Send SMS.
I.1. Send an SMS.
I.2. Send SMS by Group.
II. PHONE BOOK.
II.1. Add Phone Book.
II.2. Edit Phone Book.
II.3. Delete Phone Book.
II.4. Get Contact List.
II.5. Get Contact List by Group.
II.6. Get Complete Data.
II.6. Find Name.
II.7. Find Phone Number.
III. Group.
III.1. Add Group.
III.2. Edit Group.
III.3. Delete Group.
III.4. Get List of Group.
III.5. Find Group.
IV. User Account.
IV.1. Checking Customer Account Balance.
IV.1. Change Password.
V. Return Code.
VI. Example with PHP.
I. Send SMS
I.1. Send an SMS
Purpose : To Send an SMS
Syntax:
http://<server_name>:8080/web2sms/api/sendSMS.aspx?username=xxx&mobile=xxx&message=xxx&auth=xxxx
Example:
http://<server_name>:8080/web2sms/api/sendSMS.aspx?username=sms&mobile=08126531971&message=Hallo
Apa Khabar&auth=cd377b32c5745f89a53f6970d2f49969
Parameter Description
Username Username provided to user to connect to our service
Mobile Destination mobile number
Message Text Message
Auth Authentication with formula :
MD5(username+password+Mobile)
I.2. Send SMS by Group
Purpose : To Send SMS to a Group
Syntax:
http://<server_name>:8080/web2sms/api/SendSMSGroup.Aspx?group=xx&msg=xx&username=xx&auth=xx
Example:
http://<server_name>:8080/web2sms/api/SendSMSGroup.Aspx?group=Kelas 2D&msg=Besok
ulangan BAB II&username=sman1&auth=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
Group Group name
Msg Text Message
Username Username provided to user to connect to our service
Auth Authentication with formula :
MD5(username+password)
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
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
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)
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
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&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)
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&size=xx
&group=xxx&auth=xxxx
example :
http://<server_name>:8080/web2sms/api/phbk_getList.aspx?page=6&size=10&username=sms&group=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)
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=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
name Name to search
Username Username provided to user to connect to our service
Auth MD5(Username+password)
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=e470afc416e70a44bb4e194685777255
Parameter Description
Id Group ID
Username Username provided to user to connect to our service
Auth MD5(id+password)
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&auth=xx
example :
http://<server_name>:8080/web2sms/api/groupGetList.aspx?page=1&size=5&username=sms&auth=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=ffb09fcbd7b381d0ff6ae1609111d437
Parameter Description
group Group Name
Username Username provided to user to connect to our service
Auth MD5(username+password)
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
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
Username Username provided to user to connect to our service
newpass New Password
Auth MD5(username+oldpassword)
V. 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 Phone Number
1707 Invalid Message
1708 Insufficient Credit
1709 Group Empty
1711 Invalid Group Name
1712 Invalid Group ID
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).
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);
curl_close($curlHandle);
return $content;
}
//Main Program
$urlku="http://<server_name>:8080/web2sms/creditsleft.aspx?username=xxx&password=xxx";
$grab = getURL($urlku);
echo "Your Credit Balance : ".$grab;
?>
V2.0-11/03/10