واجهة برمجة التطبيقات HTTP - إجراء 'receivemessage'

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

الوصف

لتنزيل الرسائل النصية الواردة، استخدم تنسيق URL التالي:

https://127.0.0.1:9508/api?action=receivemessage&username=UUUUU&password=PPPPP&
folder=inbox&limit=2&afterdownload=delete

بدلاً من 127.0.0.1، يجب استبدالها باسم المضيف أو عنوان IP الخاص بالكمبيوتر الذي تم تثبيت بوابة الرسائل القصيرة عليه. رقم المنفذ 9508 هو رقم المنفذ الافتراضي HTTP لبوابة Ozeki للرسائل القصيرة. يمكن تكوين رقم المنفذ في واجهة المستخدم لبوابة Ozeki 10 للرسائل القصيرة، بالنقر على زر Advanced في شريط الأدوات.

يجب استبدال اسم المستخدم وكلمة المرور بـ "UUUUU" و "PPPPP". اسم المستخدم وكلمة المرور يحددان المستخدم الذي قمت بإنشائه في بوابة الرسائل القصيرة. عند استدعاء إجراء receivemessage عن طريق استدعاء URL، ستقوم بتنزيل الرسائل من صندوق الوارد الخاص بالمستخدم المحدد في الاستعلام باسم المستخدم وكلمة المرور.

يجب تعيين معلمة folder للرسالة إلى inbox.

تحدد معلمة limit عدد الرسائل التي سيتم تنزيلها. يُوصى بتنزيل أقل من 1000 رسالة في طلب واحد. يمكنك تنزيل الرسائل المتبقية في طلبات لاحقة.

يمكن استخدام معلمة afterdownload لإزالة الرسائل من بوابة الرسائل القصيرة بعد تنزيلها بنجاح.

مثال لطلب URL

https://127.0.0.1:9508/api?action=receivemessage&username=admin&password=abc123&
folder=inbox&limit=2&afterdownload=delete

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 824

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/response.xml">
<response>
   <action>receivemessage</action>
   <data>
   <message>
   <messageid>ERFAV23D</messageid>
   <originator>06301234567</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>مرحبا بالعالم</messagedata>
         <senttime>2008-01-16 10:04:00</senttime>
         <receivedtime>2008-01-18 20:58:04</receivedtime>
      </message>
      <message>
         <messageid>GYT4455D</messageid>
         <originator>06209994444</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>الرسالة الثانية</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

معلمات الطلب

المعلمة الوصف القيم الممكنة مثال إلزامي/اختياري*
action يحدد أمر واجهة برمجة التطبيقات HTTP receivemessage action=receivemessage إلزامي
username يحدد اسم المستخدم. تستخدم معاملات اسم المستخدم وكلمة المرور لمصادقة المستخدم. بمجرد مصادقة المستخدم سيتم تنزيل الرسائل من صندوق الوارد الخاص به. يجب أن تكون القيمة مشفرة في URL. قيمة نصية، الحد الأقصى للطول هو 16 حرفًا username=admin إلزامي
password يحدد كلمة المرور. تستخدم معاملات اسم المستخدم وكلمة المرور لمصادقة المستخدم. بمجرد مصادقة المستخدم سيتم تنزيل الرسائل من صندوق الوارد الخاص به. يجب أن تكون القيمة مشفرة في URL. قيمة نصية، الحد الأقصى للطول هو 16 حرفًا password=abc123 إلزامي
folder يحدد اسم المجلد. افتراضيًا، سيتم تنزيل الرسائل من مجلد صندوق الوارد. يمكنك استخدام إجراء receivemessage لتنزيل الرسائل من مجلدات أخرى أيضًا. inbox (افتراضي)
outbox
deliveredtonetwork
deliveredtohandset
deliveryfailed
folder=inbox اختياري
limit يحدد الحد الأقصى لعدد الرسائل التي سيتم تنزيلها من الخادم ضمن الطلب. يمكنك تنزيل الرسائل المتبقية بطلبات لاحقة. قيمة رقمية، الحد الافتراضي هو 1000 limit=10 اختياري
afterdownload يحدد طريقة التعامل مع الرسائل بعد التنزيل الناجح. يمكن حذف الرسائل من بوابة الرسائل القصيرة؛ يمكن تمييزها كرسائل تم تنزيلها أو يمكن تركها كما هي. إذا تم تركها كما هي، في المرة التالية التي تبدأ فيها طلب تنزيل، سيتم تنزيلها مرة أخرى.
delete (افتراضي)
mark
untouch
afterdownload=delete اختياري
responseformat يمكنك تحديد تنسيق الرسائل الواردة للمستخدم. xml, html, url-encoded responseformat=xml اختياري

* إلزامي = معلمة إلزامية، اختياري = معلمة اختيارية

معايير الاستجابة
(تنسيق استجابة xml)
المعيار الوصف القيم الممكنة مثال
message يحتوي على رسالة واحدة. يمكن أن يحتوي قسم البيانات على العديد من الرسائل. عدد الرسائل في بيانات الرسالة يمكن أن يكون أقل من أو يساوي قيمة معيار الحد  
<message>
    <messageid>ERFAV23D</messageid>
    <originator>06301234567</originator>
    <recipient>06201112222</recipient>
    <messagetype>SMS:TEXT</messagetype>
    <messagedata>مرحبا بالعالم</messagedata>
    <senttime>2028-01-16 10:04:00</senttime>
    <receivedtime>2028-01-18 20:58:04</receivedtime>
</message>
message.messageid يحتوي على مرجع رسالة يمكن استخدامه لتتبع الرسالة في بوابة الرسائل القصيرة. يتم استخدام هذا المرجع أيضًا لتحديد التقارير التي تم تسليمها إلى الشبكة أو إلى الجهاز أو للاستعلام عن معلومات حول الرسالة. قيمة نصية، الحد الأقصى للطول هو 16 حرفًا <messageid>ERFAV23D</messageid>
message.originator يحتوي على رقم هاتف المرسل. هذا هو رقم الهاتف الخاص بالهاتف المحمول الذي أرسل الرسالة. قيمة نصية، الحد الأقصى للطول هو 16 حرفًا <recipient>06301234567</recipient>
message.recipient يحتوي على عنوان المستلم. هذا هو رقم الهاتف الذي تم استخدامه لإرسال الرسالة إليه. قيمة نصية، الحد الأقصى للطول هو 16 حرفًا <recipient>06201112222</recipient>
message.messagetype يحتوي على معرف نوع الرسالة المحدد في مواصفات نوع الرسالة المحمولة. في معظم الحالات سيكون هذا SMS:TEXT. قيمة نصية، الحد الأقصى للطول هو 1024 حرفًا <recipient>SMS:TEXT</recipient>
message.messagedata يحتوي على بيانات الرسالة. بالنسبة للرسائل النصية، هذا هو نص الرسائل القصيرة. بالنسبة لأنواع الرسائل الأخرى، هذا هو هيكل XML محدد في مواصفات نوع الرسالة المحمولة. يتم ترميز بيانات الرسالة كـ UTF8. قيمة نصية <messagedata>مرحبا بالعالم</messagedata>
message.senttime يحتوي على الطابع الزمني الذي يخبر عن وقت إرسال الرسالة من هاتف المرسل. قيمة تاريخ ووقت بالتنسيق التالي: YYYY-MM-DD hh:mm:ss <senttime>2028-01-16 10:04:00</senttime>
message.receivedtime يحتوي على الطابع الزمني الذي يخبر عن وقت استلام الرسالة بواسطة بوابة الرسائل القصيرة. قيمة تاريخ ووقت بالتنسيق التالي: YYYY-MM-DD hh:mm:ss <senttime>2028-01-18 20:58:04</senttime>

ملخص

في هذه المقالة، وجدت جميع المعلومات اللازمة لاستخدام إجراء 'استلام الرسالة' مع واجهة برمجة تطبيقات الرسائل القصيرة عبر HTTP الخاصة بنا.

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

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

آمل أن تكون هذه الصفحة مفيدة لجميع القراء وخاصة للمبتدئين.

More information