فيما يلي قائمة بواجهات برمجة التطبيقات التي نوفرها للتكامل مع تطبيقات الجهات الخارجية لتحقيق أتمتة كاملة ووظائف سلسة.

REST API

هذا REST API يوفر واجهة خارجية لاستدعاء بعض الوظائف الهامة للإذاعة وتكنولوجيا البث. يحدد ICTBroadcast 3 فئات API_User و API_contact و API_Campaign في REST API التي تحدد جميع الوظائف اللازمة للوصول إليها من خارج نطاق التطبيق. فيما يلي مثال رمز يصف كيفية استدعاء هذه الوظائف:

User_Create

تخلق هذه الوظيفة مستخدمًا جديدًا في ICTBroadcast. يصف الرمز التالي كيفية استدعاء هذه الوظيفة.

المعلمات

المستخدم $: مصفوفة متسلسلة تحتوي على بيانات المستخدم

قيمة الإرجاع

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

User_Update

تقوم هذه الوظيفة بتحديث بيانات المستخدم.

المعلمات


$ user_id: معرف المستخدم الذي سيتم تحديث بياناته


$ user: بيانات المستخدم

قيمة الإرجاع


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

User_Get

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

المعلمات


$ user_id: معرف المستخدم


$ البحث: البحث


القيمة $: value

قيمة الإرجاع


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

حذف المستخدم

تحذف هذه الوظيفة مستخدمًا تم تقديم معرفه.

المعلمات


$ user_id: معرف المستخدم

قيمة الإرجاع


إرجاع صحيح إذا كان الحذف ناجحًا أو إرجاع خطأ.

User_Extension_Create

تنشئ هذه الوظيفة امتدادًا للمستخدم المحدد.

المعلمات


$ user_id: معرف المستخدم


امتداد $: صفيف يحتوي على بيانات الملحق الجديد

قيمة الإرجاع


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

User_Role_List

تُرجع هذه الوظيفة جميع الأدوار المتاحة.

المعلمات


لايوجد

قيمة الإرجاع


إرجاع سلسلة json المشفرة التي تحتوي على أدوار المستخدم في حالة نجاحها.

User_Payment_Create

تضيف هذه الوظيفة رصيدًا في حساب المستخدم

المعلمات


$ user_id: معرف المستخدم


القيمة $: المبلغ المدفوع لإضافته


الوصف: وصف مختصر


نوع $: نوع الدفع

قيمة الإرجاع


إرجاع صحيح إذا كان إضافة رصيد ناجحًا أو إرجاع خطأ.

User_Login

هذه الوظيفة تسجل دخول المستخدم.

المعلمات


$ session_id: معرف الجلسة

قيمة الإرجاع


إرجاع اسم الجلسة إذا نجح بخلاف ذلك في إرجاع خطأ.

User_Logout

تؤدي هذه الوظيفة إلى تدمير جلسة المستخدم من أجل تسجيل الخروج منه.

المعلمات


$ session_id: معرف الجلسة

قيمة الإرجاع


إرجاع اسم الجلسة إذا نجح بخلاف ذلك في إرجاع خطأ.

حالة الحملة

تعطي هذه الوظيفة حالة الحملة التي تم تقديم معرفها.

المعلمات


$ campaign_id: معرّف الحملة المطلوب حالتها

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات حالة الحملة إذا نجحت.

الحملة_البدء

تبدأ هذه الوظيفة حملة تم تقديم معرفها.

المعلمات


$ campaign_id: معرّف الحملة

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات حالة الحملة إذا نجحت.

Campaign_Stop

تعمل هذه الوظيفة على إيقاف حملة تم تقديم معرفها.

المعلمات


$ campaign_id: معرّف الحملة

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات حالة الحملة إذا نجحت.

Campaign_Contact_Create

تضيف هذه الوظيفة جهة اتصال معينة سيتم طلبها من قبل الحملة التي يتم تقديم معرفها.

المعلمات


$ contact_id: صفيف يحتوي على بيانات الاتصال التي سيتم إنشاؤها ..


$ campaign_id: معرّف الحملة

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات الحملة في حالة نجاحها.

ملخص الحملة

تُرجع هذه الوظيفة ملخص الحملة. ستسرد حالة (مشغول ، ازدحام ، عدم استجابة ، فشل) لكل جهة اتصال في الحملة.

المعلمات


$ campaign_id: معرّف الحملة المطلوب حالتها


$ usr_id: معرّف المستخدم يملك هذه الحملة

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات الحملة في حالة نجاحها.

نتائج الحملة

تقوم هذه الوظيفة بتحديث الحملة وحالتها.

المعلمات


$ campaign_id: معرّف الحملة المطلوب حالتها


الحالة $: حالة الحملة


$ usr_id: معرّف المستخدم يملك هذه الحملة

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات الحملة في حالة نجاحها.

مرشح_الحملة

توفر هذه الوظيفة عامل تصفية بحث للبحث عن الحملات.

المعلمات


$ search: صفيف استعلام البحث لبيانات الحملة.

قيمة الإرجاع


لعرض سلسلة json المشفرة التي تحتوي على بيانات الحملة في حالة نجاحها.

Contact_Create

تقوم هذه الوظيفة بإنشاء جهة اتصال جديدة في مجموعة محددة.

المعلمات


$ contact: صفيف يحتوي على بيانات الاتصال.


$ contact_group_id: معرف مجموعة الاتصال.

قيمة الإرجاع


إرجاع سلسلة json المشفرة التي تحتوي على حالة جهة الاتصال في حالة نجاحها.

Contact_Delete

تعمل هذه الوظيفة على إزالة جهة الاتصال التي تم تقديم معرفها.

المعلمات


$ contact_id: معرف جهة الاتصال المطلوب إزالته.

قيمة الإرجاع


إرجاع سلسلة json المشفرة التي تحتوي على حالة جهة الاتصال في حالة نجاحها.

هنا مثال على عمليات النشر واجهات برمجة تطبيقات ICTBroadcast REST

ICT البث الإذاعي مع EspoCRM

ICT البث الإذاعي مع VtigerRM

انقر هنا لتصبح مزود خدمة الاتصال الهاتفي عبر الإنترنت لبدء عملك الخاص