باستخدام API المستندة إلى REST لدمج ICTBroadcast مع تطبيق طرف ثالث والتشغيل الآلي autodialer

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

REST API

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

User_Create

هذه الوظيفة بإنشاء مستخدم جديد في ICTBroadcast. يصف البرمجية التالية كيفية استدعاء هذه الدالة.

المعلمات


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

قيمة الإرجاع


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

User_Update

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

المعلمات


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


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

قيمة الإرجاع


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

User_Get

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

المعلمات


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


$search: search


$value: value

قيمة الإرجاع


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

User_Delete

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

المعلمات


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

قيمة الإرجاع


إرجاع true إذا حذف الناجحة يعود خلاف ذلك كاذبة.

User_Extension_Create

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

المعلمات


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


$extension: مجموعة تحتوي على بيانات عن تمديد جديد

قيمة الإرجاع


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

User_Role_List

هذه الدالة تقوم بإرجاع كافة الأدوار المتاحة.

المعلمات


لا شيء

قيمة الإرجاع


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

User_Payment_Create

يضيف هذه الوظيفة الائتمان في حساب المستخدم

المعلمات


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


$value: دفعت المبلغ لإضافة


$description: وصف موجز


$type: نوع الدفع

قيمة الإرجاع


إرجاع true إذا أضيف الائتمان الناجحة يعود خلاف ذلك كاذبة.

User_Login

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

المعلمات


$session_id: Session ID

قيمة الإرجاع


يعود اسم الدورة في حال نجاحها يعود خلاف ذلك كاذبة.

User_Logout

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

المعلمات


$session_id: Session ID

قيمة الإرجاع


يعود اسم الدورة في حال نجاحها يعود خلاف ذلك كاذبة.

Campaign_Status

هذه الوظيفة يعطي حالة من الحملة التي تعطى الهوية.

المعلمات


$campaign_id: مطلوب معرف الحملة التي وض

قيمة الإرجاع


عوائد سلمان ترميز سلسلة تحتوي على بيانات حالة الحملة في حال نجاحها.

Campaign_Start

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

المعلمات


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

قيمة الإرجاع


عوائد سلمان ترميز سلسلة تحتوي على بيانات حالة الحملة في حال نجاحها.

Campaign_Stop

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

المعلمات


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

قيمة الإرجاع


عوائد سلمان ترميز سلسلة تحتوي على بيانات حالة الحملة في حال نجاحها.

Campaign_Contact_Create

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

المعلمات


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


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

قيمة الإرجاع


عوائد سلمان ترميز البيانات الحملة سلسلة تحتوي في حال نجاحها.

Campaign_Summary

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

المعلمات


$campaign_id: مطلوب معرف الحملة التي وضع


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

قيمة الإرجاع


عوائد سلمان ترميز البيانات الحملة سلسلة تحتوي في حال نجاحها.

Campaign_Result

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

المعلمات


$campaign_id: مطلوب معرف الحملة التي وضع


$status: وضع الحملة


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

قيمة الإرجاع


عوائد سلمان ترميز البيانات الحملة سلسلة تحتوي في حال نجاحها.

Contact_Create

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

المعلمات


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


$contact_group_id: لفريق الاتصال.

قيمة الإرجاع


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

Contact_Delete

هذه الوظيفة يزيل الاسم الذي يعطى الهوية.

المعلمات


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

قيمة الإرجاع


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