Scribd
Upload
181 views

Jawalbsms Ws API

This document describes the Max Media HTTP API for sending SMS messages. It provides details on the basic command structure and parameters required, including user, pass, to, message, and sender. It explains how to send messages to single or multiple recipients, check the balance, and describes possible error codes. The maximum recipients for GET is 100 and POST is 10,000.

Uploaded by

Sara Hesham
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
181 views

Jawalbsms Ws API

This document describes the Max Media HTTP API for sending SMS messages. It provides details on the basic command structure and parameters required, including user, pass, to, message, and sender. It explains how to send messages to single or multiple recipients, check the balance, and describes possible error codes. The maximum recipients for GET is 100 and POST is 10,000.

Uploaded by

Sara Hesham
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

HTTP API Specification V1.

0
18 May 2013
Overview

This technical document is intended for developers who wish to use the Max Media HTTP API for sending
messages, and describes the various programming methods and commands used by developers when using
this API.

This is one of the simpler server based forms of communication to our gateway. It can be used either in the
form of a HTTP POST, or as a URL (GET). We recommend POST for larger data transfer (10,000 mobile
number is the maximum), due to the size limitations of GET. The parameter names are case sensitive.

Note: It is important to read the entire document before contacting the support. Parameters are case
sensitive. All examples shown use HTTP GET.

Basic Command Structure:

URL Comman Authentication Message Parameter


d

http://www.jawalbsms.ws/api.php/sendsms?user=XXXX&pass=XXXX&to=966XXXXXXX&message=XXXX&sender=XXXX
Send a message:

You can send to a single or to multiple destination addresses, multiple destination addresses are separated by
commas ( , ). The destination addresses should be passed in the ‘to’ parameter and separated by commas ( , )
if the message should be delivered to multiple recipients, The basic parameters required are to (the handset
number to which the message is being sent) and text (the content of the message). The maximum number of
recipients for a GET request is 100, while the maximum for the post is 10,000.

Sending command (Sample):


Arabic:
http://www.jawalbsms.ws/api.php/sendsms?user=XXXX&pass=XXXX&to=966XXXXXXXXX&message
=‫&تجربة‬sender=TEST
Note : If the message is a Hex encoded Unicode text add (unicode=u parameter), the same last example should
be.
http://www.jawalbsms.ws/api.php/sendsms?user=XXXX&pass=XXXX&to=966XXXXXXXXX&message
=062A062C063106280629&sender=TEST&unicode=u

English:
http://www.jawalbsms.ws/api.php/sendsms?user=XXXX&pass=XXXX&to=966XXXXXXXXX&message
=SENDING-TEST&sender=TEST

Success Fail
MSG_ID: xxxx | STATUS: Success | Total: xx | Cost: xx Error Code
Query Balance:
This will return the number of credits available on the account.
http://www.jawalbsms.ws/api.php/chk_balance?user=XXXX&pass=XXXX
Errors Code:
Errors Code Short Description
-100 Missing parameters (not exist or empty) Username + password.
-110 Account not exist (wrong username or password).
-111 The account not activated.
-112 Blocked account.
-113 Not enough balance.
-114 The service not available for now.
-115 The sender not available (if user have no opened sender).
-116 Invalid sender name
-120 No destination addresses, or all destinations are not correct

Parameters:
Parameter Name Mandatory Description
user yes User Name
pass yes Password
to yes The number of the handset to which the message must be
delivered. The number should be in international number
format. If there is more than one, the numbers should be
separated by commas.
message yes The text content of the message.
sender yes The sender address that the message will appear to come from
also known as “Sender ID”. These must be registered within
your account and approved by us before they may be used.

You might also like