Gosmsgateway Http API Sms Center v.1.4

Page 1 of 14

HTTP API Documentation ver. 1.4 | Last Update : 31 Juli 2015 11:56 - www.GoSMSGateway.com

SMS API MODULE Version V.1.4 Integrate your business with sms gateway

Prepared By :

GoSMSGateway.com Internet SMS Gateway Service Provider http://www.gosmsgateway.com

2015

Page 2 of 14


Contents

A. SEND SMS ............................................................................................................................................. 3

A.1. Send an SMS .............................................................................................................................. 3

A.2. Simple Way to Send an SMS ................................................................................................... 4

A.3 Send SMS by Group .................................................................................................................. 4

B. PHONE BOOK ....................................................................................................................................... 5

B.1. Add Phone Book ........................................................................................................................ 5

B.2. Edit Phone Book ......................................................................................................................... 5

B.3. Delete Phone Book .................................................................................................................... 6

B.4. Get Contact List .......................................................................................................................... 7

B.5. Get Contact List by Group ........................................................................................................ 7

B.7. Find Name ................................................................................................................................... 8

B.8. Find Phone Number ................................................................................................................... 9

C. GROUP ................................................................................................................................................... 9

C.1. Add Group ................................................................................................................................... 9

C.2. Edit Group ................................................................................................................................. 10

C.3. Delete Group ............................................................................................................................ 10

C.4. Get List of Group ...................................................................................................................... 11

C.5. Find Group ................................................................................................................................ 11

D. USER ACCOUNT ............................................................................................................................... 12

D.1. Checking Customer Account Balance .................................................................................. 12

D.2. Change Password ................................................................................................................... 12

E. REPORT ............................................................................................................................................... 13

E.1. Query Status ............................................................................................................................. 13

Page 3 of 14


A. SEND SMS

A.1. Send an SMS

Purpose : To send sms by sending encrypted passwords and Client trxID to avoid duplicate sms Syntax:

http://api.gosmsgateway.net:88/api/sendSMS.php?username=xxx&mobile=xxx&message=xxx&auth=xxxx&trxid=xxxx&type=x

Example:

http://api.gosmsgateway.net:88/api/[email protected]&mobile=08123456789&message=Hello Word Welcome to SMS Gateway Service Provider In Indonesia&auth=a717473a18a611a77320e4d44413e494&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

Page 4 of 14


A.2. Simple Way to Send an SMS

Purpose : The simple way to send an SMS Syntax:

http://api.gosmsgateway.net:88/api/Send.php?username=xxx&mobile=xxx&message=xxx&p assword=xxxx

Example: http://api.gosmsgateway.net:88/api/[email protected]&mobile=08123456789&message=Hello Word&password=12345

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

A.3 Send SMS by Group

Purpose : To Send SMS to a Group Syntax:

http://api.gosmsgateway.net:88/api/SendSMSGroup.php?group=xx&msg=xx&username=xx&auth=xxx

Example: http://api.gosmsgateway.net:88/api/SendSMSGroup.php?username=info@gosmsgateway. com &group=GROUPA&message=Hello Word&auth=16b36f1bbfe38ccec2e5907abef97646

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

Page 5 of 14


B. PHONE BOOK

B.1. Add Phone Book

Purpose : Add new contact to phone book. Syntax:

http://api.gosmsgateway.net:88/api/phbkAdd.php?username=xxx &name=xxx&mobile=xxx&group=xxx&address=xxx&birth=xxx&desc=xxx&auth=xxxx

Example :

http://api.gosmsgateway.net:88/api/[email protected]&name=KUSTAN&mobile=08123456789&group=GROUPA&address=JAKARTA&birth=19880526&desc=PROGRAMMER&auth=a59d055a4413058645f0f89c7bbb86f4

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

B.2. Edit Phone Book

Purpose : Edit existing Contact. Syntax:

http://api.gosmsgateway.net:88/api/phbkEdit.php?id=xxx&username=xxx &name=xxx&mobile=xxx&group=xxx&address=xxx&birth=xxx&desc=xxx&auth=xxxx

Example :

http://api.gosmsgateway.net:88/api/phbkAdd.php?id=13&[email protected]&name=KUSTAN&mobile=08123456789&group=GROUPB&address=JAKARTA&birth=19880526&desc=PHP PROGRAMMER&auth=a59d055a4413058645f0f89c7bbb86f4

Page 6 of 14


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 (yyyymmdd) Desc Contact Description Auth MD5(id+password)

B.3. Delete Phone Book

Purpose : Delete existing contact Syntax :

http://api.gosmsgateway.net:88/api/phbkDelete.php?id=xxx&username=xxx& auth=xxxx

Example :

http://api.gosmsgateway.net:88/api/phbkDelete.php?id=3&[email protected]&auth=5ece4fe12189630e756da5bbe906b82e

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

Page 7 of 14


B.4. Get Contact List

Purpose : To get contact list Syntax:

http://api.gosmsgateway.net:88/api/phbkGetList.php?username=xxx&page=xx&size=xx &auth=xxxx

Example :

http://api.gosmsgateway.net:88/api/phbkGetList.php?page=1&size=2&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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)

B.5. Get Contact List by Group

Purpose : To get Contact list by Group Name Syntax:

http://api.gosmsgateway.net:88/api/phbkGetListbyGroup.php?username=xxx&page=xx&si ze=xx &group=xxx&auth=xxxx

Example :

http://api.gosmsgateway.net:88/api/phbkGetListbyGroup.php?page=2&size=10&group=GROUPA&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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)

Page 8 of 14


B.6. Get Complete Data Purpose : To retrieve contact detail Syntax :

http://api.gosmsgateway.net:88/api/phbkGetCompleteData.php? ID=xx&username=xxx &auth=xxxx

Example :

http://api.gosmsgateway.net:88/api/phbkGetCompleteData.php?id=1&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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

B.7. Find Name

Purpose : To search contact by name Syntax :

http://api.gosmsgateway.net:88/api/phbkFindName.php?name=xx&username=xx&auth=xx

Example :

http://api.gosmsgateway.net:88/api/phbkFindName.php?name=KUSTAN&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

Parameter Description Name Name to search Username Username provided to user to connect to our service Auth MD5(Username+password)

Page 9 of 14


B.8. Find Phone Number

Purpose : To search contact by Phone Number Syntax :

http://api.gosmsgateway.net:88/api/phbkFindPhNumber.php?no=xx&username=xx&auth=xx

Example :

http://api.gosmsgateway.net:88/api/phbkFindPhNumber.php?no=08123456789&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

Parameter Description No Phone Number to search Username Username provided to user to connect to our service Auth MD5(Username+password)

C. GROUP

C.1. Add Group

Purpose : Add a new Group Name Syntax:

http://api.gosmsgateway.net:88/api/groupAdd.php?group=xx&username=xx&auth=xxx

Example :

http://api.gosmsgateway.net:88/api/groupAdd.php?group=GROUP6&[email protected]&auth=8c27d94b5e03ad4895bccf31aaaa77e0

Parameter Description Group Group Name Username Username provided to user to connect to our service Auth MD5(group+password)

Page 10 of 14


C.2. Edit Group

Purpose : Edit an existing Group Syntax :

http://api.gosmsgateway.net:88/api/groupEdit.php?id=xx&group=xx&username=xx&auth= xxx

Example :

http://api.gosmsgateway.net:88/api/groupEdit.php?id=2&group=NEWGROUPEDIT&[email protected]&auth=2e141f5abc790565dd53e6d92a84160a

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

C.3. Delete Group

Purpose : Delete an existing Group. Syntax :

http://api.gosmsgateway.net:88/api/groupDelete.php?id=xx&username=xx&auth=xx

Example :

http://api.gosmsgateway.net:88/api/groupDelete.php?id=3&[email protected]&auth=5ece4fe12189630e756da5bbe906b82

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

Page 11 of 14


C.4. Get List of Group

Purpose : Retrieve list of existing Group Syntax :

http://api.gosmsgateway.net:88/api/groupGetList.php?page=xx&size=xx&username=xx&a uth=xx

Example :

http://api.gosmsgateway.net:88/api/groupGetList.php?page=2&size=20&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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)

C.5. Find Group

Purpose : Find a Group. Syntax :

http://api.gosmsgateway.net:88/api/ groupFindName.php?group=xx&username=xx&auth=xx

Example :

http://api.gosmsgateway.net:88/api/groupFindName.php?group=GROUPA&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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

Page 12 of 14


D. USER ACCOUNT

D.1. Checking Customer Account Balance

Purpose : Retrieve account balance Syntax :

http://api.gosmsgateway.net:88/api/creditsleft.php?username=xxx&auth=xxx

Example :

http://api.gosmsgateway.net:88/api/[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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

D.2. Change Password

Purpose : To change password Syntax :

http://api.gosmsgateway.net:88/api/ChangePassword.php?username=xxx&newpasw =xx&auth=xxx

Example :

http://api.gosmsgateway.net:88/api/[email protected]&newpass=anonymous&auth=e6b9a978102f5cfab2d3ea06406ce105

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

Page 13 of 14


E. REPORT

E.1. Query Status

Purpose : To get delivery status Syntax :

http://api.gosmsgateway.net:88/api/report.php?idmsg=xx&username=xxx&auth=xxx

Example :

http://api.gosmsgateway.net:88/api/report.php?idmsg=21&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

Parameter Description idmsg Message ID newpass New Password Auth MD5(username+oldpassword)

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

below

Syntax :

http://api.gosmsgateway.net:88/api/reportList.php?page=x&size=x&username=xxx&auth=xx

Example :

http://api.gosmsgateway.net:88/api/reportList.php?page=2&size=10&[email protected]&auth=16b36f1bbfe38ccec2e5907abef97646

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)

Page 14 of 14


F. 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).

For more information please contact us : Email : [email protected] Phone : +62 8999-0000-60

Documents

Gosmsgateway Http API Sms Center v.1.4