Scribd
Upload
190 views

Quick Web API Guide: Table of Parameters

This document provides instructions for accessing an HTTPS SMS gateway API to send SMS messages. The API can be accessed by submitting a POST or GET request to a target URL containing the assigned account name. Parameters like the username, password, recipient number, and message text need to be included. The API supports sending single messages or bulk messages to multiple recipients in a single request. Response codes indicate if messages were accepted, queued, or errored.

Uploaded by

Mohamed Abikar Nor
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
190 views

Quick Web API Guide: Table of Parameters

This document provides instructions for accessing an HTTPS SMS gateway API to send SMS messages. The API can be accessed by submitting a POST or GET request to a target URL containing the assigned account name. Parameters like the username, password, recipient number, and message text need to be included. The API supports sending single messages or bulk messages to multiple recipients in a single request. Response codes indicate if messages were accepted, queued, or errored.

Uploaded by

Mohamed Abikar Nor
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

Quick Web API Guide

This document is intended for clients who wish to develop applications that make use of our HTTPS
SMS gateway. You may access our HTTPS gateway by submitting either a POST or GET to the API
server.
Target URL: https://esahal.com/XXX/sms.php (where XXX is your ACCOUNT NAME)
Once your account has been established, you will be assigned an Account Name. Replace the XXX in
the above URL with the Account Name that has been sent to you.
Table of Parameters
Parameter

Description

Nullable

user

The username you have been assigned.

No

password

Your account password.

No

acct

The account ID you have been assigned.

No

to

The number of the handset mobile# (MSISDN) to which the message


must be delivered. The number should be in international number
format.

No

from

The Client name or number the message will appear to come from.
Please NOTE our system overwrites this value with a unique MSISDN
number to avoid SPAM.

Yes

ref

This is an optional field to facilitate auditing/reconciliation of itemized


traffic. The Client may send a unique identifying transaction ID along
with each message.

Yes

Max length: 30 Characters


msg

The content of the message. This should not be longer than 140-160
characters depending on the destination wireless network.

Please note:

ALL Parameters are case-sensitive.

Here are the response codes from the eSahal Gateway:


0: Accepted for delivery
1: Queued for delivery
2: Error (Required Parameters missing)
3: Error (Invalid MSISDN - number format)
4: Error (Unroutable message)
5: Error (Authentication Failure)
6: Error (Message content)
7: Error (Firewall Block)
8: Account Credit Limit Reached

2015

eSahal PTE. Ltd. 1 North Bridge Road, #07-02 High ST CTR, Singapore 179094

Yes

Bulk SMS
Target URL: https://esahal.com/XXX/bulk.php (where XXX is your ACCOUNT NAME)
Table of Parameters
Parameter

Description

Nullable

user

The username you have been assigned.

No

password

Your account password.

No

acct

The account ID you have been assigned.

No

bulk

The number of the handset mobile# (MSISDN) to which the message


must be delivered. The number should be in international number
format.
Example:

No

bulk=[ {"to":"+224543545345"},{"to":"+343243244"},
{"to":"+192543545345"},{"to":"00254743545345"},
{"to":"+44543545345"} ...]

from

The Client name or number the message will appear to come from.
Please NOTE our system overwrites this value with a unique MSISDN
number to avoid SPAM.

Yes

ref

This is an optional field to facilitate auditing/reconciliation of itemized


traffic. The Client may send a unique identifying transaction ID along
with each message.

Yes

Max length: 30 Characters

msg

The content of the message. This should not be longer than 140-160
characters depending on the destination wireless network.

Yes

utf

If your message is ecoded in NON latin characters, you may use


Unicode format (UTF-8) . Set utf=1 if msg is in unicode.

Yes

Please note:

ALL Parameters are case-sensitive.


The maximum size of the "bulk" parameter is 50 mobile numbers per request.

2015

eSahal PTE. Ltd. 1 North Bridge Road, #07-02 High ST CTR, Singapore 179094

You might also like