vzool/malath_sms

Malaz SMS PHP API

Malath SMS API for PHP Composer

, _(*1)

Installation

composer require vzool/malath_sms

Extension: ext-curl is required., _(*2)

Usage

Add sender

$DTT_SMS = new Vzool/Malath/Malath_SMS($UserName, $Password, 'UTF-8');
$Send = $DTT_SMS->AddSender($Name);

Check UserName & Password

$DTT_SMS    = new Vzool/Malath/Malath_SMS($UserName, $Password, 'UTF-8');
$CheckUser  = $DTT_SMS->CheckUserPassword();

Send SMS

$DTT_SMS    = new Vzool/Malath/Malath_SMS($UserName, $Password, 'UTF-8');
$Send = $DTT_SMS->Send_SMS($Mobiles, $Originator, $SMS_Msg);

HTTP Request Documentation:

1. Description – Bulk SMS.
2. HTTP Connectivity.
3. History.
4. SMS Specifications.
5. HTTP URLs.

a. Check User Name and Password., _(*3)

b. Sending Process - Single & Multiple Messages URL., _(*4)

c. Balance query., _(*5)

d. Send Scheduled Message., _(*6)

e. Insert Main Group., _(*7)

f. Insert Sub Group., _(*8)

g. Add Contact to Group., _(*9)

h. add sender name., _(*10)

I. Review sender name., _(*11)

Bulk SMS

In an era of rapid technological advancements, mode of, _(*12)

communication is becoming lot more sophisticated. A new and, _(*13)

modern way of reaching your target market and communicating, _(*14)

them is through SMS (Short Messaging Service). Malath SMS, _(*15)

offers you this mode of communication through its bulk SMS, _(*16)

service., _(*17)

Bulk SMS service reaches your target audience at a very, _(*18)

economical price, putting behind the conventional mode of, _(*19)

advertising that costs you in multiples compared to SMS service., _(*20)

High Speed messaging in world, yet simple and reliable. We provide, _(*21)

you the fastest messaging solutions allowing the organizations to, _(*22)

communicate with their clients on urgent and personal basis., _(*23)

HTTP Connectivity

This document covers the HTTP method of connectivity. Additional, _(*24)

documents are available for other types of connectivity., _(*25)

This is one of the simpler server-based forms of communication to, _(*26)

with our gateway. It can be used either in the form of a HTTP POST, _(*27)

or as an URL. We recommend POST for larger data transfer, due, _(*28)

to the size limitation of GET., _(*29)

Communication to our API can be done via HTTP on port 80. All, _(*30)

calls to the API must be URL-encoded., _(*31)

The beauty and add-on advantage of http connectivity is that you, _(*32)

can check or access the gateway even on web based applications., _(*33)

The parameter names are case-sensitive, so it is important to read, _(*34)

entire document prior to seeking assistance from IBS., _(*35)

History, _(*36)

This part of URL deals with the messages history and that, _(*37)

includes the messages delivered and outstanding. The beauty and, _(*38)

add-on advantage of http connectivity is that you can check or, _(*39)

access the gateway even on web based applications., _(*40)

Login to http://sms.malath.net.sa to history. You can check, _(*41)

whether messages are delivered or outstanding., _(*42)

SMS Specifications, _(*43)

Unicode:, _(*44)

Single Message: A message in Unicode format can contain up to, _(*45)

70 characters., _(*46)

Multiple Message: Once the message exceeds more than 70, _(*47)

characters it would be sent in multiples with 67 characters in each, _(*48)

message., _(*49)

English:, _(*50)

Single Message: A message in English format can contain up to, _(*51)

160 characters., _(*52)

Multiple Message: Once the message exceeds more than 160, _(*53)

characters it would be sent in multiples with 134 characters in, _(*54)

each message., _(*55)

HTTP URLS

A- Check User Name and Password

You can check your user name and password from API., _(*56)

URL for Check User Name and Password
http://sms.malath.net.sa/apis/users.aspx?code=1&username=xxxx&password=xxxx

Return Codes, _(*57)

3101

Success

3102

Wrong Password

3103

User Name Don’t Exist

3104

Account Inactive

3105

Missing Parameter

B- Sending Process:, _(*58)

Unicode:, _(*59)

URL for Single SMS service
http://sms.malath.net.sa/httpSmsProvider.aspx?username=xxxxxx&password=xxxxxx&mobile= 9665 x
xxxxx&unicode=U&message=062A062C
0020062C064806270644&sender=your sender name here

URL for Multiple SMS service
http://sms.malath.net.sa/httpSmsProvider.aspx?username=xxxxxx&password=xxxxxx&mobile=9665x
xxxxx,9665xxxxxx&unicode=U&message=062A062C
8064206390020062C064806270644&sender=your sender name here

In this URL for sending on multiple mobile you have to separate with comma(,)

Note: must be active your sender name before do any test., _(*60)

English:, _(*61)

URL for Single SMS service [http://sms.malath.net.sa/httpSmsProvider.aspx?username=xxxxxx&password=xxxxxx&mobile=9665xxxxxx&unicode=E&message=test from Malath sms&sender=your sender name here](http://sms.malath.net.sa/httpSmsProvider.aspx?username=xxxxxx&password=xxxxxx&mobile=9665xxxxxx&unicode=E&message=test from Malath sms&sender=your sender name here), _(*62)

URL for Multiple SMS service [http://sms.malath.net.sa/httpSmsProvider.aspx?username=xxxxxx&password=xxxxxx&mobile=9665xxxxxx,9665xxxxxx&unicode=E&message= test from Malath sms&sender=your sender name here](http://sms.malath.net.sa/httpSmsProvider.aspx?username=xxxxxx&password=xxxxxx&mobile=9665xxxxxx,9665xxxxxx&unicode=E&message= test from Malath sms&sender=your sender name here), _(*63)

In this URL for sending on multiple mobile you have to separate with comma(,), _(*64)

Note: must be active your sender name before do any test., _(*65)

HTTP Parameters

Username: This is your account username given by Malath SMS, _(*66)

Password: this is password of your account Mobile: This is, _(*67)

recipient mobile number. Format should be like 9665xxxxxx, _(*68)

Unicode: This is the code which represents type of message. The, _(*69)

values will be E for English, U for Unicode. Describe...., _(*70)

Message: Actual message. If this English it will be English. For, _(*71)

sending Unicode, you need to convert into hexacode., _(*72)

Sender: This is sender address. This can be only in English and only, _(*73)

up to 11characters., _(*74)

Return Codes, _(*75)

0

Success

101

Parameter are missing

104

either user name or password are missing or your Account is on hold

105

Credit are not available

106

wrong Unicode

107

blocked sender name

108

missing sender name

C- Balance query:, _(*76)

If you want to know your balance after sending SMS, you can follow, _(*77)

these steps:, _(*78)

1 - Replace the variables in this following link with the suitable, _(*79)

values, and then open it via the browser or any other programming, _(*80)

language., _(*81)

URL for Balance Query service http://sms.malath.net.sa/api/getBalance.aspx?username=xxxxxx&password=xxxxxxxx, _(*82)

Return Codes, _(*83)

Error~ There is a wrong content in the link, _(*84)

Error~ You have not a permission to or your account info is incorrect, _(*85)

D- Send Scheduled Message:, _(*86)

Send Scheduled Message the formate of date and time, _(*87)

date=25/12/2010 , time=18:00 , unicode = U for unicode arabic, _(*88)

and E for English, _(*89)

URL for Send Scheduled Message service in English http://sms.malath.net.sa/apis/users.aspx?code=8&username=xxxx&password=xxxx& mobile=9665xxxxxx&sender=SMS&Date= 28 / 12 /2011&Time=13:00&message=Hi&u nicode=E, _(*90)

URL for Send Scheduled Message service in ARABIC http://sms.malath.net.sa/apis/users.aspx?code=8&username=xxxxx&password=xxx& mobile=9665xxxxxx&sender=SMS&Date= 28 / 12 /2011&Time=13:00&message=062A 062C063106280647002006450646002006450648064206390020062C064806270644&unicode=U, _(*91)

In this URL for sending on multiple mobile you have to separate with comma(,)

Note: must be active your sender name before do any test., _(*92)

Return Codes, _(*93)

Success 3101

Parameter are missing 101

either user name or password are missing or your Account is on hold 104

Credit are not available 105

wrong Unicode 106

blocked sender name 107

missing sender name 108

Block Keyword 109



E- Insert Main Group:

Add Main Group in your Account throw API.

URL for Add Main Group
[http://sms.malath.net.sa/apis/users.aspx?code=4&username=xxxx&password=xxxx&](http://sms.malath.net.sa/apis/users.aspx?code=4&username=xxxx&password=xxxx&)
main=MainGroupname

Return Codes




3101
Success


### 3102




Wrong Password


### 3103




User Name Don’t Exist


### 3104




Account Inactive


### 3105




Missing Parameter


### 3911




Add Group Successive

Add Group Failed 3914

F- Insert Sub Group:, _(*94)

Add Sub Group in your Account throw API., _(*95)

URL for Add Sub Group http://sms.malath.net.sa/apis/users.aspx?code=5&username=xxxx&password=xxxx& main=MainGroupID&sub=SubGroupName, _(*96)

Return Codes, _(*97)

3101
Success

3102

Wrong Password

3103

User Name Don’t Exist

3104

Account Inactive

3105

Missing Parameter

3911

Add Group Successive

Add Group Failed 3914

Wrong Main Group 3913

G- Add Contact to Group:, _(*98)

You can add Contact to your group easily throw API., _(*99)

URL for Add Contact to Group http://sms.malath.net.sa/apis/users.aspx?code=6&username=xxxx&password=xxxx& name=Ahmad,Subhi,Khaled&number=9665555xxx,96659787xxx,9665554544xxx&s ub=, _(*100)

Return Codes, _(*101)

3101

Success

3102

Wrong Password

3103

User Name Don’t Exist

3104

Account Inactive

3105

Missing Parameter

3333

Missing Contact Number Or Contact Name

H - Add Sender Name:, _(*102)

You can add Sender name to your account easily throw API., _(*103)

URL for Check User Name and Password
http://sms.malath.net.sa/apis/users.aspx?code= 2 &username=xxx&password=xxxx&
newsender=xxxxxx

Return Codes, _(*104)

Success 3101

Wrong Password 3102

User Name Don’t Exist 3103

Account Inactive 3104

Missing Parameter 3105

Sender Name Violation Rule 443

Time Out Operation 3405

Sender Name Received 143

Sender Name exist 444

I - Review Sender Names:

You can Review your Sender name easily throw API., _(*105)

URL for Check User Name and Password
http://sms.malath.net.sa/apis/users.aspx?code= 9 &username=xxx&password=xxx

Return Codes, _(*106)

Review

Success (^) senders Wrong Password 3102 User Name Don’t Exist 3103 Account Inactive 3104 Missing Parameter 3105 Time Out Operation 3405, _(*107)

END