Dev DOC - SMSMobileAPI

SMSmobileAPI Developer Documentation

في SMSmobileAPI، نسعى جاهدين لجعل واجهة برمجة التطبيقات الخاصة بنا متوافقة قدر الإمكان مع أي بنية أو منصة.
سواء كنت تستخدم REST أو SOAP أو cURL أو لغات برمجة مختلفة مثل Python أو JavaScript أو PHP والمزيد، فإن واجهة برمجة التطبيقات الخاصة بنا مصممة للتكامل بسلاسة في مشاريعك.

لدينا أيضًا مكونات إضافية جاهزة للاستخدام لحلول وبرامج التجارة الإلكترونية. انقر هنا لاكتشافهم.

إذا كان لديك أي أسئلة أو اقتراحات أو تحتاج إلى مساعدة، فإن فريقنا هنا لمساعدتك.
لا تتردد في التواصل معنا على api@smsmobileapi.com

واجهة برمجة التطبيقات REST

حليقة

جافا سكريبت

بايثون

نود.جي اس

روبي

WSDL

إرسال رسالة نصية قصيرة API

تدعم واجهة برمجة تطبيقات SMSMobile طريقتين للمصادقة: استخدام مفتاح API بسيط أو بروتوكول OAuth2 مع معرف العميل وسر العميل.

1. مصادقة مفتاح API لإرسال الرسائل القصيرة

تتطلب هذه الطريقة مفتاح API يمكن تضمينه كمعلمة في طلب GET أو POST. إنها طريقة مباشرة للتحقق من صحة طلبات API الخاصة بك.

https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=PHONE_NUMBER&message=MESSAGE_TO_SEND

حدود:

- أبيكي:مفتاح API الفريد الخاص بك.

- المستفيدون:رقم هاتف المستلم.

- رسالة:الرسالة المراد إرسالها.

مثال:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=Hello%20World

2. مصادقة OAuth2 لإرسال الرسائل القصيرة

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

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

الحصول على رمز الوصول

للحصول على رمز وصول، أرسل طلب POST إلى نقطة نهاية الرمز باستخدام معرف العميل والسر الخاص بالعميل.

 curl -X POST https://api.smsmobileapi.com/oauth2/token \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d "grant_type=client_credentials" \
 -d "client_id=1ab0ex4b4c1ef2c800690d" \
 -d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

استخدام رمز الوصول:

بمجرد حصولك على رمز الوصول، قم بتضمينه في التفويض رأس طلبات واجهة برمجة التطبيقات الخاصة بك:

 curl -X POST https://api.smsmobileapi.com/sendsms \
 -H "التفويض: الناقل abc123xyz456" \
 -H "نوع المحتوى: application/x-www-form-urlencoded" \
 -d "المستلمون=+1234567890" \
 -d "الرسالة=مرحبا"

ما هي الطريقة التي يجب عليك استخدامها؟

- يستخدم مصادقة مفتاح API للتكامل السريع والمباشر.

- يستخدم مصادقة OAuth2 لتعزيز الأمان وقابلية التوسع في عمليات التكامل الخاصة بك.

لمزيد من التفاصيل، يرجى الرجوع إلى الوثائق الكاملة.

الحصول على واجهة برمجة تطبيقات الرسائل القصيرة

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

https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY

المعلمة:

- المستلمون: رقم الهاتف المحمول للمستلم.

- الرسالة: الرسالة التي يجب إرسالها.

- apikey: مفتاح API الذي لديك أو الذي ستتلقاه.

حذف واجهة برمجة تطبيقات الرسائل القصيرة

يتم استخدام نقطة نهاية واجهة برمجة التطبيقات هذه لحذف رسائل SMS من سجل خادم SMS Mobile API

https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

المعلمة:

- apikey: مفتاح API الذي لديك.

- guid_message: معرف فريد للرسالة التي يجب حذفها.

- date_start: إذا تم استخدامه بمفرده، فسيتم حذف جميع الرسائل من اليوم المحدد.

- date_start و date_end: يتم الجمع بينهما لحذف الرسائل ضمن فترة زمنية محددة.

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

إرسال رسالة نصية قصيرة

عنوان URL لـ WSDL

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

حدود:

- المستلمون: رقم الهاتف المحمول للمستلم.

- الرسالة: الرسالة التي يجب إرسالها.

- apikey: مفتاح API الذي لديك أو الذي ستتلقاه.

مثال

 require_once "lib/nusoap.php";
 
 $client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);
 $error  = $client->getError();
 
 $result = $client->call("sendSms", array("recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));
 
 print_r($result);

إرسال رسالة نصية قصيرة

أمر cURL الأساسي

بإمكانك استخدام أمر cURL التالي لإرسال رسالة نصية قصيرة عبر SMSmobileAPI:

 curl -X POST https://api.smsmobileapi.com/sendsms/ \
 -d "recipients=PHONE_NUMBER" \
 -d "message=YOUR_MESSAGE" \
 -d "apikey=YOUR_API_KEY"

مثال cURL في PHP

إذا كنت تستخدم PHP، فإليك كيفية إرسال رسالة نصية قصيرة باستخدام cURL:

 <?php
 
 $url = 'https://api.smsmobileapi.com/sendsms/';
 $data = array(
     'recipients' => 'PHONE_NUMBER',
     'message' => 'YOUR_MESSAGE',
     'apikey' => 'YOUR_API_KEY'
 );
 
 $options = array(
     CURLOPT_URL => $url,
     CURLOPT_POST => true,
     CURLOPT_POSTFIELDS => http_build_query($data),
     CURLOPT_RETURNTRANSFER => true,
 );
 
 $ch = curl_init();
 curl_setopt_array($ch, $options);
 $response = curl_exec($ch);
 curl_close($ch);
 
 echo $response;
 
 ?>

يوضح مثال PHP هذا كيفية إرسال طلب POST باستخدام cURL إلى SMSmobileAPI، وتمرير المعلمات الضرورية كمصفوفة ارتباطية.

إرسال رسالة نصية قصيرة

استخدم وحدة Python الرسمية الخاصة بنا: https://smsmobileapi.com/python/
أو استخدم الطريقة اليدوية ...

استخدام مكتبة `requests`

مكتبة `requests` هي مكتبة HTTP شائعة وبسيطة لـ Python. إليك كيفية استخدامها لإرسال رسالة نصية قصيرة عبر SMSmobileAPI:

 import requests

 url = "https://api.smsmobileapi.com/sendsms/"

 payload = {
     "recipients": "PHONE_NUMBER",
     "message": "YOUR_MESSAGE",
     "apikey": "YOUR_API_KEY"
 }

 response = requests.post(url, data=payload)

 print(response.text)

يوضح هذا المثال طلب POST بسيطًا إلى SMSmobileAPI، وإرسال رسالة إلى رقم هاتف محدد.

استخدام مكتبة `http.client`

تعتبر المكتبة `http.client` مضمنة في مكتبة Python القياسية ويمكن أيضًا استخدامها للتفاعل مع واجهة برمجة التطبيقات الخاصة بك:

 import http.client
 import urllib.parse

 conn = http.client.HTTPSConnection("api.smsmobileapi.com")

 params = urllib.parse.urlencode({
     "recipients": "PHONE_NUMBER",
     "message": "YOUR_MESSAGE",
     "apikey": "YOUR_API_KEY"
 })

 headers = { "Content-type": "application/x-www-form-urlencoded" }

 conn.request("POST", "/sendsms/", params, headers)
 response = conn.getresponse()
 data = response.read()

 print(data.decode("utf-8"))
 conn.close()

يوضح هذا المثال كيفية استخدام مكتبة `http.client` لإرسال طلب POST إلى واجهة برمجة التطبيقات. يتم ترميز المعلمات بصيغة URL وإرسالها مع الرؤوس المناسبة.

إرسال رسالة نصية قصيرة

استخدام واجهة برمجة التطبيقات `fetch`

تُعد واجهة برمجة التطبيقات "fetch" طريقة حديثة ومتعددة الاستخدامات لإرسال طلبات HTTP في JavaScript. وإليك كيفية استخدامها لإرسال رسالة نصية قصيرة عبر واجهة برمجة تطبيقات SMSmobile:

 const url = "https://api.smsmobileapi.com/sendsms/";

 const data = {
     recipients: "PHONE_NUMBER",
     message: "YOUR_MESSAGE",
     apikey: "YOUR_API_KEY"
 };

 fetch(url, {
     method: "POST",
     headers: {
         "Content-Type": "application/x-www-form-urlencoded"
     },
     body: new URLSearchParams(data)
 })
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.error("Error:", error));

يوضح هذا المثال كيفية إرسال طلب POST باستخدام واجهة برمجة التطبيقات `fetch`، والتي تدعمها معظم المتصفحات الحديثة.

استخدام `XMLHttpRequest`

إذا كنت بحاجة إلى دعم المتصفحات القديمة، فيمكنك استخدام الكائن `XMLHttpRequest`:

 const xhr = new XMLHttpRequest();
 const url = "https://api.smsmobileapi.com/sendsms/";

 const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";

 xhr.open("POST", url, true);
 xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");

 xhr.onreadystatechange = function() {
     if (xhr.readyState === 4 && xhr.status === 200) {
         console.log(xhr.responseText);
     }
 };

 xhr.send(data);

يوضح هذا المثال كيفية استخدام `XMLHttpRequest` لإرسال طلب POST، مما يوفر التوافق مع المتصفحات القديمة التي قد لا تدعم `fetch`.

إرسال رسالة نصية قصيرة

استخدام مكتبة `axios`

مكتبة `axios` هي عميل HTTP شائع لـ Node.js. إليك كيفية استخدامها لإرسال رسالة نصية قصيرة عبر SMSmobileAPI:

 const axios = require('axios');

 const url = 'https://api.smsmobileapi.com/sendsms/';
 const data = {
     recipients: 'PHONE_NUMBER',
     message: 'YOUR_MESSAGE',
     apikey: 'YOUR_API_KEY'
 };

 axios.post(url, data)
 .then(response => {
     console.log(response.data);
 })
 .catch(error => {
     console.error('Error:', error);
 });

يوضح هذا المثال كيفية إرسال طلب POST باستخدام `axios` في Node.js للتفاعل مع SMSmobileAPI.

إرسال رسالة نصية قصيرة

استخدام مكتبة `Net::HTTP`

بإمكانك استخدام مكتبة `Net::HTTP` في Ruby لإرسال رسالة نصية قصيرة عبر SMSmobileAPI:

 require 'net/http'
 require 'uri'

 uri = URI.parse("https://api.smsmobileapi.com/sendsms/")
 request = Net::HTTP::Post.new(uri)
 request.set_form_data(
     "recipients" => "PHONE_NUMBER",
     "message" => "YOUR_MESSAGE",
     "apikey" => "YOUR_API_KEY"
 )

 req_options = {
     use_ssl: uri.scheme == "https",
 }

 response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
     http.request(request)
 end

 puts response.body

يوضح هذا المثال كيفية إرسال طلب POST باستخدام `Net::HTTP` في Ruby إلى SMSmobileAPI.

انقر هنا لاختبار مفتاح API والخدمة باستخدام النموذج البسيط

اعتمادًا على إصدار Android المثبت على الهاتف المحمول، قد يعيق نظام التشغيل الأداء السليم لإرسال واستقبال رسائل SMS تلقائيًا عندما لا يكون تطبيق SmsMobileApi في المقدمة.
تنشأ هذه المشكلة من عملية تحاول التشغيل في الخلفية عندما لا يتم تشغيل التطبيق بشكل نشط. ومع ذلك، نظرًا لإجراءات تحسين البطارية في Android، والتي تختلف عبر الإصدارات المختلفة، فقد لا يتم تشغيل هذه العملية في الخلفية بشكل صحيح. تم تصميم تحسين البطارية في Android للحد من نشاط التطبيقات في الخلفية للحفاظ على عمر البطارية، وهو ما قد يؤثر عن غير قصد على التطبيقات التي تتطلب عمليات خلفية للعمل بشكل صحيح.

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

الأسئلة الشائعة للمطورين

كيفية إنشاء مفتاح API؟

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

أين يمكنني دائمًا العثور على مفتاح API الخاص بي؟

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

هل يمكن أن يكون إنشاء مفتاح API مجهولاً؟

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

ابدأ مع SMSmobileAPI اليوم!

استمتع بالحرية والمرونة في إدارة خدمات الرسائل القصيرة الخاصة بك أثناء التنقل. قم بتنزيل تطبيقنا المحمول الآن واتخذ الخطوة الأولى نحو التكامل السلس للرسائل القصيرة.

تنزيل التطبيق