واجهة برمجة تطبيقات HTTP - قالب URL

يقدم هذا الدليل تعليمات حول كيفية إنشاء قالب URL لاستخدامه في معلمات redirecturl وcontinueurl وreporturl الخاصة بطريقة sendmessage في واجهة برمجة تطبيقات HTTP.

مقدمة

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

على سبيل المثال، إذا قمت بتحديد عنوان URL التالي في معلمة continueurl:

http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage

سيتم تعديله إلى هذا عند إرجاعه في استجابة HTTP:

http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery

لاحظ أنه تم استبدال الكلمات الرئيسية $messageid و$statusmessage. يتم استبدال معرف الرسالة للرسائل المقدمة مكان الكلمة الرئيسية $messageid في عنوان URL، ويتم استبدال رسالة الحالة للتقديم مكان الكلمة الرئيسية $statusmessage. تقوم بوابة Ozeki 10 للرسائل القصيرة باستبدال الكلمات الرئيسية المحددة في الجدول أدناه.

كيفية الاستخدام؟

لتمرير قالب URL في معلمات redirecturl أو continueurl أو reporturl، يجب ترميز قالب URL. هذا ضروري لأنه بدون ذلك، سينكسر بناء جملة HTTP لطريقة sendmessage. لترميز قالب URL الخاص بك، يمكنك استخدام أداة الترميز عبر الإنترنت (المتاحة على http://www.ozeki.hu/index.php?owpn=5679) أو يمكنك إجراء الترميز يدويًا.

يبدو قالب URL الذي استخدمناه في المثال أعلاه بهذا الشكل قبل الترميز:

http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage

بعد الترميز، سيبدو بهذا الشكل:

http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage

إذا كنت ترغب في تضمين هذا القالب في طلب الإرسال الخاص بك، فسيبدو طلبك بهذا الشكل:

http://127.0.0.1:9501/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World&redirecturl=
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage

الكلمات الرئيسية

يمكن أن تحتوي قوالب URL على الكلمات الرئيسية التالية

الكلمة الرئيسية
يتم استبدالها بـ يمكن استخدامها في المعلمة التالية لطريقة sendmessage في واجهة برمجة تطبيقات HTTP
statuscode رمز نتيجة إرسال الرسالة redirecturl
continueurl
reporturl
statusmessage رسالة حالة إرسال الرسالة. (شرح لـ statuscode.) redirecturl
continueurl
reporturl
messageid معرف الرسالة المقدمة redirecturl
continueurl
reporturl
recipient رقم هاتف المستلم للرسالة المقدمة redirecturl
continueurl
reporturl
originator اسم المرسل أو رقم هاتف المرسل للرسالة المقدمة redirecturl
continueurl
reporturl
messagetype نوع الرسالة للرسالة المقدمة redirecturl
continueurl
reporturl
messagedata بيانات الرسالة للرسالة المقدمة redirecturl
continueurl
reporturl
submitdate قيمة التاريخ والوقت لحدث إرسال الرسالة. تنسيق التاريخ هو YYYY-MM-DD hh:mm:ss. reporturl
deliveredtonetworkdateقيمة التاريخ والوقت لحدث تسليم الرسالة إلى الشبكة. تنسيق التاريخ هو YYYY-MM-DD hh:mm:ss. reporturl
deliveredtohandsetdateقيمة التاريخ والوقت لحدث تسليم الرسالة إلى الجهاز. تنسيق التاريخ هو YYYY-MM-DD hh:mm:ss. reporturl
statusالحالة الحالية للرسالة المقدمة. القيم المحتملة:

deliveredtonetwork
deliveredtohandset
deliveryfailed

إذا فشل التسليم، فإن المعلمات statuscode وstatusmessage تحتوي على رمز الخطأ ورسالة الخطأ التي تم إرجاعها من قبل مزود الخدمة 		reporturl

إذا تم إرسال أكثر من رسالة واحدة بطلب HTTP واحد، فسيحتوي قالب URL على القيم المقابلة للرسالة الأخيرة في القائمة.

More information