شركة التواصل الرقمية / API

الرابط: https://api.tawasolsms.com/white-ip.php?ip=1.2.3.4
طريقة الطلب: POST

التحقق من عنوان IP:
يسمح التحقق من عنوان IP للمستخدمين بالتحقق مما إذا كان عنوان IP الخاص بهم مسموحًا أم لا. إذا لم يكن العنوان مسموحًا، سيتم إرسال رمز OTP إلى رقم الهاتف المسجل. يمكن للمستخدمين بعد ذلك التحقق من الرمز باستخدام API التحقق من OTP لتنشيط عنوان IP الخاص بهم.

IP address status (Allowed, Not Allowed)

الصلاحيات

الاسم	القيمة	الوصف
username	user1	اسم المستخدم
password	123456	كلمة المرور

هيئة الطلب (form-data)

يتطلب API المعلمات التالية في جسم form-data: إذا كان عنوان IP متاحًا، فاستخدمه؛ وإلا، فقم بالتقاط عنوان IP الخاص بالمستخدم.

الاسم	القيمة	الوصف
ip	1.2.3.4	عنوان IP الخاص بالمستخدم

مثال على الطلب:

الرابط: https://api.tawasolsms.com/white-ip.php?ip=1.2.3.4
طريقة الطلب: POST

مثال على الاستجابة:

استجابة ناجحة (عنوان IP مسموح)


{
    "success": true,
    "message": "Your IP: 1.2.3.4 are allowed to access this API",
    "code": 200
    }

استجابة فاشلة (عنوان IP غير مسموح)


{
    "success": false,
    "message": "You are not allowed to access this API. An OTP was sent to your registered mobile numbers.",
    "code": 403
    }

الرابط: https://api.tawasolsms.com/verify-otp.php
طريقة الطلب: POST

تتيح هذه الواجهة للمستخدمين التحقق من OTP المستلم وتنشيط عنوان IP الخاص بهم. وهي تضمن أن المستخدمين المصرح لهم فقط يمكنهم التحقق من عناوين IP الخاصة بهم باستخدام كلمة مرور لمرة واحدة.

الصلاحيات

الاسم	القيمة	الوصف
username	user1	اسم المستخدم
password	123456	كلمة المرور

هيئة الطلب (BODY formdata)

الاسم	القيمة	الوصف
ip	1.2.3.4	ip address
otp	1222222	OTP

مثال على الطلب:

url: https://api.tawasolsms.com/verify-otp.php
                Method: POST

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": true,
    "message": "Your IP: 1.2.3.4 is already verified",
    "code": 200
    }

استجابة فاشلة


{
    "success": false,
    "message": "OTP غير صالح",
    "code": 201
}

الرابط: https://api.tawasolsms.com/auth.php
طريقة الطلب: POST

باستخدام مفتاح الوصول (Access Key)، ستحصل على استجابة تحتوي على رمز JWT الخاص بك، والذي ستستخدمه لاحقًا في التفويض لكل طلب API.

أو

باستخدام اسم المستخدم وكلمة المرور، ستحصل على استجابة تحتوي على رمز JWT الخاص بك، والذي ستستخدمه لاحقًا في التفويض لكل طلب API.

Use either the App SID or Access Key, or use the Username and Password to request a token

هيئة الطلب (BODY formdata)

يمكنك استخدام مفتاح الوصول

الاسم	القيمة	الوصف
access_key	cvSc4T8NW1T9yqZLXHVrMYe2qxxxx	يمكنك استخدام مفتاح الوصول

هيئة الطلب (BODY formdata)

يمكنك استخدام اسم المستخدم وكلمة المرور

الاسم	القيمة	الوصف
username	user1	يمكنك استخدام اسم المستخدم وكلمة المرور
password	1234567	يمكنك استخدام اسم المستخدم وكلمة المرور

مثال على الطلب:

url: https://api.tawasolsms.com/auth.php
Method: POST

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": true,
    "code": 200,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6IlNlbmRUV1NMIiwiYWNjZXNzX2tleSI6InU4Mm9qVmNOUlE3RUlOZCIsIlZhbGlkVGlsbCI6IjIwMjUtMDItMjggMTc6MTk6MzkiLCJUaW1lWm9uZSI6IkFzaWFcL1JpeWFkaCJ9.QaEEV0ZjntV2sufhj3iv44O7_TzFqEG4A-tGhOTUP5M",
    "created_at": "2025-02-28 11:19:39",
    "valid_till": "2025-02-28 17:19:39",
    "time_zone": "Asia/Riyadh"
}

استجابة فاشلة


{
    "success": false,
    "code": 404,
    "message": "المستخدم غير موجود"
}

الرابط: https://api.tawasolsms.com/index.php
طريقة الطلب: POST

استخدم نقطة نهاية الرسائل لإرسال رسالة SMS فردية أو جماعية، مع التفويض باستخدام الرمز (Token). عند إرسال رسائل SMS باستخدام هذا الـ API، سيعيد لك الـ API معرف الرسائل المرسلة لتتبعها لاحقًا.

هيئة الطلب (BODY formdata)

الاسم	القيمة	الوصف
access_key	cvSc4T8NW1T9yqZLXHVrMYe2qIxxxx	معرف التطبيق
Body	رابطك هو https://tawasolsms.com	محتوى الرسالة
mno	966xxxxxxxx1,966xxxxxxxx2	رقم الجوال، بصيغة دولية
senderName	Tawasol	اسم المرسل

مثال على الطلب:

url: https://api.tawasolsms.com/index.php
Method: POST

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2503201440003957381"
        ],
        "MessageContent": "Your URL is https://tawasolsms.com",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "Not requested",
        "Recipient": "966xxxxxxxx1,966xxxxxxxx2",
        "TimeCreated": "2025-03-20 14:40:00"
    }
}

الرابط: https://api.tawasolsms.com/index.php
طريقة الطلب: POST

إرسال رسالة SMS فردية أو جماعية باستخدام SOAP متضمناً اسم المستخدم وكلمة المرور. عند إرسال رسائل SMS عبر هذا الـ API، ستتلقى معرف الرسائل المرسلة لتتمكن من تتبعها لاحقًا.

المعلمات (PARAMS)

الاسم	القيمة	الوصف
اسم المستخدم	user	اسم المستخدم
كلمة المرور	pass@123	كلمة المرور
المُرسل	Tawasol	معرف المرسل
رقم المستلم	966xxxxxxxx1	رقم الهاتف المحمول
نص الرسالة	test sms	محتوى الرسالة

مثال على الطلب:

Url: https://api.tawasolsms.com/index.php
Method: POST

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:pmm="http://pmmsoapmessenger.com/">
<soapenv:Header/>
<soapenv:Body>
    <pmm:SendSms>
        <pmm:user>
            <pmm:CustomerID>10008</pmm:CustomerID>
            <pmm:Name>SendXXXL</pmm:Name>
            <pmm:Language>en</pmm:Language>
            <pmm:Password>X0@12233</pmm:Password>
        </pmm:user>
        <pmm:originator>Tawasol</pmm:originator>
        <pmm:smsText>Call me later pls</pmm:smsText>
        <pmm:recipientPhone>966xxxx</pmm:recipientPhone>
        <pmm:messageType>Latin</pmm:messageType>
        <pmm:defDate>20150530120000</pmm:defDate>
        <pmm:blink>0</pmm:blink>
        <pmm:flash>0</pmm:flash>
        <pmm:Private>0</pmm:Private>
    </pmm:SendSms>
</soapenv:Body>
</soapenv:Envelope>

الرابط: https://api.tawasolsms.com/index.php?user=user&pass=pass@123&sid=Tawasol&mno=966xxxxxxxx1&text=test sms&type=1
طريقة الطلب: GET

إرسال رسالة SMS فردية أو جماعية باستخدام معلمات URL، متضمناً اسم المستخدم وكلمة المرور. عند إرسال رسائل SMS عبر هذا الـ API، ستتلقى معرف الرسائل المرسلة لتتمكن من تتبعها لاحقًا.

المعلمات (PARAMS)

الاسم	القيمة	الوصف
user	user	اسم المستخدم
pass	pass@123	كلمة المرور
sid	Tawasol	معرف المرسل
mno	966xxxxxxxx1	رقم الهاتف المحمول
text	test sms	محتوى الرسالة
type	1	نوع الرسالة: 1 - إنجليزي 2 - يونيكود 3 - رموز خاصة 4 - عربي

مثال على الطلب:

Url: https://api.tawasolsms.com/index.php?user=user1&pass=pass@123&sid=Tawasol&mno=966xxxxxxxx1&text=test sms&type=1
Method: GET

مثال على الاستجابة:

استجابة ناجحة (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"
    }
}

الرابط: https://api.tawasolsms.com/index.php
طريقة الطلب: POST

استخدم نقطة النهاية messages لإرسال رسائل SMS فردية أو جماعية. عند إرسال الرسائل باستخدام هذا الـ API، سيتم إرجاع معرف الرسالة لتتمكن من تتبعها لاحقًا.

الصلاحيات

Token
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

BODY (form-data)

الاسم	القيمة	الوصف
senderName	Tawasol	اسم المرسل
messageType	1	نوع الرسالة: 1 - إنجليزي 2 - يونيكود (Unicode) 3 - أحرف خاصة 4 - عربي
messageText	Your URL is: https://tawasolsms.com	محتوى الرسالة
recipients	966xxxxxxxx1	رقم الهاتف المحمول

مثال على الطلب:

url: https://api.tawasolsms.com/index.php
Method: POST

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2503201446406777571"
        ],
        "MessageContent": "Your URL is: https://tawasolsms.com",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "Not requested",
        "Recipient": "966xxxxxxxx1",
        "TimeCreated": "2025-03-20 14:46:40"
    }
}

الرابط: https://api.tawasolsms.com/index.php
طريقة الطلب: POST

استخدم نقطة النهاية Bulk لإرسال رسائل SMS جماعية. يتم ذلك عن طريق إرسال ملف CSV يحتوي على أرقام هواتف المستلمين. عند إرسال طلب الإرسال الجماعي باستخدام هذا الـ API، سيتم إرجاع معرف العملية (Bulk ID) لتتمكن من تتبعها لاحقًا.

الصلاحيات

Token
xxxxxxxxxxxxxxxxxxxxxxx

BODY (form-data)

الاسم	القيمة	الوصف
senderName	Tawasol	اسم المرسل
messageType	3	نوع الرسالة: 1 - إنجليزي 2 - يونيكود (Unicode) 3 - أحرف خاصة 4 - عربي
shortURL	true	يُضبط على true إذا كان محتوى الرسالة يحتوي على رابط وترغب في اختصاره
messageText	رابط الملف: https://tawasolsms.com/file.pdf	محتوى الرسالة
recipients	None	ملف CSV يحتوي على أرقام الهواتف للمستلمين

مثال على الطلب:

url: https://api.tawasolsms.com/index.php
Method: POST

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2503201449277567601"
        ],
        "MessageContent": "Your file url is https://tawasolsms.com/file.pdf",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "Not requested",
        "Recipient": "966xxxxxxxx1",
        "TimeCreated": "2025-03-20 14:49:27"
    }
}

الرابط: https://api.tawasolsms.com/dlr.php?message_id=2503101521175975331
طريقة الطلب: GET

يمكنك تتبع أي رسالة SMS قمت بإرسالها باستخدام معرفها عبر إرسال طلب API للحصول على تفاصيل الرسالة حسب المعرف. ستعيد لك هذه الواجهة تفاصيل الرسالة المرسلة، مثل معرف الحساب الذي أرسل الرسالة، حالة تسليم الرسالة، وتاريخ الإرسال.

الصلاحيات

Token
xxxxxxxxxxxxxxxxxx

المعلمات (PARAMS)

الاسم	القيمة	الوصف
message_id	2503101521175975331	معرف الرسالة

مثال على الطلب:

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

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


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

الرابط: https://api.tawasolsms.com/count.php
طريقة الطلب: GET

يمكنك معرفة عدد رسائل SMS التي قمت بإرسالها خلال فترة زمنية معينة. ستُرجع واجهة API عددًا صحيحًا يمثل عدد الرسائل المرسلة خلال الفترة المحددة. لاستخدام هذه الواجهة، قم بإرسال طلب HTTP مع نطاق التواريخ المطلوب، وستحصل على استجابة تحتوي على العدد الإجمالي للرسائل المرسلة.

الصلاحيات

Token
xxxxxxxxxxxxxxx

مثال على الطلب:

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

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "Count": "14",
        "datetime": "2025-03-20 14:53:36"
    }
}

الرابط: https://api.tawasolsms.com/messages.php
طريقة الطلب: GET

يمكنك تتبع الرسائل التي أرسلتها خلال فترة زمنية معينة باستخدام هذه الواجهة. ستُرجع واجهة API مصفوفة تحتوي على عدة سجلات، بحيث يحتوي كل سجل على تفاصيل رسالة SMS تم إرسالها خلال نطاق التواريخ المحدد في الطلب. يمكنك أيضًا تحديد عدد الرسائل التي تريد استرجاعها في كل استجابة، بالإضافة إلى تحديد رقم صفحة الاستجابة المطلوبة.

مثال على الطلب:

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

الصلاحيات

Token
xxxx/td>

BODY formdata

الاسم	القيمة
pageLength	10
pageNumber	1
fromDate	2025-03-11 00:00:00
toDate	2025-03-11 23:59:59

مثال على الاستجابة:

استجابة ناجحة (200 - OK)


{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "fromDate": "2025-03-01 00:00:00",
    "toDate": "2025-03-11 00:00:00",
    "data": [
        {
            "msg_id": "2503101730240637891",
            "time": "2025-03-10 17:30:24",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx1"
        },
        {
            "msg_id": "2503101730240537881",
            "time": "2025-03-10 17:30:24",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx1"
        },
        {
            "msg_id": "2503101725437597871",
            "time": "2025-03-10 17:25:43",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx1"
        },
        {
            "msg_id": "2503101659138517551",
            "time": "2025-03-10 16:59:13",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx1"
        },
        {
            "msg_id": "2503101659138487541",
            "time": "2025-03-10 16:59:13",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx2"
        },
        {
            "msg_id": "2503101657328787531",
            "time": "2025-03-10 16:57:32",
            "sender": "tawasolSMS",
            "destination": "966xxxxxxxx2"
        },
        {
            "msg_id": "2503101656557817521",
            "time": "2025-03-10 16:56:55",
            "sender": "tawasolSMS",
            "destination": "966xxxxxxxx2"
        },
        {
            "msg_id": "2503101655501817511",
            "time": "2025-03-10 16:55:50",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx1"
        },
        {
            "msg_id": "2503101655501767501",
            "time": "2025-03-10 16:55:50",
            "sender": "Tawasol",
            "destination": "966xxxxxxxx2"
        },

    ],
    "pagination": {
        "total": 1356,
        "current_page": 1,
        "page_length": 10,
        "total_pages": 136
    }
}

الرابط: https://api.tawasolsms.com/balance.php
طريقة الطلب: GET

من خلال واجهة برمجة التطبيقات (API) للحصول على رصيدك الحالي، يمكنك استرداد رصيد حسابك مباشرة.

مثال على الطلب:

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

الصلاحيات/strong>

Name Value

token xxxxxxxxxxxxxxxxxxx

Name	Value
token	xxxxxxxxxxxxxxxxxxx

مثال على الاستجابة:

استجابة ناجحة (200 - OK)

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

الرابط: https://api.tawasolsms.com/index.php
طريقة الطلب: POST

الرسائل النصية المخصصة هي نوع من الرسائل القصيرة يتم إنشاؤها من خلال استخدام القوالب. القالب هو نص يحتوي على متغيرات يتم استبدالها أثناء التشغيل.

مثال على الطلب:

url: https://api.tawasolsms.com/index.php Method: POST

الصلاحيات

Token

xxxxxxxxxxxxxxx

هيكل البيانات المرسلة (BODY formdata)

الاسم القيمة الوصف

senderName Tawasol معرف المرسل

messageText Hi {{Name}}, your Salary is {{Salary}} محتوى الرسالة

recipients 966xxxxxxxx1,966xxxxxxxx2 أرقام الهواتف المستقبلة (مفصولة بفاصلة)

replacementList employeeX,500$ قائمة استبدال القيم. الفاصل بين كل قائمة متغيرات هو ';' وبين المتغيرات ','

مثال على الاستجابة:

استجابة ناجحة (200 - OK)

{ "success": "true", "message": "ok", "errorCode": "ER-00", "data": { "MessageID": [ "2404161120325302182", "2404161120325332192" ], "MessageContent": "Hi employeeX your Salary is 500$", "Status": "Sent", "totalSms": 2, "totalRecipients": 2, "Balance": "178023", "Recipient": "966xxxxxxxx1,966xxxxxxxx2", "TimeCreated": "2024-04-16 11:19:13", "bulkId": "Bulk661e3481739a7" } }

الرابط: https://api.tawasolsms.com/index.php
طريقة الطلب: POST

استخدم نقطة نهاية الإرسال الجماعي المخصص لإرسال رسائل SMS جماعية تحتوي على نصوص مختلفة. تقبل نقطة النهاية ملف CSV يحتوي على أرقام المستلمين مع النصوص المخصصة لكل رسالة.

مثال على الطلب:

url: https://api.tawasolsms.com/index.php Method: POST

هيكل البيانات المرسلة (BODY formdata)

الاسم القيمة الوصف

senderName Tawasol اسم المرسل

recipients ملف CSV ملف يحتوي على أرقام الهواتف المستقبلة ومحتوى الرسالة لكل رقم.

مثال على الاستجابة:

استجابة ناجحة (200 - OK)

{ "success": "true", "message": "ok", "errorCode": "ER-00", "data": { "Balance": "178017", "faileds": [], "sendErrors": [], "bulkId": "Bulk661e34fe556ac", "totalRecipients": 3, "totalSms": 3, "messages": [ { "MessageID": [ "2404161122388024072" ], "MessageContent": "Hello world test message", "Status": "Sent", "totalSms": 1, "Recipient": "966xxxxxxxx1", "TimeCreated": "2024-04-16 11:21:19" }, { "MessageID": [ "2404161122400384102" ], "MessageContent": "Hello world test message 31", "Status": "Sent", "totalSms": 1, "Recipient": "966xxxxxxxx2", "TimeCreated": "2024-04-16 11:21:20" }, { "MessageID": [ "2404161122402094112" ], "MessageContent": "Hello world test message 311", "Status": "Sent", "totalSms": 1, "Recipient": "966xxxxxxxx3", "TimeCreated": "2024-04-16 11:21:20" } ] } }

POST تحقق من حالة عنوان IP الخاص بك (مسموح، غير مسموح)

POST التحقق من OTP لعنوان IP الحالي

POST الطريقة (1): استخدم مفتاح الوصول، أو استخدم اسم المستخدم وكلمة المرور لطلب رمز الوصول.

POSTالطريقة (1) إرسال رسالة

POST الطريقة (2) الإرسال باستخدام SOAP

GET الطريقة (2) الإرسال باستخدام معلمات URL

POST الطريقة (3) إرسال الرسائل (نموذج أو بيانات في الجسم)

POST الطريقة (3) إرسال الرسائل الجماعية باستخدام ملف

GET الطريقة (3) الحصول على تفاصيل الرسالة

GET الطريقة (3) الحصول على عدد الرسائل

GET الطريقة (3) استرجاع تفاصيل الرسائل

GET الطريقة (3) الحصول على رصيد الحساب

POST الطريقة (3) إرسال رسالة مخصصة

POST الطريقة (3) إرسال دفعة مخصصة باستخدام ملف