Tawasol SMS / API

Url: https://api.tawasolsms.com/index.php?user=user1&pass=123456&sid=TawasolSMS&mno=966xxxxxx1&text=test sms&type=1
Request Method: GET

Simple Single or Bulk SMS using URL parametrs included username and password. When you send SMS messages using this API, the API will return to you the sent messages’ ID to track them later.

PARAMS

Name	Value	Description
user	user1	username
pass	123456	password
sid	TawasolSMS	Sender Id
mno	966xxxxxxxx1	Mobile number
text	test sms	Message content
type	1	The type of message: 1 - English 2 - Unicode 3 - Special Character 4 - Arabic

Status Codes:

On Failed (Possible Errors):

When a request fails, the system responds with a specific status code indicating the type of error encountered. Below is a list of error codes along with their brief descriptions to help you identify and resolve the issue.

Name	Description
ERROR - HTTP01	Invalid HTTP URL Format
ERROR - HTTP02	Invalid query string
ERROR - HTTP03	Message Submission Failed2
ERROR - HTTP04	Invalid Password
ERROR - HTTP05	Invalid System ID
ERROR - HTTP06	Invalid Sender ID
ERROR - HTTP07	Invalid Type
ERROR - HTTP08	Invalid Message ID
ERROR - HTTP09	Invalid Destination Address
ERROR - HTTP10	Invalid number of messages
ERROR - HTTP11	Requested service is unavailable
ERROR - HTTP12	Submit Failed
ERROR - HTTP13	Query request failed
ERROR - HTTP14	Bind failed
ERROR - HTTP15	Not Authorized for the request.
ERROR - HTTP16	Invalid Request
ERROR - HTTP17	Invalid Message Length
ERROR - HTTP18	INSUFFICIENT CREDITS/BALANCE
ERROR - HTTP19	Invalid DATA CODING SCHEME
ERROR - HTTP20	Invalid ESM
ERROR - HTTP21	Invalid HEADER
ERROR - HTTP22	Invalid Schedule Time
ERROR - HTTP23	Routing Error
ERROR - HTTP24	Exceeded number of Destination
ERROR - HTTP25	No Record Found
ERROR - HTTP26	Account Expired

Example Request:

Url:https://api.tawasolsms.com/index.php?user=user1&pass=123456&sid=TawasolSMS&mno=966xxxxxx1&text=test sms&type=1
    Method: GET

Example Response:

Response Success (200 - OK )


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2503201507578527991"
        ],
        "MessageContent": "test sms",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "Not requested",
        "Recipient": "966xxxxxxxxx1",
        "TimeCreated": "2025-03-20 15:07:57"
    }
}

Response Failure:


{
    "success": "false",
    "message": "ERROR - HTTP07 --> Invalid Type",
    "ip": "1.2.3.4",
    "errorCode": "ER-01",
    "data": []
}

Url: https://api.tawasolsms.com/dlr.php?message_id=2503101521175975331
Request Method: GET

You can track any SMS you have sent using its ID by submitting the Get Message Details by ID API request. The API will return the details of the SMS message you want to track, such as the account ID that sent the SMS, SMS delivery status and the SMS sent date.

PARAMS

Name	Value	Description
username	user	username Id
password	1234567	password
message_id	2503101521175975331	Message Id

Example Request:

url: https://api.tawasolsms.com/dlr.php?message_id=2503101521175975331
Method: GET

Example Response:

Response Success (200 - OK )


{
    "success": true,
    "message_id": "2503101521175975331",
    "status": "DELIVRD",
    "message": "ok",
    "errorCode": "ER-00"
}

Url:https://api.tawasolsms.com/balance.php
Request Method: GET

Through Get Your Current Balance API, you can directly retrieve your current account balance. You can also get the current balance.

Example Request:

url: https://api.tawasolsms.com/balance.php
Method: GET

form data

Name	Value
username	user
password	123123

Example Response:

Response Success (200 - OK )


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "Username": "user",
        "Balance": "964"
    }
}

Url: https://api.tawasolsms.com/group.php?user=user&pass=1234567&sid=TawasolSMS&group=gr3&limit=5&type=1&text=test group sms
Request Method: GET

This API allows users to send an SMS to a predefined group of contacts. The message is sent using the specified sender ID and limited to a specific number of recipients per request.

Example Request:

url:https://api.tawasolsms.com/group.php?user=user&pass=1234567&sid=TawasolSMS&group=gr3&limit=5&type=1&text=test group sms
Method: GET

form data

Name	Value
username	user
password	1234567
sid	TawasolSMS
group	gr3
limit	5
type	1
text	test group sms

Status Codes:

On Failed (Possible Errors):

When a request fails, the system responds with a specific status code indicating the type of error encountered. Below is a list of error codes along with their brief descriptions to help you identify and resolve the issue.

Name	Description
ERROR - HTTP01	Invalid HTTP URL Format
ERROR - HTTP02	Invalid query string
ERROR - HTTP03	Message Submission Failed2
ERROR - HTTP04	Invalid Password
ERROR - HTTP05	Invalid System ID
ERROR - HTTP06	Invalid Sender ID
ERROR - HTTP07	Invalid Type
ERROR - HTTP08	Invalid Message ID
ERROR - HTTP09	Invalid Destination Address
ERROR - HTTP10	Invalid number of messages
ERROR - HTTP11	Requested service is unavailable
ERROR - HTTP12	Submit Failed
ERROR - HTTP13	Query request failed
ERROR - HTTP14	Bind failed
ERROR - HTTP15	Not Authorized for the request.
ERROR - HTTP16	Invalid Request
ERROR - HTTP17	Invalid Message Length
ERROR - HTTP18	INSUFFICIENT CREDITS/BALANCE
ERROR - HTTP19	Invalid DATA CODING SCHEME
ERROR - HTTP20	Invalid ESM
ERROR - HTTP21	Invalid HEADER
ERROR - HTTP22	Invalid Schedule Time
ERROR - HTTP23	Routing Error
ERROR - HTTP24	Exceeded number of Destination
ERROR - HTTP25	No Record Found
ERROR - HTTP26	Account Expired

Example Response:

Response Success (200 - OK )


{
    "success": true,
    "message": "ok",
    "errorCode": "ER-00",
    "BatchId": "2003251625414441831"
}

Response Failure:


{
"success": "false",
"message": "ERROR - HTTP07 --> Invalid Type",
"ip": "1.2.3.4",
"errorCode": "ER-01",
"data": []
}

Url: https://api.tawasolsms.com/group-status.php?batch_id=2003251625414441831&user=user1&pass=123456
Request Method: GET

This API allows users to check the delivery status of a previously sent group SMS. The status report includes details such as request status, delivery status, timestamps, and recipient numbers.

Example Request:

Url: https://api.tawasolsms.com/group-status.php?batch_id=2003251625414441831&user=user1&pass=123456
Method: GET

form data

Name	Value
btach_id	2003251625414441831
username	user1
password	123456

Example Response:

Response Success (200 - OK )


{
    "success": true,
    "message": "ok",
    "errorCode": "ER-00",
    "MessageID": {
        "batch_id": "2003251625414441831",
        "report": [
            {
                "request_status": "000",
                "dlr_status": "DELIVRD",
                "done_date": "2025-03-20 16:25:46",
                "messageid": "2503201625438489831",
                "msisdn": "966xxxxxxxxxxx1",
                "submit_date": "2025-03-20 16:25:43"
            },
            {
                "request_status": "000",
                "dlr_status": "DELIVRD",
                "done_date": "2025-03-20 16:25:50",
                "messageid": "2503201625438419821",
                "msisdn": "966xxxxxxxxxx2",
                "submit_date": "2025-03-20 16:25:43"
            }
        ]
    }
}

Url:https://api.tawasolsms.com/index.php?user=user1&pass=123456&sid=TawasolSMS&mno=966xxxxxxxxxx1&text=test sms&type=1&schtime=202524031400&gmt=+0200
Request Method: GET

This API allows users to send and schedule SMS messages via a simple GET request. This API provides an easy way to schedule them for a later time. The ScheduleId received in the response when scheduling an SMS will be used in the Remove Schedule API to delete the scheduled message before it is sent.

Example Request:

Url:https://api.tawasolsms.com/index.php?user=user1&pass=123456&sid=TawasolSMS&mno=966xxxxxxxxxx1&text=test sms&type=1&schtime=202524031400&gmt=+0200
Method: GET

form data

Name	Value
username	user1
password	123456
sid	TawasolSMS
mno	966xxxxxxxxxx1
text	text sms
type	1
schtime	202520031400
gmt	+0200

Status Codes:

On Failed (Possible Errors):

When a request fails, the system responds with a specific status code indicating the type of error encountered. Below is a list of error codes along with their brief descriptions to help you identify and resolve the issue.

Name	Description
ERROR - HTTP01	Invalid HTTP URL Format
ERROR - HTTP02	Invalid query string
ERROR - HTTP03	Message Submission Failed2
ERROR - HTTP04	Invalid Password
ERROR - HTTP05	Invalid System ID
ERROR - HTTP06	Invalid Sender ID
ERROR - HTTP07	Invalid Type
ERROR - HTTP08	Invalid Message ID
ERROR - HTTP09	Invalid Destination Address
ERROR - HTTP10	Invalid number of messages
ERROR - HTTP11	Requested service is unavailable
ERROR - HTTP12	Submit Failed
ERROR - HTTP13	Query request failed
ERROR - HTTP14	Bind failed
ERROR - HTTP15	Not Authorized for the request.
ERROR - HTTP16	Invalid Request
ERROR - HTTP17	Invalid Message Length
ERROR - HTTP18	INSUFFICIENT CREDITS/BALANCE
ERROR - HTTP19	Invalid DATA CODING SCHEME
ERROR - HTTP20	Invalid ESM
ERROR - HTTP21	Invalid HEADER
ERROR - HTTP22	Invalid Schedule Time
ERROR - HTTP23	Routing Error
ERROR - HTTP24	Exceeded number of Destination
ERROR - HTTP25	No Record Found
ERROR - HTTP26	Account Expired

Example Response:

Response Success (200 - OK )


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "ScheduleId": [
            "2403251328015777624"
        ],
        "MessageContent": "test sms",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "Not requested",
        "Recipient": "966xxxxxxx1",
        "TimeCreated": "2025-03-24 13:28:01"
    }
}

Response Failure:


{
"success": "false",
"message": "ERROR - HTTP07 --> Invalid Type",
"ip": "1.2.3.4",
"errorCode": "ER-01",
"data": []
}

Url: https://api.tawasolsms.com/schedule-remove.php?schedule_id=2403251328015777624&user=user&pass=123456
Request Method: GET

Easily manage your scheduled SMS with the Simple API Remove Schedule feature. This API allows you to delete scheduled messages with a quick GET request.

Example Request:

Url: https://api.tawasolsms.com/schedule-remove.php?schedule_id=2403251328015777624&user=user&pass=123456
Method: GET

form data

Name	Value
username	user
password	123456
schedule_id	2403251328015777624

Example Response:

Response Success (200 - OK )


{
    "success": true,
    "message": "ok",
    "errorCode": "ER-00",
    "ScheduleId": "2403251328015777624"
}

Url: https://api.tawasolsms.com/messages.php
Request Method: GET

You can track the messages you have sent during a certain period by submitting the Get Messages Details. The API will return an array of multiple records. Each record includes the details of an SMS message that was sent during the provided date range in the API request. You can also specify the number of SMS messages you want to receive per response page, as well as the response page index number you want to receive.

Example Request:

url: ttps://api.tawasolsms.com/messages.php
Method: GET

BODY formdata

Name	Value
username	user
password	123456
pageLength	10
pageNumber	1
fromDate	2025-03-27 00:00:00
toDate	2025-05-27 23:00:00

Example Response:

Response Success (200 - OK )


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "fromDate": "2025-03-27 00:00:00",
    "toDate": "2025-05-27 23:00:00",
    "data": [
        {
            "msg_id": "2503281153057805971",
            "mccmnc": "2400",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-28 11:53:05",
            "sender": "TawasolSMS",
            "destination": "966xxxxxx1"
        },
        {
            "msg_id": "2503281152376535961",
            "mccmnc": "2400",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-28 11:52:37",
            "sender": "Tawasol",
            "destination": "966xxxxxx1"
        },
        {
            "msg_id": "2503271642304125651",
            "mccmnc": "2400",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 16:42:30",
            "sender": "tawasol-AD",
            "destination": "966xxxxxx1"
        },
        {
            "msg_id": "2503271641018805621",
            "mccmnc": "2400",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 16:41:01",
            "sender": "tawasol-AD",
            "destination": "966xxxxxx18"
        },
        {
            "msg_id": "2503271622375065591",
            "mccmnc": "41501",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 16:22:37",
            "sender": "tawasol-AD",
            "destination": "966xxxxxxxx4"
        },
        {
            "msg_id": "2503271620409775581",
            "mccmnc": "41501",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 16:20:40",
            "sender": "-ad",
            "destination": "966xxxxxxxx4"
        },
        {
            "msg_id": "2503271620142575571",
            "mccmnc": "41501",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 16:20:14",
            "sender": "-ad",
            "destination": "966xxxxxxxx4"
        },
        {
            "msg_id": "2503271558469465381",
            "mccmnc": "2400",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 15:58:46",
            "sender": "TawasolSMS",
            "destination": "966xxxxx3"
        },
        {
            "msg_id": "2503271558469425371",
            "mccmnc": "41503",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 15:58:46",
            "sender": "TawasolSMS",
            "destination": "966xxxxx2"
        },
        {
            "msg_id": "2503271317065042241",
            "mccmnc": "2400",
            "country": "Saudi Arabia",
            "operator": "Zain",
            "time": "2025-03-27 13:17:06",
            "sender": "TawasolSMS",
            "destination": "966xxxxxx1"
        }
    ],
    "pagination": {
        "total": 22,
        "current_page": 1,
        "page_length": 10,
        "total_pages": 3
    }
}

GET Simple Api Send SMS

GET Simple Api Getting Message Details

GET Simple Api Getting Account Balance

GET Simple Api Send Group SMS

GET Simple Api Group Status

GET Simple Api Message Submission & Scheduling

GET Simple Api Remove Schedule

GET Simple API Retrieving SMS Messages