Outbound API

 
 
Download Help File
 
 
 
 

Note that all API parameters well sent over GET method to next link

Error Codes

 

Query Countries

Overview
LibyanSMS API allows you to Query about available countries

Sample

Response
Country ID, Country Name , Country Code

236, Yemen, 967
226, United Arab Emirates, 971
219, Tunisia, 216
210, Syria, 963
205, Sudan, 249
200, Somalia, 252
191, Saudi Arabia, 966
178, Qatar, 974
165, Oman, 968
148, Morocco, 212
138, Mauritania, 222
135, Malta, 356
124, Libya, 218
121, Lebanon, 961
117, Kuwait, 965
111, Jordan, 962
103, Iraq, 964
81, Germany, 49
65, Egypt, 20
60, Djibouti, 253
47, Comoros, 269
17, Bahrain, 973
3, Algeria, 213
 

Senders

Overview
Libyansms API allows you to Query your senders and add new senders

Sample

Response

Mostafa, Pending
Ahmed, Activated


 

 

Validation
 

Overview

Libyansms API allows you to validate numbers you will send to.

Note that this page work with POST method

Parameters



Response

Note that Numbers is the true numbers
True:2
Duplicated:0
Wrong:1
Unreachable:2
Cost:0.027138
Numbers:
XXXXXXXXXXXXX,XXXXXXXXXXXX

 

Send SMS

Overview

Libyansms API allows you to send English and Arabic short messages to single mobile number or for your convenience to multiple mobile numbers at once.

Sample Code

English SMS (Single Number)

English SMS (Multiple Numbers)

Unicode SMS (Single Number)

Unicode SMS (Multiple Numbers)

 


Parameters


 

Download Help File

Inbound API

 
 
Download Help File
 
 
 
 
 


 

Note that all API parameters well sent over GET method To next link 


 


Test Inbound API Authentication

Overview

LibyansmsInbound API allows you to Test Authentication

Sample

 

Messages Inbox

Overview

LibyansmsInbound API allows you to Log the message to your smsbulko account inbox and forward
this data to the receiver page that you entered when creating an Inbound API

Sample

Note that all previous tasks and steps is already exist in our 2WaySMS App. 

 

How to Use Inbound API?

5- Now any message will be pushed over inbound API will be receive by smsbulko web portal
in inbox section, and also will be receive by 3rd party APP. receiver that placed in your configuration
 

Inbox

Overview

LibyansmsInbound API allows your mobile Application to send your received messages

Note that the next parameters will sent to your receiver page over Post method

 

Receiver page example


<?php
//The data will received by your receiver page
$sender=$_POST['Sender'];
$country=$_POST['From_Country'];
$message=$_POST['Message'];
$date=$_POST['Message_Receive_Date'];
/* Customized code for example*/
//DB Connection
include 'connect_db.php';

//Insert data to your database
$sqlquery=" INSERT INTO `requests`(`Requested_National_ID`,`Request_Date`,
`Country_To_Relpy`,`Number_To_Relpy`,`Is_Replied`)
VALUES ('$message','$date','$country','$sender','0')";
$r= mysql_query($sqlquery);
?>
 

 

Download Help file
 
 
 

Authorize Application API

Overview

Libyansms API allows you to use your Libyansms account with any application registered with us.

General Parameters

 
 
Download Help File
 
 
 
 

Sample

Response

Your authorization completed successfully

Response (when wrong token)

This application is not registered with us

Note that all API parameters well sent over GET method to next link

Query if authorized by guid

Overview

Libyansms API allows you to Query if application is authorized to use Libyansms account

Sample

Response

1 (if guid or token not exist)

0 (ifguid and token exist but not authorized)

-1(if guid and token exist and authorized)

Username



API Common Parameters


API Actions


Error Codes

Topup

Overview

Libyansms API allows you to charge your mobile balance over your Libyansms account balance.

Parameters

Sample

Response (when action=1)

Value,Cost in $,Currency of Value

10,3.07,EGP

20,6.09,EGP

25,7.58,EGP

50,15.14,EGP

100,30.24,EGP

Response (when action=2)

Your Number Charged Successfully

 

Charge

Overview

Libyansms API allows you to charge your Libyansms account balance.

Parameters

Sample

Response

Congratulations, your account charged successfully

Balanceis: 100 Points

 


Query cities

Overview

Libyansms API allows you to Query about available cities

Sample

Response

Country ID, City Name, City ID

61, Ad Daqahliyah, 1
61, Al Bahr al Ahmar, 2
61, Al Buhayrah, 3
61, Al Fayyum, 4
61, Al Gharbiyah, 5
61, Al Iskandariyah, 6
61, Al Ismailiyah, 7
61, Al Jizah, 8
61, Al Minufiyah, 9
61, Al Minya, 10
61, Al Qahirah, 11
61, Al Qalyubiyah, 12
61, Al Wadi al Jadid, 13
61, Ash Sharqiyah, 14
61, As Suways, 15
61, Aswan, 16
61, Asyut, 17
61, BaniSuwayf, 18
61, Bur Said, 19
61, Dumyat, 20
61, Kafr ash Shaykh, 21
61, Matruh, 22
61, Qina, 23
61, Suhaj, 24
61, JanubSina, 25
61, ShamalSina, 26

 

Query countries

Overview

Libyansms API allows you to Query about available countries

Sample


Response

Country ID, Country Name , Country Code
236, Yemen, 967
226, United Arab Emirates, 971
219, Tunisia, 216
210, Syria, 963
205, Sudan, 249
200, Somalia, 252
191, Saudi Arabia, 966
178, Qatar, 974
165, Oman, 968
148, Morocco, 212
138, Mauritania, 222
135, Malta, 356
124, Libya, 218
121, Lebanon, 961
117, Kuwait, 965
111, Jordan, 962
103, Iraq, 964
81, Germany, 49
65, Egypt, 20
60, Djibouti, 253
47, Comoros, 269
17, Bahrain, 973
3, Algeria, 213

 

Query logs

Overview

Libyansms API allows you to Query your logs

Parameters

Sample

Response (when action=1)

PriceInPoints,Phone_Numbers,Length, Sender_Name, Message_Time,Message_Text,
Message_Type,Message_Status
0.0279,1,1,Alafdl.com,2013-09-02 18:15:35,in the name of allah,API,Sent

Response (when action=2)

PriceInPoints,Phone_Numbers,Length, Sender_Name,Message_Time,Message_Text,
Message_Status
0.1787703,1,3,Alafdl.com,2012-12-27 10:25:02,تجربة من مصطفى أسيوط تجربة من مصطفى أسيوط,Sent

Response (when action=3)

Cost,Numbers,Hlr_Date,Hlr_Status
0.02,2,2013-09-09 13:12:09,Success

Response (when action=4)

Cost,Charged_Number,Product,Topup_Date,MessageText,Topup_Status
1.54,201141364147,5 EGP,2013-08-25 12:42:55,hello,Sent

Response (when action=5)

ServicePlan_ID,ChargedValue,Time,Charge_Type,Charge_Method,U2,Charged_Card
6,500,2013-08-26 16:14:43,Portal,Transfer,ues,


Manage Groups

Overview

Libyansms API allows you to Add-Edit-Delete
Note that this page work with POST method

Parameters

Sample

Response (when action=1)

Group added successfully
True Numbers:…, Duplicate Numbers:…, Unreachable Numbers:…, Wrong Numbers:…

Response (when action=2)

Group updated successfully
True Numbers:…, Duplicate Numbers:…, Unreachable Numbers:…, Wrong Numbers:…

Response (when action=3)

Group deleted successfully

 


Query balance

Overview

Libyansms API allows you to Query about Libyansms account balance

Sample

Response

Your balance is: 100 Points
HLR Cost/Number is: 0.1 Points

 

Query groups

Overview

Libyansms API allows you to Query about user available groups and its details

Parameters

Sample

Response (when action=1)

groupid, groupname,countryid,,group_numbers_count
ex.
19, Saudia, 178,1
20, Kuwait, 114,5
32, Ahmed.Zayan, 61,2
39, hello, 61,1
40, hello2, 61,3
41, aaa, 61,2,
42, bbb, 61,2
45, ccc, 61,12

Response (when action=2)

groupid, groupname,grouptype,groupages,groupcountry,groupcity
numbers
ex.
58,new test,1,1,61,1
1010101010,1112131415

 


Schedule

Overview

Libyansms API allows you to Manage scheduled tasks

Parameters

Sample

 

Senders

Overview

Libyansms API allows you to Query your senders and add new senders

Parameters

Sample

Response (when action=1)

Mostafa, Pending
Ahmed, Activated

Response (when action=2)

Your request is successfully applied

 

Validation

Overview

Libyansms API allows you to validate numbers you will send to.
Note that this page work with POST method

Parameters

Response

Note that Numbers is the true numbers
True:2
Duplicated:0
Wrong:1
Unreachable:2
Cost:0.027138
Numbers:
XXXXXXXXXXXXX,XXXXXXXXXXXX

 

 

Send SMS

Overview

Libyansms API allows you to send English and Arabic short messages to single mobile number or for your convenience to multiple mobile numbers at once or to group or multiple groups.

Parameters

Sample Code

English SMS (Single Number)

English SMS (Multiple Numbers)

Unicode SMS (Single Number)

Unicode SMS (Multiple Numbers)

Response

Successful, MSG_ID:1058464521, Total_true_numbers:15 , Balance:105.26

 

Query if authorized by username

Overview

Libyansms API allows you to Query if application is authorized to useLibyansms account

Sample

Response

1 (if username or token not exist)
0 (if username and token exist but not authorized)
-1(if username and token exist and authorized)

 

Query User Data

Overview

Libyansms API allows you to Query about Libyansms account data

Sample

Response

Customer_First,NameCustomer_LastName,Balance,Customer_Country,Customer_Country_ID, Customer_Email,Customer_Tel, Customer_Company

 

Download Help File