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

POST الطريقة (1) استخدم معرف التطبيق لطلب الرمز المميز

https://api.tawasolsms.com/auth.php

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

BODY formdata

app_sid

cvSc4T8NW1T9yqZLXHVrMYe2qxxxx

معرف التطبيق

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": true,
    "code": 200,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJBcHBTaWQiOiJjdlNjNFQ4TlcxVIiwiVGltZVpvbmUiOiJBc2lhXC9SaXlhZGgifQ.hmHXX9Qg4ea7c0peI",
    "ValidTill": "2024-04-17 10:24:01",
    "TimeZone": "Asia/Riyadh"
}
                                                
                                            

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

https://api.tawasolsms.com/index.php

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

BODY formdata

AppSid

cvSc4T8NW1T9yqZLXHVrMYe2qIxxxx

معرف التطبيق

Body

Your URL is https://tawasolsms.com

محتوى الرسالة

mno

966xxxxxxxx1,966xxxxxxxx2

رقم الجوال، التنسيق الدولي

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2404161020044837432",
            "2404161020044867442"
        ],
        "MessageContent": "Your URL is https://tawasolsms.com",
        "Status": "Sent",
        "totalSms": 2,
        "totalRecipients": 2,
        "Balance": "178051",
        "Recipient": "966xxxxxxxx1,966xxxxxxxx2",
        "TimeCreated": "2024-04-16 10:18:45",
        "bulkId": "Bulk661e2655636b2"
    }
}
                                                
                                            

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

https://api.tawasolsms.com/index.php

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

PARAMS

Name

user

اسم المستخدم

Password

pass@123

كلمة المرور

originator

Tawasol

معرف المرسل

recipientPhone

966xxxxxxxx1

رقم الجوال

smsText

test sms

محتوى الرسالة

طلب مثال

                                            
<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>

                    
                

استجابة المثال

200 - OK

                                                    
<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
    <soapenv:success>true</soapenv:success>
    <soapenv:message>ok</soapenv:message>
    <soapenv:errorCode>ER-00</soapenv:errorCode>
    <soapenv:data>
        <soapenv:MessageID>
            <soapenv:0>2408151248475109000</soapenv:0>
        </soapenv:MessageID>
        <soapenv:MessageContent>Call me later pls</soapenv:MessageContent>
        <soapenv:Status>Sent</soapenv:Status>
        <soapenv:totalSms>1</soapenv:totalSms>
        <soapenv:totalRecipients>1</soapenv:totalRecipients>
        <soapenv:Balance>Not requested</soapenv:Balance>
        <soapenv:Recipient>966xxxxxx</soapenv:Recipient>
        <soapenv:TimeCreated>2024-08-15 12:48:47</soapenv:TimeCreated>
    </soapenv:data>
</soapenv:Body>
</soapenv:Envelope>

                        
                    

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

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

PARAMS

user

اسم المستخدم

pass

pass@123

كلمة المرور

sid

Tawasol

معرف المرسل

mno

966xxxxxxxx1

رقم الجوال

text

test sms

محتوى الرسالة

type

نوع الرسالة 1 - اللغة الإنجليزية 2- يونيكود 3 - مدخلات مميزة 4- اللغة العربية

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2404161030002475032"
        ],
        "MessageContent": "test sms",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "178050",
        "Recipient": "966xxxxxxxx1",
        "TimeCreated": "2024-04-16 10:28:42",
        "bulkId": "Bulk661e28aa1c504"
    }
}
                                                
                                            

POST الطريقة (3) استخدم مفتاح واجهة برمجة التطبيقات واسم المستخدم لطلب الرمز المميز

https://api.tawasolsms.com/auth.php

باستخدام اسم المستخدم ومفتاح واجهة برمجة التطبيقات (API)، احصل على استجابة تتضمن رمز الوصول إلى JWT الخاص بك، والذي ستوفره بعد ذلك في تفويض الرمز المميز لـ Bearer أو في رأس كل واجهة برمجة تطبيقات باسم المفتاح: access-token

BODY formdata

apikey

XbhGtR1H

مفتاح التطبيق

username

user1

اسم المستخدم

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": true,
    "code": 200,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6InJzYWxlaDIiLCJwYXNzd29yZCI6IlgwQGNrMTMiLCJWYWxpZFRpbGwiOiIyMDI0LTA0LTE3IDEwOjI5OjU0IiwiVGlt",
    "ValidTill": "2024-04-17 10:29:54",
    "TimeZone": "Asia/Riyadh"
}
                                                
                                            

POST الطريقة (3) إرسال رسالة (نموذج أو نص)

https://api.tawasolsms.com/index.php

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

BODY formdata

senderName

Tawasol

اسم مرسل الرسالة

messageType

نوع الرسالة 1 - اللغة الإنجليزية 2- يونيكود 3 - مدخلات مميزة 4- اللغة العربية

messageText

Your URL is: https://tawasolsms.com

محتوى الرسالة

recipients

966xxxxxxxx1

رقم الجوال

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2404161036577139772"
        ],
        "MessageContent": "Your URL is: https://1l.ae/a",
        "Status": "Sent",
        "totalSms": 1,
        "totalRecipients": 1,
        "Balance": "178048",
        "Recipient": "966xxxxxxxx1",
        "TimeCreated": "2024-04-16 10:36:58",
        "bulkId": "Bulk661e2a9a38ffb"
    }
}
                                                
                                            

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

https://api.tawasolsms.com/index.php

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

BODY formdata

senderName

Tawasol

اسم مرسل الرسالة

messageType

نوع الرسالة 1 - اللغة الإنجليزية 2- يونيكود 3 - مدخلات مميزة 4- اللغة العربية

shortURL

true

اضبطه على "صحيح"، إذا كان نص الرسالة يحتوي على عنوان URL وتريد تقصيره

messageText

Your file url is https://tawasolsms.com/file.pdf

محتوى الرسالة

recipients

None

ملف CSV الذي يحتوي على أرقام هواتف المستلمين المقصودين.

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2404161047527697872",
            "2404161047527727882",
            "2404161047527747892"
        ],
        "MessageContent": "Your file url is https://1l.ae/b",
        "Status": "Sent",
        "totalSms": 3,
        "totalRecipients": 3,
        "Balance": "178038",
        "Recipient": "966xxxxxxxx1,966xxxxxxxx2,966xxxxxxxx3",
        "TimeCreated": "2024-04-16 10:46:33",
        "bulkId": "Bulk661e2cd9ac25c"
    }
}
                                                
                                            

POST الطريقة (3) إرسال المجموعة

https://api.tawasolsms.com/index.php

Iإذا كنت تريد إرسال رسائل نصية قصيرة مجمعة إلى مجموعات محددة مسبقًا من المستلمين، فاستخدم Send SMS to Groups API. ستعيد واجهة برمجة التطبيقات (API) إليك معرف الرسائل لتتبعها لاحقًا باستخدام الحصول على تفاصيل الرسالة بواسطة ID API.

يعد استخدام Send SMS to Groups API أمرًا بسيطًا للغاية. أولاً، أرسل طلب HTTP مع اسم المجموعة ونص الرسالة والمعلمات المهمة الأخرى، ثم احصل على رد يتضمن معرفات الرسائل القصيرة.

BODY formdata

senderName

Tawasol

اسم مرسل الرسالة

messageType

نوع الرسالة 1 - اللغة الإنجليزية 2- يونيكود 3 - مدخلات مميزة 4- اللغة العربية

shortURL

true

اضبطه على "صحيح"، إذا كان نص الرسالة يحتوي على عنوان URL وتريد تقصيره

messageText

test sms

محتوى الرسالة

group

group_1

اسم المجموعة المحدد مسبقًا

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "MessageID": [
            "2404161053391228152",
            "2404161053391258162",
            "2404161053391278172",
            "2404161053391298182",
            "2404161053391318192",
            "2404161053391338202"
        ],
        "MessageContent": "test sms",
        "Status": "Sent",
        "totalSms": 6,
        "totalRecipients": 6,
        "Balance": "178026",
        "Recipient": "966xxxxxxxx1,966xxxxxxxx2,966xxxxxxxx3,966xxxxxxxx4,966xxxxxxxx5,966xxxxxxxx6",
        "TimeCreated": "2024-04-16 10:52:20",
        "bulkId": "Bulk661e2e3411297"
    }
}
                                                
                                            

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

https://api.tawasolsms.com/dlr.php?message_id=2404161053391228152

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

PARAMS

message_id

2404161053391228152

معرف الرسالة

طلب مثال

                                                
GET https://api.tawasolsms.com/dlr.php?message_id=2404161053391228152

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "false",
    "message": "2404161053391228152",
    "errorCode": "ER-01",
    "data": []
}
                                                
                                            

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

https://api.tawasolsms.com/bulk.php?bulkId=Bulk661e2cd9ac25c

يمكنك تتبع أي رسائل نصية مجمعة أرسلتها باستخدام معرفها المجمع في طلب واجهة برمجة التطبيقات. ستعيد واجهة برمجة التطبيقات تفاصيل حملة الرسائل النصية القصيرة التي تريد تتبعها، مثل عدد الرسائل القصيرة المرسلة والمسلمة وغير المسلمة في حملة الرسائل النصية القصيرة.

PARAMS

bulkId

Bulk661e2cd9ac25c

معرف الحملة

طلب مثال

                                                
GET https://api.tawasolsms.com/bulk.php?bulkId=Bulk661e2cd9ac25c

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "id": "Bulk661e2cd9ac25c",
        "total": "113000",
        "delivered": "105000",
        "sent": "113000",
        "undelivered": "0",
        "inProgress": "8000"
    }
}
                                                
                                            

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

https://api.tawasolsms.com/count.php

يمكنك معرفة عدد الرسائل القصيرة التي أرسلتها خلال فترة معينة. ستعرض واجهة برمجة التطبيقات (API) عددًا صحيحًا يمثل عدد رسائل SMS المرسلة خلال النطاق الزمني المقدم في طلب واجهة برمجة التطبيقات (API). لاستخدام واجهة برمجة التطبيقات (Get Sent Letters Count)، أرسل أولاً طلب HTTP مع النطاق الزمني، ثم احصل على استجابة تتضمن العدد من الرسائل النصية القصيرة المرسلة خلال النطاق الزمني المقدم.

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "Count": 216362
    }
}
                                                
                                            

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

https://api.tawasolsms.com/messages.php

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

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": [
        {
            "Id": "2024040512525322521",
            "AccountId": "783",
            "RequestId": "375295152",
            "Sender": "Cequens",
            "MessageText": "Test Message",
            "Recepient": "966xxxxxxxx1",
            "Status": 3,
            "SentDate": "2024-04-05T11:49:18.713Z"
        },
        {
            "Id": "2024040512525322522",
            "AccountId": "783",
            "RequestId": "161541572",
            "Sender": "Cequens",
            "MessageText": "Test Message",
            "Recepient": "966xxxxxxxx2",
            "Status": 1,
            "SentDate": "2024-04-05T12:38:58.216Z"
        }
    ]
}
                                                
                                            

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

https://api.tawasolsms.com/balance.php

من خلال API احصل على رصيدك الحالي، يمكنك استرداد رصيد حسابك الحالي مباشرة. يمكنك أيضًا الحصول على الرصيد الحالي.

طلب مثال

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

استجابة المثال

200 - OK

                                                                                                    
{
    "success": "true",
    "message": "ok",
    "errorCode": "ER-00",
    "data": {
        "Balance": "178026"
    }
}
                                                
                                            

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

https://api.tawasolsms.com/index.php

الرسائل النصية القصيرة المخصصة هي نوع من الرسائل القصيرة التي يتم إنشاؤها من عرض قالب، والقالب هو نص يحتوي على نص خاص يحتوي على متغيرات، ويتم استبدال هذه المتغيرات في وقت التشغيل.

BODY formdata

senderName

Tawasol

معرف المرسل

messageText

Hi {{Name}} your Salary is {{Salary}}

محتوى الرسالة

recipients

966xxxxxxxx1,966xxxxxxxx2

أرقام هواتف المستلمين المقصودين مفصولة بفواصل

replacementList

employeeX,500$

قائمة متغيرات المصفوفة. المحددات بين كل قائمة متغيرات هي ';' . والمحددات بين المتغيرات هي الفواصل '،'

طلب مثال

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

استجابة المثال

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"
    }
}
                                                
                                            

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

https://api.tawasolsms.com/index.php

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

BODY formdata

senderName

Tawasol

اسم مرسل الرسالة

recipients

None

ملف CSV الذي يحتوي على أرقام هواتف المستلمين المقصودين و محتوى الرسالة لكل رقم.

طلب مثال

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

استجابة المثال

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"
            }
        ]
    }
}
                                                
                                            