الإعداد والاستخدام
توفر واجهة برمجة التطبيقات PHP مجموعة من وظائف PHP التي تدعم معظم وظائف Alfchatbot. لبدء استخدام واجهة برمجة التطبيقات PHP، اتبع الخطوات أدناه.
الاستخدام
قم بتضمين الملف functions.php في ملف PHP الخاص بك. الملف موجود في مجلد include داخل مجلد الإضافة. انتهى الأمر! يمكنك الآن البدء في استخدام وظائف هذه الوثائق.
require("include/functions.php");
احصل على المسار الكامل لتثبيت Alfchatbot الخاص بك من الإعدادات > متفرقات > الحصول على المسار. يمكنك أيضًا استخدام المتغير $_SERVER["DOCUMENT_ROOT"]. مثال: require($_SERVER["DOCUMENT_ROOT"] . "/alfchatbot/include/functions.php");
معلومات
- بعض الوظائف محمية لأسباب أمنية، أدخل الكود $GLOBALS['SB_FORCE_ADMIN'] = true قبل استدعاء الوظيفة لتنفيذها بشكل صحيح. أدخل الكود $GLOBALS['SB_FORCE_ADMIN'] = false مباشرة بعد استدعاء الوظيفة لأسباب أمنية.
- بعض الوظائف تتطلب تفاصيل المستخدم النشط، استخدم الكود $GLOBALS['SB_LOGIN'] = ['id' => '', 'first_name' => '', 'last_name' => '', 'email' => '', 'user_type' => '', 'department' => '']; لتعيين المستخدم النشط.
المستخدمون
وظائف لإدارة المستخدمين والوكلاء والمسؤولين.
sb_login()
تسجيل دخول مستخدم أو وكيل. يمكن إتمام تسجيل الدخول بطريقتين: عبر البريد الإلكتروني وكلمة المرور، أو معرف المستخدم والتوكن.
المعلمات
|
|
بريد المستخدم لتسجيل الدخول. إذا تم تعيين هذه السمة، يجب عليك أيضًا تعيين كلمة المرور. الافتراضي: سلسلة فارغة. |
password |
كلمة مرور المستخدم لتسجيل الدخول. إذا تم تعيين هذه السمة، يجب عليك أيضًا تعيين البريد الإلكتروني. الافتراضي: سلسلة فارغة. |
user_id |
معرف المستخدم لتسجيل الدخول. إذا تم تعيين هذه السمة، يجب عليك أيضًا تعيين التوكن. الافتراضي: سلسلة فارغة. |
token |
توكن المستخدم لتسجيل الدخول. إذا تم تعيين هذه السمة، يجب عليك أيضًا تعيين معرف المستخدم. يمكنك الحصول على التوكن من منطقة المستخدمين عن طريق فتح صندوق ملف تعريف المستخدم. الافتراضي: سلسلة فارغة. |
الاستجابة
[
{
"id": "913",
"profile_image": "https://alfchatbot.com/user.svg",
"first_name": "مستخدم",
"last_name": "#29902",
"email": null,
"user_type": "زائر",
"token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
},
"YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
]
القيمة الأخيرة هي بيانات تسجيل الدخول المشفرة جاهزة للتخزين في تخزين الويب لمتصفح المستخدم. يرجع false إذا كان تسجيل الدخول غير ناجح.
sb_logout()
تسجيل خروج المستخدم المتصل، فقط من جهة الخادم.
الاستجابة
true
تقوم هذه الوظيفة بتسجيل خروج المستخدم فقط من الخادم. استخدم وظيفة Javascript API SBF.logout(); لتسجيل خروج المستخدم أيضًا من جهة العميل.
sb_get_active_user()
تقوم بإرجاع تفاصيل المستخدم المتصل.
المعلمات
db |
قم بتعيينه إلى true للتحقق مما إذا كان المستخدم موجودًا في قاعدة البيانات. الافتراضي: false. |
login_app |
مصفوفة مشفرة تحتوي على البريد الإلكتروني وكلمة المرور لمستخدم WordPress المتصل. تستخدم هذه المعلمة فقط في إصدار WordPress. إذا تم تعيينها، فإن الوظيفة تعيد المستخدم المتصل في WordPress. استخدم هذا الرمز لتوليد المصفوفة: sb_encryption(json_encode(['id' => "", 'email' => ""])). الافتراضي: false. |
الاستجابة
[
{
"id": "913",
"profile_image": "https://alfchatbot.com/user.svg",
"first_name": "مستخدم",
"last_name": "#29902",
"email": null,
"user_type": "زائر",
"token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
},
"YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
]
sb_get_user()
تُرجع تفاصيل المستخدم للمعرف المحدد.
المعلمات
user_id |
معرف المستخدم. |
extra |
قم بتعيينه إلى true للحصول أيضًا على تفاصيل المستخدم الإضافية. الافتراضي: false. |
الاستجابة
{
"id": "123456",
"first_name": "جون",
"last_name": "دو",
"email": "johon@example.com",
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-12 14:28:57",
"last_activity": "2020-05-12 14:28:57",
"department": null,
"token": "a521773c5a566a251c3fb00e93162b20ff955b12",
"password": "",
"details": [
{
"slug": "location",
"name": "الموقع",
"value": "نيويورك، الولايات المتحدة"
},
{
"slug": "country_code",
"name": "رمز البلد",
"value": "America/New_York"
},
...
]
}
sb_get_user_extra()
تُرجع تفاصيل المستخدم الإضافية للمعرف المحدد، أو المحددة.
المعلمات
user_id |
معرف المستخدم. |
slug |
السلايد الخاص بالإعداد الذي يجب استرجاعه. إذا لم يتم تعيين هذه المعلمة، سيتم إرجاع جميع تفاصيل المستخدم. الافتراضي: false. |
default |
القيمة الافتراضية التي يتم إرجاعها إذا لم يتم العثور على تفاصيل المستخدم. الافتراضي: false. |
الاستجابة
[
{
"slug": "browser",
"name": "المتصفح",
"value": "Chrome"
},
{
"slug": "current_url",
"name": "URL الحالي",
"value": "https://alfchatbot.com/"
},
{
"slug": "os",
"name": "نظام التشغيل",
"value": "Windows 10"
},
{
"slug": "phone",
"name": "الهاتف",
"value": "3203057977"
},
...
]
sb_get_user_name()
تُرجع الاسم الكامل للمستخدم النشط، أو المحدد.
المعلمات
user |
كائن المستخدم. |
الاستجابة
سلسلة اسم المستخدم
sb_get_users()
تُرجع تفاصيل المستخدمين لجميع المستخدمين.
المعلمات
sorting |
تعيين ترتيب القيم المُعادة. أدخل ["column", "order"] واستبدل column بإحدى القيم التالية: first_name, last_name, email, profile_image, user_type, creation_time, last_activity, department. استبدل order بـ ASC أو DESC. |
user_types |
مصفوفة بتنسيق JSON لأنواع المستخدمين التي يجب تضمينها في القيمة المُعادة. تنسيق المصفوفة: ["", "", "", ...]. القيم المقبولة: visitor, lead, user, agent, admin. الافتراضي: جميع الأنواع. |
search |
سلسلة تحتوي على مصطلحات البحث. |
pagination |
عدد صحيح من 1 إلى N لتحديد عدد النتائج. أدخل 1 للحصول على أول 100 نتيجة، 2 للنتائج من 101 إلى 200، وهكذا. |
extra |
قم بتعيينه إلى true لتضمين جميع تفاصيل المستخدم الإضافية أيضًا. قم بتعيينه كمصفوفة من سلايدات تفاصيل المستخدم الإضافية لتضمين مجموعة جزئية فقط من التفاصيل الإضافية. الافتراضي: false. |
user_ids |
مصفوفة من المعرفات. إذا تم تعيينها، فإنها تُعيد فقط المستخدمين بالمعرفات المدرجة في مصفوفة المعرفات المقدمة. الافتراضي: false. |
الاستجابة
[
{
"id": "880",
"first_name": "مستخدم",
"last_name": "#29938",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 08:58:18",
"last_activity": "2020-05-13 09:07:39",
"department": null,
"token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
},
{
"id": "879",
"first_name": "مستخدم",
"last_name": "#86773",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 08:38:41",
"last_activity": "2020-05-13 08:58:12",
"department": null,
"token": "2e5064670707d06b661d04353f4a462ec927f19a"
},
...
]
sb_get_new_users()
تُرجع المستخدمين الذين تم إنشاؤهم بعد التاريخ/المعرف المحدد.
المعلمات
datetime |
معرف المستخدم أو التاريخ والوقت بالتنسيق التالي: YYYY-MM-DD HH:MM:SS. على سبيل المثال: 2020-05-13 13:35:59. يمكنك إزالة الوقت وترك التاريخ فقط. التواريخ المخزنة في قاعدة البيانات هي بتوقيت UTC+0. |
الاستجابة
[
{
"id": "880",
"first_name": "مستخدم",
"last_name": "#29938",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 08:58:18",
"last_activity": "2020-05-13 09:07:39",
"department": null,
"token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
},
{
"id": "879",
"first_name": "مستخدم",
"last_name": "#86773",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 08:38:41",
"last_activity": "2020-05-13 08:58:12",
"department": null,
"token": "2e5064670707d06b661d04353f4a462ec927f19a"
},
...
]
sb_get_online_users()
تُرجع المستخدمين المتصلين أو الوكلاء والمديرين المتصلين.
المعلمات
sorting |
اسم جدول قاعدة البيانات المستخدم للترتيب. الافتراضي: creation_time. |
agents |
قم بتعيينه إلى true لإرجاع الوكلاء والمديرين فقط. الافتراضي: false. |
الاستجابة
[
{
"id": "881",
"first_name": "دون",
"last_name": "جون",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 09:18:59",
"last_activity": "2020-05-13 09:32:34",
"department": null,
"token": "e435a5c67f4276cdb9c6fc19b7c015990ffc3268"
},
{
"id": "880",
"first_name": "مستخدم",
"last_name": "#29938",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 08:58:18",
"last_activity": "2020-05-13 09:32:28",
"department": null,
"token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
}
...
]
sb_get_online_user_ids()
تُرجع مصفوفة تحتوي على معرفات المستخدمين والوكلاء المتصلين.
المعلمات
agents |
قم بتعيينه إلى true لإرجاع الوكلاء والمديرين فقط. الافتراضي: false. |
الاستجابة
[ 881, 548, 125, ... ]
sb_get_users_with_details()
تُرجع مصفوفة تحتوي على معرفات المستخدمين وتفاصيل المستخدمين الذين لديهم التفاصيل المطلوبة.
المعلمات
details |
مصفوفة من تفاصيل المستخدم. على سبيل المثال: [ "email", "phone" ]. |
user_ids |
مصفوفة، أو سلسلة مفصولة بفواصل من معرفات المستخدمين. إذا تم تعيين هذه المعلمة، فإنها تُعيد فقط المستخدمين الذين تحتوي معرفاتهم في المصفوفة المقدمة. قم بتعيينه إلى all أو false للبحث عن جميع المستخدمين، أو agents للبحث فقط عن الوكلاء والمديرين. الافتراضي: false. |
الاستجابة
{
"email": [
{
"id": 4561,
"value": "albert@example.com"
},
{
"id": 98436,
"value": "jessica@example.com"
},
...
],
"phone": [
{
"id": 12563,
"value": "+4462367136"
},
{
"id": 778956,
"value": "+4462999345"
},
...
],
...
}
sb_get_agents_ids()
تُرجع مصفوفة تحتوي على معرفات الوكلاء.
المعلمات
admins |
قم بتعيينه إلى false لاستبعاد المديرين. الافتراضي: true; |
الاستجابة
[
881,
153,
...
]
sb_search_users()
تُرجع المستخدمين الذين يطابقون البحث.
المعلمات
search |
سلسلة تحتوي على مصطلحات البحث. يتم دعم تفاصيل المستخدم الإضافية أيضًا. |
الاستجابة
[
{
"id": "881",
"first_name": "دون",
"last_name": "جون",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 09:18:59",
"last_activity": "2020-05-13 09:32:34",
"department": null,
"token": "e435a5c67f4276cdb9c6fc19b7c015990ffc3268"
},
{
"id": "880",
"first_name": "مستخدم",
"last_name": "#29938",
"email": null,
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "زائر",
"creation_time": "2020-05-13 08:58:18",
"last_activity": "2020-05-13 09:32:28",
"department": null,
"token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
},
...
]
sb_add_user()
إنشاء مستخدم جديد.
المعلمات
settings |
مصفوفة تحتوي على تفاصيل المستخدم. مفاتيح وتنسيق المصفوفة: [ "profile_image" => "", "first_name" => "", "last_name" => "", "email" => "", "password" => "", "user_type" => "", "department" => "" ]. قيم accepted لـ user_type: visitor, lead, user, agent, admin. الافتراضي: visitor إذا لم يتم توفير البريد الإلكتروني، خلاف ذلك، user. |
settings_extra |
مصفوفة من تفاصيل المستخدم الإضافية. تنسيق المصفوفة: ["key" => ["value", "Name"], "key" => ["value", "Name"], ...]. أي تفصيل مقبول. التفاصيل المدمجة (المفاتيح): phone, city, language, country, birthday, company, facebook, twitter, linkedin, website, ip, country_code, browser, currency, location, os, time_zone, current_url. |
login_app |
مصفوفة مشفرة تحتوي على البريد الإلكتروني وكلمة المرور لمستخدم WordPress المتصل. تُستخدم هذه المعلمة فقط في إصدار WordPress. إذا تم تعيينها، سيستخدم المستخدم الجديد تفاصيل المستخدم المحدد لـ WordPress. استخدم هذا الرمز لتوليد المصفوفة: sb_encryption(json_encode(['id' => "", 'email' => ""])). الافتراضي: false. |
hash_password |
قم بتعيينه إلى false لتخطي تشفير كلمة المرور. استخدم هذا الإعداد إذا كانت كلمة المرور مشفرة بالفعل. الافتراضي: true. |
الاستجابة
123456
الاستجابات: معرف المستخدم الجديد عند النجاح، خلاف ذلك، بريد إلكتروني مكرر, نوع مستخدم غير صالح, رسالة خطأ SQL.
sb_add_user_and_login()
إنشاء مستخدم جديد، تسجيل دخوله، وإرجاع بيانات تسجيل الدخول للعميل.
المعلمات
تستخدم هذه الوظيفة نفس المعلمات الخاصة بـ sb_add_user().
الاستجابة
ترجع هذه الوظيفة نفس الاستجابة الخاصة بـ sb_login().
sb_add_new_user_extra()
إضافة تفاصيل مستخدم إضافية إلى المستخدم الذي يحمل المعرف المحدد. لن يتم تحديث تفاصيل المستخدم الحالية.
المعلمات
user_id |
المعرف الخاص بالمستخدم الذي سيتم تحديثه. |
settings |
مصفوفة من تفاصيل المستخدم الإضافية. تنسيق المصفوفة: ["key" => ["value", "Name"], "key" => ["value", "Name"], ...]. أي تفصيل مقبول. التفاصيل المدمجة (المفاتيح): phone, city, language, country, birthday, company, facebook, twitter, linkedin, website, ip, country_code, browser, currency, location, os, time_zone, current_url. |
الاستجابة
true
sb_update_user()
تحديث تفاصيل المستخدم الحالي.
المعلمات
user_id |
أدخل معرف المستخدم الذي سيتم تحديثه. |
settings |
مصفوفة تحتوي على تفاصيل المستخدم. مفاتيح وتنسيق المصفوفة: [ "profile_image" => "", "first_name" => "", "last_name" => "", "email" => "", "password" => "", "user_type" => "", "department" => "" ]. قيم accepted لـ user_type: visitor, lead, user, agent, admin. الافتراضي: visitor إذا لم يتم توفير البريد الإلكتروني، خلاف ذلك، user. |
settings_extra |
مصفوفة من تفاصيل المستخدم الإضافية. تنسيق المصفوفة: ["key" => ["value", "Name"], "key" => ["value", "Name"], ...]. أي تفصيل مقبول. التفاصيل المدمجة (المفاتيح): phone, city, language, country, birthday, company, facebook, twitter, linkedin, website, ip, country_code, browser, currency, location, os, time_zone, current_url. |
hash_password |
قم بتعيينه إلى false لتخطي تشفير كلمة المرور. استخدم هذا الإعداد إذا كانت كلمة المرور مشفرة بالفعل. الافتراضي: true. |
الاستجابة
true
الاستجابات الأخرى المحتملة: بريد إلكتروني مكرر, نوع مستخدم غير صالح, رسالة خطأ SQL.
sb_update_user_value()
تحديث تفصيل واحد، أو تفصيل إضافي، لمستخدم أو وكيل أو مسؤول موجود.
المعلمات
user_id |
المعرف الخاص بالمستخدم الذي سيتم تحديثه. |
slug |
الاسم الفريد للتفصيل. مثل: first_name، email، city، birthday. |
value |
القيمة الجديدة للتفصيل. |
name |
اسم التفصيل الإضافي. مطلوب فقط إذا كان التفصيل الذي سيتم تحديثه هو تفصيل إضافي. |
الاستجابة
true
sb_update_login()
تحديث تفاصيل تسجيل دخول المستخدم المتصل وإرجاع بيانات تسجيل الدخول للعميل. استخدم وظيفة Javascript API SBF.loginCookie(response); لتحديث تفاصيل تسجيل الدخول أيضًا في جانب العميل، حيث response هي بيانات الاستجابة التي تم إرجاعها بواسطة هذه الوظيفة.
المعلمات
profile_image |
عنوان URL لصورة الملف الشخصي للمستخدم. |
first_name |
الاسم الأول للمستخدم. |
last_name |
الاسم الأخير للمستخدم. |
|
|
البريد الإلكتروني للمستخدم. |
department |
المعرف الخاص بقسم المستخدم. يمكنك الحصول على المعرفات من الإعدادات > متفرقات > الأقسام. لا يتم التحقق من صحة معرف القسم، لذا تحقق من معرف القسم للتأكد من أنه موجود. |
الاستجابة
YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn...
sb_delete_user()
حذف مستخدم وجميع المحادثات والرسائل المرتبطة.
المعلمات
user_id |
معرف المستخدم الذي سيتم حذفه. |
الاستجابة
true
sb_delete_users()
حذف عدة مستخدمين وجميع المحادثات والرسائل المرتبطة.
المعلمات
user_ids |
مصفوفة من معرفات المستخدمين الذين سيتم حذفهم. تنسيق المصفوفة: [123, 123, 123, ...] |
الاستجابة
true
sb_delete_leads()
حذف جميع العملاء المحتملين، بما في ذلك جميع المحادثات والرسائل المرتبطة.
الاستجابة
true
sb_current_url()
الحصول على أو تعيين عنوان URL الحالي للمستخدم أو آخر عنوان URL تم زيارته.
المعلمات
user_id |
معرف المستخدم |
url |
عنوان URL لتعيينه كـ "عنوان URL الحالي". إذا تم تعيين هذه المعلمة، فستقوم الدالة بتعيين القيمة فقط ولن تعيد أي عنوان URL. |
الاستجابة
https://alfchatbot.com
ارجع false إذا لم يتم العثور على عنوان URL. ارجع true إذا تم تعيين معلمة url.
sb_count_users()
يرجع إجمالي عدد المستخدمين مُجمّعًا حسب نوع المستخدم.
الاستجابة
{
"all": "335",
"lead": "288",
"user": "15",
"visitor": "28"
}
sb_update_user_to_lead()
تغيير نوع المستخدم إلى عميل محتمل.
المعلمات
user_id |
معرف المستخدم. |
الاستجابة
true
sb_slack_users()
يعرض معلومات الاتصال بأعضاء الوكلاء في Slack. تطبيق Slack مطلوب.
الاستجابة
{
"slack_users": [
{
"id": "U328T701Z",
"name": "Support Schio"
},
{
"id": "UR5F0GK7T",
"name": "Robert Pitt"
}
...
],
"agents": [
{
"id": "2",
"name": "Alex Smith"
},
{
"id": "445",
"name": "Federico Schiocchet"
},
{
"id": "724",
"name": "Alberto Prade"
}
...
],
"saved": {
"U328T701Z": "445",
"UR5F0GK7T": "2"
...
}
}
الاستجابة
true
sb_is_agent()
تحقق مما إذا كان نوع المستخدم المعطى هو مشرف أو وكيل أو بوت.
المعلمات
user |
مستخدم من Alfchatbot، أو سلسلة نصية. |
exclude_bot |
اضبطه على true لإرجاع false إذا كان المستخدم النشط هو البوت. الافتراضي: false. |
exclude_admin |
اضبطه على true لإرجاع true فقط إذا كان المستخدم النشط هو مشرف. الافتراضي: false. |
الاستجابة
ارجع true إذا كان نوع المستخدم هو "admin" أو "agent" أو "bot"، خلاف ذلك ارجع false.
sb_supervisor()
تحقق مما إذا كان المشرف النشط هو المشرف وأعد إعدادات المشرف إذا كان الأمر كذلك.
الاستجابة
ارجع إعدادات المشرف إذا كان معرف الوكيل النشط هو نفسه المعرف المحدد في الإعدادات > المشرف > مشرف > معرف المشرف، خلاف ذلك، ارجع false.
sb_get_department()
يعرض قسم المستخدم النشط. تُستخدم هذه الدالة في المنطقة الإدارية.
الاستجابة
ارجع معرف القسم إذا تم تعيينه، خلاف ذلك، ارجع false.
sb_password_verify()
تحقق مما إذا كانت كلمة المرور المعطاة تتطابق مع هاش كلمة المرور المعطاة. يتم حفظ هاش كلمة المرور في قاعدة البيانات في عمود password من جدول sb_users.
المعلمات
password |
كلمة المرور للتحقق منها. |
hash |
هاش كلمة المرور. |
الاستجابة
ارجع true إذا تطابقت كلمة المرور مع الهاش، خلاف ذلك، ارجع false.
sb_user_autodata()
أضف التفاصيل التالية للمستخدم النشط: المدينة، الموقع، البلد، المنطقة الزمنية، العملة، المتصفح، لغة المتصفح، نظام التشغيل. يتم إنشاء هذه التفاصيل تلقائيًا.
المعلمات
user_id |
معرف المستخدم النشط. |
الاستجابة
true
sb_is_typing()
تحقق مما إذا كان المستخدم أو الوكيل يكتب رسالة في محادثة.
المعلمات
user_id |
معرف المستخدم، أو الوكيل، للتحقق. |
conversation_id |
معرف المحادثة للتحقق. |
الاستجابة
ارجع true إذا كان المستخدم يكتب، خلاف ذلك، ارجع false.
sb_is_agent_typing()
تحقق مما إذا كان الوكيل يكتب رسالة في محادثة، وأعد تفاصيل الوكيل.
المعلمات
conversation_id |
معرف المحادثة للتحقق. |
الاستجابة
{
"id": "",
"first_name": "",
"last_name": ""
}
ارجع false إذا لم يكن أي وكلاء يكتبون.
sb_set_typing()
تعيين حالة الكتابة لمستخدم أو وكيل بالنسبة لمحادثة.
المعلمات
user_id |
معرف المستخدم أو الوكيل. |
conversation_id |
معرف المحادثة. |
source |
مصفوفة لتعيين حالة الكتابة على الخدمات الخارجية. Facebook Messenger: ['fb', USER-ID, FB-PAGE-ID]. |
الاستجابة
true
sb_is_online()
تحقق مما إذا كانت التاريخ والوقت المعطاة معترف بها كـ متصل بواسطة Alfchatbot.
المعلمات
datetime |
التاريخ والوقت بالتنسيق التالي: YYYY-MM-DD HH:MM:SS. مثال: 2020-05-13 13:35:59. يمكنك إزالة الوقت وترك التاريخ فقط. |
الاستجابة
true إذا كان متصلاً، false إذا كان غير متصل.
sb_is_user_online()
تحقق مما إذا كان المستخدم متصلاً. هذه الدالة متوافقة مع Pusher و Slack.
المعلمات
user_id |
معرف المستخدم. |
الاستجابة
true إذا كان متصلاً، false إذا كان غير متصل.
sb_agents_online()
تحقق مما إذا كان هناك وكيل أو مشرف واحد على الأقل متصل.
الاستجابة
true إذا كان هناك وكلاء أو مشرفون متصلون، أو false إذا كان جميع الوكلاء غير متصلين.
sb_get_bot_id()
يعرض معرف البوت.
الاستجابة
123456
sb_get_user_from_conversation()
يعرض تفاصيل المستخدم، أو آخر وكيل، للمحادثة المعطاة.
المعلمات
conversation_id |
معرف المحادثة. |
agent |
اضبطه على true للحصول على آخر وكيل رد على المحادثة. الافتراضي: false. |
الاستجابة
{
"id": "123456",
"email": "email@example.com"
}
sb_get_avatar()
توليد صورة ملف تعريف المستخدم باستخدام الحرف الأول من الاسم الأول واسم العائلة، حفظ الصورة، وإرجاع عنوان URL للصورة.
المعلمات
first_name |
الاسم الأول للمستخدم. |
last_name |
اسم العائلة للمستخدم. |
الاستجابة
https://example.com/alfchatbot/uploads/13-04-21/9455859.png
sb_get_active_user_ID()
يعرض معرف المستخدم النشط.
الاستجابة
معرف المستخدم.
sb_get_user_by
ارجع معلومات المستخدم حسب الحقل المعطى.
المعلمات
by |
الحقل. القيم المقبولة: email, first_name, last_name, phone, [exta]. [extra] هو أي تفصيل إضافي للمستخدم. |
value |
قيمة الحقل. |
الاستجابة
{
"id": "881",
"first_name": "Don",
"last_name": "John",
"email": "example@example.com",
"user_type": "visitor",
"department": null
}
Conversations
Functions to manage conversations and messages.
sb_get_conversation()
Returns a conversation and the messages of the conversation.
Arguments
user_id |
The ID of the user linked to the conversation. |
conversation_id |
The ID of the conversation. |
Response
{
"messages": [
{
"id": "2044",
"user_id": "802",
"message": "Hello!",
"creation_time": "2020-05-0410:06:30",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "946",
"first_name": "Don",
"last_name": "John",
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "lead"
},
{
"id": "2045",
"user_id": "377",
"message": "Hello, how can I help?",
"creation_time": "2020-05-0410:06:33",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "946",
"first_name": "Bruce",
"last_name": "Peterson",
"profile_image": "https://alfchatbot.com/agent.svg",
"user_type": "agent"
}
],
"details": {
"user_id": "802",
"first_name": "Don",
"last_name": "John",
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "lead",
"id": "946",
"title": "",
"conversation_time": "2020-05-0410:06:30",
"conversation_status_code": "3",
"department": null
}
}
sb_get_conversations()
Returns all the conversations. Each conversation includes the last message of the conversation.
Arguments
pagination |
Integer from 1 to N to limit the results number. Insert 1 to get the first 100 results, 2 for the results from 101 to 200, etc. |
status_code |
The status code of the returned conversations. Default: all the conversations in the inbox, excluding conversations in trash and archive. Status codes: live = 0, waiting answer from user = 1, waiting answer from agent = 2, archive = 3, trash = 4. |
department |
Returns only the conversations assigned to the provided department ID. |
source |
Returns only the conversations created from the provided source. Available sources: em (Email), tk (Ticket), wa (WhatsApp), fb (Facebook Messenger), ig (Instagram), tw (Twitter), wc (WeChat), tx (Text message), gb (Google Business Messages). |
Response
[
{
"id": "1431",
"user_id": "632",
"message": "Hello!",
"creation_time": "2020-04-24 10:53:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "764",
"message_user_type": "lead",
"first_name": "Don",
"last_name": "John",
"profile_image": "https://alfchatbot.com/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
},
{
"id": "1430",
"user_id": "631",
"message": "Hi! Can you help me?",
"creation_time": "2020-04-24 10:38:37",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "763",
"message_user_type": "lead",
"first_name": "Jessica",
"last_name": "Brenson",
"profile_image": "https://alfchatbot.com/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
}
]
sb_get_new_conversations()
Returns the conversations created after the given date/ID or with a message created after the given date/ID. Each conversation includes the last message of the conversation.
Arguments
datetime |
Conversation ID or date and time in the following format: YYYY-MM-DD HH:MM:SS. Ex. 2020-05-13 13:35:59. You can remove the time and leave only the date. The dates stored in the database are in UTC+0. |
الاستجابة
[
{
"id": "1431",
"user_id": "632",
"message": "مرحبًا!",
"creation_time": "2020-04-24 10:53:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "764",
"message_user_type": "lead",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
},
{
"id": "1430",
"user_id": "631",
"message": "مرحبًا! هل يمكنك مساعدتي؟",
"creation_time": "2020-04-24 10:38:37",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "763",
"message_user_type": "lead",
"first_name": "جيسيكا",
"last_name": "برينسون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"conversation_status_code": "2",
"user_type": "lead"
}
]
sb_get_user_conversations()
يرجع المحادثات الخاصة بالمستخدم. تشمل كل محادثة آخر رسالة في المحادثة.
المعلمات
user_id |
معرف المستخدم للمحادثات المراد الحصول عليها. |
exclude_id |
استبعاد محادثة من النتائج. |
agents |
حدد true إذا كان المستخدم وكيلًا أو مسؤولًا. الافتراضي: false. |
الاستجابة
[
{
"id": "2266",
"user_id": "377",
"message": "مرحبًا، كيف حالك؟",
"creation_time": "2020-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"user_type": "lead",
"conversation_status_code": "3"
},
{
"id": "2267",
"user_id": "5",
"message": "يرجى ترك تعليق.",
"creation_time": "2020-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "آدم",
"last_name": "غيتس",
"profile_image": "https://alfchatbot.com/media/user.svg",
"user_type": "agent",
"conversation_status_code": "3"
}
]
sb_get_last_conversation_id_or_create()
يرجع معرّف آخر محادثة للمستخدم إذا كانت موجودة، وإذا لم توجد أي محادثة، فإنه ينشئ محادثة جديدة ويرجع معرّفها.
المعلمات
user_id |
معرّف المستخدم. |
conversation_status_code |
رمز حالة المحادثة التي سيتم إنشاؤها إذا لم يتم العثور على محادثات. رموز الحالة: مباشر = 0، انتظار إجابة من المستخدم = 1، انتظار إجابة من الوكيل = 2، أرشيف = 3، سلة المهملات = 4. |
الاستجابة
معرّف المحادثة.
sb_get_new_user_conversations()
يرجع المحادثات الخاصة بالمستخدم التي تم إنشاؤها بعد التاريخ/المعرف المحدد أو التي تحتوي على رسالة تم إنشاؤها بعد التاريخ/المعرف المحدد. تشمل كل محادثة آخر رسالة في المحادثة.
المعلمات
user_id |
معرّف المستخدم للمحادثات المراد الحصول عليها. |
datetime |
معرّف المحادثة أو التاريخ والوقت بالتنسيق التالي: YYYY-MM-DD HH:MM:SS. مثل 2020-05-13 13:35:59. يمكنك إزالة الوقت وترك التاريخ فقط. التواريخ المخزنة في قاعدة البيانات هي بتوقيت UTC+0. |
الاستجابة
[
{
"id": "2266",
"user_id": "377",
"message": "مرحبًا، كيف حالك؟",
"creation_time": "2020-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"user_type": "lead",
"conversation_status_code": "3"
},
{
"id": "2267",
"user_id": "5",
"message": "يرجى ترك تعليق.",
"creation_time": "2020-05-12 17:30:35",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "995",
"first_name": "آدم",
"last_name": "غيتس",
"profile_image": "https://alfchatbot.com/media/user.svg",
"user_type": "agent",
"conversation_status_code": "3"
}
]
sb_search_conversations()
يرجع المحادثات التي تتطابق مع مصطلحات البحث.
المعلمات
search |
سلسلة تحتوي على مصطلحات البحث. تدعم وظيفة البحث أسماء المرفقات، رسائل المحادثات، البريد الإلكتروني للمستخدم، واسم رسالة المحادثة. |
الاستجابة
[
{
"id": "2130",
"user_id": "806",
"message": "مرحبًا! كيف يمكنني مساعدتك؟",
"creation_time": "2020-05-05 15:45:38",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "952",
"message_user_type": "admin",
"first_name": "مستخدم",
"last_name": "#24254",
"profile_image": "https://alfchatbot.com/media/user.svg",
"conversation_status_code": "4",
"user_type": "lead"
},
{
"id": "2127",
"user_id": "805",
"message": "مرحبًا، أحتاج إلى مساعدة!",
"creation_time": "2020-05-05 08:12:57",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "951",
"message_user_type": "user",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"conversation_status_code": "0",
"user_type": "user"
}
]
sb_search_user_conversations()
يُرجع المحادثات الخاصة بالمستخدم النشط أو بمعرّف المستخدم المحدد التي تطابق مصطلحات البحث.
المعلمات
search |
سلسلة تحتوي على مصطلحات البحث. تدعم وظيفة البحث أسماء المرفقات، رسائل المحادثات، وعنوان المحادثة. |
id |
معرّف المستخدم. الافتراضي: معرف المستخدم النشط. |
الاستجابة
[
{
"id": "3362",
"user_id": "2",
"message": "مرحبًا! كيف يمكنني مساعدتك؟",
"creation_time": "2020-06-24 17:34:39",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1364",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"user_type": "lead",
"conversation_status_code": "0"
},
{
"id": "3345",
"user_id": "1195",
"message": "مرحبًا، أحتاج إلى مساعدة!",
"creation_time": "2020-06-24 17:06:23",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1363",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/media/user.svg",
"user_type": "lead",
"conversation_status_code": "2"
}
]
sb_new_conversation()
إنشاء محادثة جديدة.
المعلمات
user_id |
معرّف المستخدم المرتبط بالمحادثة. |
status_code |
رمز حالة المحادثة. الافتراضي: 0. رموز الحالة: مباشر = 0، انتظار إجابة من المستخدم = 1، انتظار إجابة من الوكيل = 2، أرشيف = 3، سلة المهملات = 4. |
title |
عنوان المحادثة. الافتراضي: سلسلة فارغة. |
department |
معرّف القسم. يمكنك الحصول على المعرفات من الإعدادات > متفرقات > الأقسام. الافتراضي: -1. |
agent_id |
معرّف الوكيل المكلف بالمحادثة. الافتراضي: -1. |
source |
تعيين مصدر المحادثة. الافتراضي: false. |
extra |
قيم إضافية للمحادثة. الافتراضي: false. |
الاستجابة
{
"messages": [],
"details": {
"user_id": "882",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "lead",
"id": "1007",
"title": "",
"conversation_time": "2020-05-15 12:51:39",
"conversation_status_code": "0",
"department": null
}
}
الاستجابات الممكنة الأخرى: تفاصيل المحادثة كمصفوفة عند النجاح، وإلا المستخدم غير موجود، أو رسالة خطأ SQL.
sb_update_conversation_status()
تحديث رمز حالة المحادثة.
المعلمات
conversation_id |
معرّف المحادثة. |
status_code |
رمز حالة المحادثة. رموز الحالة: مباشر = 0، انتظار إجابة من المستخدم = 1، انتظار إجابة من الوكيل = 2، أرشيف = 3، سلة المهملات = 4. |
الاستجابة
true
يتم إرجاع رمز حالة غير صالح إذا كان رمز الحالة غير صالح.
sb_update_conversation_department()
تحديث القسم الخاص بالمحادثة وإرسال بريد إلكتروني إلى جميع الوكلاء في القسم الجديد بشكل اختياري.
المعلمات
conversation_id |
معرّف المحادثة التي تريد تحديثها. |
department |
معرّف القسم. يمكنك الحصول على المعرفات من الإعدادات > متفرقات > الأقسام. لا يتم تنفيذ التحقق من صحة معرّف القسم، لذا تأكد من صحة معرّف القسم. |
message |
رسالة لإرسالها إلى الوكلاء. إذا تم تعيينها، سيتم إرسال بريد إلكتروني يحتوي على الرسالة إلى جميع الوكلاء لإخطارهم بتغيير القسم. |
الاستجابة
true
sb_set_rating()
تعيين تقييم لمحادثة وتحديث رسالة المحادثة اختياريًا.
المعلمات
settings |
أدخل المصفوفة التالية: [ "settings" => [ "conversation_id" => "ID", "rating" => "RATING" ] ]. استبدل ID بمعرّف المحادثة التي تريد تقييمها، واستبدل rating بـ 1 للحصول على تقييم إيجابي، أو بـ 0 للحصول على تقييم سلبي. |
payload |
حمولة الرسالة بتنسيق JSON. |
message_id |
معرّف الرسالة التي تريد تحديثها. |
message |
محتوى الرسالة. |
user_id |
معرّف المستخدم المرتبط بالمحادثة. |
الاستجابة
true
sb_get_rating()
الحصول على تقييمات المحادثات المخصصة لوكيل معين.
المعلمات
user_id |
معرّف الوكيل. |
الاستجابة
[4, 2]
مصفوفة الاستجابة: [عدد التقييمات الإيجابية، عدد التقييمات السلبية]. في المثال أعلاه هناك 4 تقييمات إيجابية و 2 تقييمات سلبية.
sb_get_new_messages()
إرجاع الرسائل الخاصة بمحادثة تم إنشاؤها بعد التاريخ/المعرف المحدد.
المعطيات
user_id |
معرف المستخدم في المحادثة. |
conversation_id |
معرف المحادثة. |
datetime |
التاريخ والوقت بالتنسيق التالي: YYYY-MM-DD HH:MM:SS. مثال: 2020-05-13 13:35:59. يمكنك إزالة الوقت والاكتفاء بالتاريخ فقط. التواريخ المخزنة في قاعدة البيانات تكون بتوقيت UTC+0. |
last_id |
معرف آخر رسالة، استخدم هذا المعامل لاستبعاد جميع الرسائل ذات المعرف الأقل. |
الاستجابة
[
{
"id": "2319",
"user_id": "377",
"message": "مرحبًا بكم في دردشة الدعم الخاصة بنا!",
"creation_time": "2020-05-12 18:04:50",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1004",
"first_name": "وكيل",
"last_name": "افتراضي",
"profile_image": "https://alfchatbot.com/bot.svg",
"user_type": "bot"
},
{
"id": "2320",
"user_id": "877",
"message": "شكرًا لك! أحتاج إلى مساعدة.",
"creation_time": "2020-05-12 18:04:51",
"attachments": "",
"status_code": "0",
"payload": "",
"conversation_id": "1004",
"first_name": "دون",
"last_name": "جون",
"profile_image": "https://alfchatbot.com/user.svg",
"user_type": "lead"
},
...
]
sb_send_message()
إضافة رسالة جديدة إلى محادثة موجودة.
المعطيات
sender_id |
معرف المستخدم الذي يرسل الرسالة. |
conversation_id |
معرف المحادثة. |
message |
محتوى الرسالة. |
attachments |
مصفوفة المرفقات. صيغة المصفوفة: [["name", "link"], ["name", "link"], ...]. استبدل name باسم المرفق و link بالرابط الكامل للمرفق. يجب عليك رفع المرفقات إلى خادم بعيد، هذا المعامل يقبل فقط روابط الملفات التي تم رفعها بالفعل. الافتراضي: []; |
conversation_status |
رمز حالة المحادثة. رموز الحالة: مباشر = 0، انتظار إجابة من المستخدم = 1، انتظار إجابة من الوكيل = 2، الأرشيف = 3، سلة المهملات = 4. عيّنها على تجاوز لترك حالة المحادثة الحالية. |
payload |
مصفوفة من المعلومات الإضافية. يمكنك إدخال أي قيمة. صيغة المصفوفة: { "key": value, "key": value, ... }. استخدم هذا المعامل لتعيين حدث، الأحداث المتاحة: delete-message، open-chat. |
queue |
عيّنها على true إذا كانت القائمة نشطة في الإعدادات > متفرقات > قائمة الانتظار. الافتراضي: false. |
recipient_id |
معرف المستخدم الذي يستلم الرسالة. استخدم هذا المعامل للحصول على لغة المستخدم. |
الاستجابة
{
"status": "success",
"message-id": 123456,
"queue": false,
"notifications": ["sms", "email"]
}
الاستجابات الأخرى الممكنة: رمز الحالة غير صالح, رسالة خطأ SQL. تتضمن استجابة الإشعارات الإشعارات المرسلة إلى المستخدم أو الوكلاء.
sb_direct_message()
إرسال رسالة دردشة مباشرة، أو بريد إلكتروني، أو رسالة نصية إلى مستخدم واحد، أو عدة مستخدمين. لا يتم إرسال إشعارات البريد الإلكتروني والرسائل النصية للرسائل المباشرة. تحتاج إلى إرسال الإشعارات يدويًا عبر sb_email() وsb_send_sms().
المعطيات
user_ids |
مصفوفة، أو سلسلة مفصولة بفواصل تحتوي على معرفات المستخدمين الذين سيتم إرسال الرسالة إليهم. قم بتعيينها إلى all لإرسال الرسالة إلى جميع المستخدمين. |
message |
محتوى الرسالة. |
subject |
موضوع البريد الإلكتروني. مطلوب فقط للبريد الإلكتروني. |
الاستجابة
true
sb_messaging_platforms_send_message()
إرسال رسالة إلى منصة المراسلة المرتبطة بالمحادثة.
المعطيات
message |
محتوى الرسالة. |
conversation_id |
معرف المحادثة. |
message_id |
معرف رسالة Alfchatbot. استخدم هذا المعامل لتجنب الرسائل المكررة. |
الاستجابة
true
sb_send_slack_message()
إرسال رسالة إلى Slack. تطبيق Slack مطلوب ويجب أن يكون Slack نشطًا في منطقة الإعدادات.
المعطيات
الاستجابة
["success", "C011JFFGSKY"]
الاستجابات الأخرى الممكنة: slack-not-active, رسالة خطأ SQL أو cURL.
sb_update_message()
تحديث رسالة موجودة.
المعطيات
message_id |
معرف الرسالة. |
message |
محتوى الرسالة. |
attachments |
مصفوفة من المرفقات. صيغة المصفوفة: [["name", "link"], ["name", "link"], ...]. استبدل name باسم المرفق و link بالرابط الكامل للمرفق. يجب عليك رفع المرفقات إلى خادم بعيد، هذا المعامل يقبل فقط روابط الملفات التي تم رفعها بالفعل. الافتراضي: []; |
payload |
مصفوفة من المعلومات الإضافية. يمكنك إدخال أي قيمة. صيغة المصفوفة: { "key": value, "key": value, ... }. |
الاستجابة
true
sb_delete_message()
حذف رسالة موجودة.
المعلمات
message_id |
معرف الرسالة التي يجب حذفها. |
الاستجابة
true
sb_close_message()
إرسال رسالة الإغلاق إلى محادثة المستخدم. يمكن تعيين محتويات رسالة الإغلاق في منطقة الإعدادات > الدردشة > رسالة الإغلاق.
المعلمات
conversation_id |
معرف المحادثة الذي سيتم إرسال الرسالة إليه. |
bot_id |
معرف المستخدم المرسل. عادةً ما يكون معرف الروبوت. يمكنك الحصول على معرف الروبوت باستخدام الدالة sb_get_bot_id(); |
الاستجابة
{
"status": "success",
"message-id": 123456
}
sb_text_formatting_to_html()
تحويل تنسيق النصوص في رسائل الدردشة إلى أكواد HTML المكافئة وإرجاع الرسالة.
المعلمات
message |
رسالة النص. |
الاستجابة
Lorem ipsum dolor <b>sit amet</b>, <i>consectetur adipiscing elit</i>, <code>sed</code> do eiusmod tempor incididunt.
sb_clear_text_formatting()
إزالة تنسيق النصوص من رسائل الدردشة.
المعلمات
message |
رسالة النص. |
الاستجابة
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt.
sb_conversation_security_error()
التحقق مما إذا كان المستخدم النشط مخولاً لتحديث المحادثة. يمكن للوكلاء والمديرين دائمًا تحديث جميع المحادثات، بينما يمكن للمستخدمين تحديث محادثاتهم الخاصة فقط.
المعلمات
conversation_id |
معرف المحادثة. |
الاستجابة
ترجع true إذا لم يكن المستخدم النشط مخولاً، بخلاف ذلك، ترجع false.
sb_set_agent_active_conversation()
الإبلاغ عن أن الوكيل يرد على المحادثة. يتم وضع علامة على المحادثة بأنها مشغولة لمدة ساعتين إذا لم يتم تنفيذ هذه الدالة مرة أخرى من قبل نفس الوكيل لمحادثة أخرى.
المعلمات
conversation_id |
معرف المحادثة. |
agent_id |
معرف الوكيل. الافتراضي: معرف المستخدم النشط. |
sb_is_active_conversation_busy()
التحقق مما إذا كان الوكيل يرد على المحادثة. تقوم هذه الدالة بالتحقق مما إذا كانت الدالة sb_set_agent_active_conversation() قد تم تنفيذها للمحادثة المحددة بواسطة وكيل آخر خلال ساعتين.
المعلمات
agent_id |
معرف الوكيل. |
skip |
قم بتعيينه إلى معرف المستخدم النشط لاستبعاد الوكيل النشط من التحقق. الافتراضي: -1. |
الاستجابة
ترجع true إذا كان الوكيل يرد على المحادثة.
sb_sb_get_agents_in_conversation()
ترجع مصفوفة تحتوي على جميع الوكلاء الذين لديهم رسالة واحدة على الأقل في المحادثة.
المعلمات
conversation_id |
معرف المحادثة. يمكن أن يكون مصفوفة من معرفات المحادثات. |
الاستجابة
{
"1546": [
{
"id": 5463,
"first_name": "Don",
"last_name": "John",
"profile_image": "https://alfchatbot.com/user.svg",
"conversation_id": 1546
},
{
"id": 6413,
"first_name": "Steven",
"last_name": "Travolta",
"profile_image": "https://alfchatbot.com/user.svg",
"conversation_id": 1546
},
...
],
...
}
قاعدة البيانات
الدوال لقراءة البيانات من قاعدة البيانات وحفظ البيانات فيها.
sb_db_get()
ترجع بيانات استعلام SQL.
المعلمات
query |
استعلام SQL. |
single |
قم بتعيينه إلى false إذا كان الاستعلام يجب أن يرجع عدة نتائج. الافتراضي: true. |
الاستجابة
نتيجة الاستعلام كقيمة واحدة أو كمصفوفة من القيم. يُرجع SBError إذا كان الاستعلام غير صحيح.
sb_db_query()
تنفيذ استعلام SQL لتحديث البيانات في قاعدة البيانات.
المعلمات
query |
استعلام SQL. |
return |
قم بتعيينه إلى true إذا كان الاستعلام يجب أن يُرجع قيمة. الافتراضي: false. |
الاستجابة
يُرجع true، أو القيمة المُرجعة، أو SBError إذا كان الاستعلام غير صحيح.
sb_db_escape()
يقوم بتجاوز الأحرف الخاصة في سلسلة لاستخدامها في استعلام SQL. استخدم هذه الدالة لتجاوز كل متغير يُستخدم في استعلام SQL يحتوي على سلاسل بدون قيمة معروفة.
المعلمات
value |
السلسلة لتجاوزها. |
الاستجابة
يُرجع السلسلة المتجاوزة.
sb_db_json_enconde()
تحويل مصفوفة إلى JSON وتجاوز القيم لاستخدامها في استعلام SQL. استخدم هذه الدالة لتحويل كل متغير يحتوي على مصفوفات يُستخدم في استعلام SQL.
المعلمات
array |
المصفوفة للتحويل والتجاوز. |
الاستجابة
يُرجع المصفوفة المحولة.
sb_db_check_connection()
يتحقق مما إذا كان اتصال قاعدة البيانات صحيحًا أو يتحقق مما إذا كانت التفاصيل المقدمة صحيحة. جميع المعلمات اختيارية. إذا لم يتم تقديم معلمة، فسيتم استخدام المعلمة المقدمة خلال التثبيت.
المعلمات
name |
اسم قاعدة البيانات. |
user |
اسم مستخدم قاعدة البيانات. |
password |
كلمة مرور قاعدة البيانات. |
host |
مضيف قاعدة البيانات. |
port |
منفذ قاعدة البيانات. |
الاستجابة
يُرجع true إذا كان الاتصال صحيحًا، بخلاف ذلك، يُرجع رسالة خطأ الاتصال.
اللغة والترجمات
الدوال لترجمة السلاسل إلى لغات أخرى وإدارة الترجمات.
sb_()
ترجمة سلسلة إلى لغة المستخدم النشط. استخدم الدالة sb_e($string) للترجمة و echo السلسلة.
المعلمات
string |
السلسلة للترجمة. |
الاستجابة
يُرجع السلسلة المترجمة إذا كانت متاحة، بخلاف ذلك، يُرجع السلسلة الأصلية.
sb_get_translations()
يُرجع الترجمات الخاصة بالواجهة الخلفية والواجهة الأمامية، لجميع اللغات المتاحة.
الاستجابة
{
"ar": {
"name": "العربية",
"front": {
"Activities": "أنشطة",
"All": "الكل",
...
},
"admin": {
"A conversation was started by": "",
"Activate": "",
...
},
"admin/js": {
"Add new user": "",
"Add translation": "",
...
},
"admin/settings": {
"Active for agents": "",
"Active for users": "",
...
}
},
"da": {
"name": "الدانماركية",
"front": {
"Activities": "Aktiviteter",
"All": "Alle",
...
},
...
},
...
}
sb_get_translation()
يُرجع الترجمات الخاصة بالواجهة الخلفية والواجهة الأمامية للغة واحدة.
الاستجابة
{
"name": "العربية",
"front": {
"Activities": "أنشطة",
"All": "الكل",
...
},
"admin": {
"A conversation was started by": "",
"Activate": "",
...
},
"admin/js": {
"Add new user": "",
"Add translation": "",
...
},
"admin/settings": {
"Active for agents": "",
"Active for users": "",
...
}
}
sb_save_translations()
حفظ الترجمات وكتابة الترجمات في الملفات. تحذير! إذا كانت مصفوفة الترجمات المقدمة تالفة، فقد تتلف ملفات الترجمات. قم بعمل نسخة احتياطية من مجلد الترجمات ( \resources\languages\) أولاً. في كل مرة يتم فيها حفظ الترجمة، يتم إنشاء نسخة احتياطية تلقائيًا في مجلد uploads.
المعلمات
translations |
مصفوفة الترجمات مع جميع الترجمات. استخدم الدالة sb_get_translations() للحصول عليها. |
الاستجابة
true
sb_get_user_language()
يُرجع رمز اللغة النشطة المستخدمة من قبل المستخدم. بشكل افتراضي، هي لغة متصفح المستخدم.
المعلمات
user_id |
معرّف المستخدم الذي تريد الحصول على اللغة منه. الافتراضي: false. |
الاستجابة
رمز اللغة. أمثلة: es, it.
sb_get_admin_language()
يُرجع رمز اللغة لمنطقة الإدارة المتعلقة بالمستخدم النشط.
المعلمات
user_id |
معرّف الوكيل أو المسؤول الذي تريد الحصول على اللغة منه. الافتراضي: false. |
الاستجابة
رمز اللغة. أمثلة: es, it.
Dialogflow
وظائف تطبيق Dialogflow لإدارة الروبوت الدردشة والمزيد. تطبيق Dialogflow مطلوب لاستخدام مجموعة APIs هذه.
sb_dialogflow_message()
إرسال رسالة إلى Dialogflow وإضافة استجابة Dialogflow إلى محادثة موجودة كرسالة جديدة.
المعلمات
conversation_id |
معرّف المحادثة. |
message |
محتوى الرسالة. |
token |
رمز جلسة Dialogflow (ليس رمز التحديث). مرره إذا كان لديك، وإلا سيتم إنشاؤه. لأسباب تتعلق بالأداء، من الأفضل دائمًا تضمين هذا الرمز. ستتلقى الرمز بعد الاستدعاء الأول لهذه الدالة من الاستجابة. الافتراضي: false. |
language |
رمز لغة وكيل Dialogflow. الافتراضي: رمز لغة الوكيل الرئيسي. |
attachments |
مصفوفة من المرفقات. صيغة المصفوفة: [["name", "link"], ["name", "link"], ...]. استبدل name باسم المرفق و link برابط URL الكامل للمرفق. يمكن لـ Dialogflow قراءة هذه المصفوفة. الافتراضي: []. |
event |
تفعيل حدث في Dialogflow. |
parameters |
مصفوفة من المعلومات الاختيارية. صيغة المصفوفة: { "name": "value", "name": "value", ...}. |
project_id |
تعيينه لتغيير وكيل Dialogflow الافتراضي. |
الاستجابة
{
"token": "ya29.a0AfH6SMB5Y04TwKvxeah5pCEtcupfncTOLMlewxlnUAhH5H4HE4SVIeOPWSfxRVfHNcJIoR-IvRTtrEe4P9VXHa",
"messages": [
{
"message": "مرحبًا! كيف حالك؟",
"attachments": []
}
],
"response": {
"responseId": "1a5e30d0-d6d4-4f0c-83e3-2fb9e31c2a5e-e15c53b8",
"queryResult": {
"queryText": "Hello",
"action": "input.welcome",
"parameters": [],
"allRequiredParamsPresent": true,
"fulfillmentText": "مرحبًا! كيف حالك؟",
"fulfillmentMessages": [
{
"platform": "ACTIONS_ON_GOOGLE",
"simpleResponses": {"simpleResponses": [ { "textToSpeech": "مثال"} ]}
},
{
"text": { "text": [ "مرحبًا! كيف حالك؟" ] }
}
],
"intent": {
"name": "projects/api-project-655517752147/agent/intents/fe275c2e-f39d-4db3-92c2-e55582ce38fb",
"displayName": "Default Welcome Intent"
},
"intentDetectionConfidence": 1,
"languageCode": "en"
},
"alternativeQueryResults": [
{
"queryText": "Hello",
"languageCode": "en"
}
]
}
}
استجابات أخرى محتملة: dialogflow-not-active, رسالة خطأ SQL أو cURL.
sb_dialogflow_curl()
إرسال البيانات إلى Dialogflow. استخدم هذه الدالة لتقديم الاستفسارات إلى Dialogflow.
المعلمات
url_part |
عنوان URL الجزئي لواجهة برمجة تطبيقات Dialogflow. أمثلة: /agent/entityTypes, /agent/intents:batchUpdate. |
query |
استعلام Dialogflow بتنسيق JSON أو كمصفوفة. |
language |
رمز لغة وكيل Dialogflow. الافتراضي: رمز لغة الوكيل الرئيسي. |
type |
نوع الاستدعاء. القيم المدعومة: POST, GET, PATCH. الافتراضي: POST. |
token |
رمز جلسة Dialogflow (ليس رمز التحديث). مرره إذا كان لديك، وإلا سيتم إنشاؤه. الافتراضي: false. |
الاستجابة
يعيد استجابة Dialogflow بتنسيق مصفوفة ترابطية. لمزيد من التفاصيل، انظر https://cloud.google.com/dialogflow/es/docs/reference/rest/v2-overview
sb_dialogflow_get_token()
توليد رمز جديد لـ Dialogflow وإرجاعه. الرمز صالح لمدة ساعة واحدة.
الاستجابة
ya27.a1AfH6SMDu9dn0TfRbNVAIEsSoeJPD1_jr1JpfL15...
sb_dialogflow_get_agent()
يعيد تفاصيل وكيل Dialogflow.
الاستجابة
{
"parent": "projects/woocommerce-abcde",
"displayName": "ABCDE",
"defaultLanguageCode": "en",
"timeZone": "Europe/Madrid",
"enableLogging": true,
"matchMode": "MATCH_MODE_HYBRID" ,
"classificationThreshold": 0.6,
"apiVersion": "API_VERSION_V2",
"tier": "TIER_STANDARD"
}
sb_dialogflow_set_active_context()
تفعيل سياق Dialogflow في جلسة المستخدم النشطة.
المعلمات
context_name |
اسم السياق. |
parameters |
مصفوفة من معلمات Dialogflow المرتبطة بالسياق. مثال: ['woocommerce-products' => 'Running Shoes']. يمكن أن تكون المصفوفة أيضًا سلسلة بتنسيق JSON. |
life_span |
مدة بقاء السياق. الافتراضي: 5. |
token |
رمز تحديث Dialogflow. |
user_id |
معرّف المستخدم المرتبط بالسياق. الافتراضي: المستخدم النشط. |
language |
لغة الوكيل. الافتراضي: لغة المستخدم النشط. |
الاستجابة
{
"responseId": "4f6912db-71ac-41e1-b006-088b7647cb59-fddac234",
"queryResult":{
"queryText": "sb-trigger-context",
"parameters":{
"any": "sb-trigger-context"
},
"allRequiredParamsPresent":true,
"fulfillmentMessages":[
{
"text":{
"text":[
""
]
}
}
],
"outputContexts":[
{
"name": "projects/abcde/agent/sessions/244/contexts/abcde",
"lifespanCount":1,
"parameters":{
"woocommerce-products": "",
"any": "sb-trigger-context",
"any.original": "sb-trigger-context"
}
}
],
"intent":{
"name": "projects/abcd/agent/intents/abcde",
"displayName": "woocommerce-waiting-list"
},
"intentDetectionConfidence":0.6,
"languageCode": "en"
}
}
sb_dialogflow_create_intent()
إنشاء نية جديدة في Dialogflow. سيتم ربط النية بوكيل Dialogflow المتزامن في منطقة الإدارة.
المعلمات
expressions |
مصفوفة مع عبارات التدريب. صيغة المصفوفة: ["", "", ...]. |
response |
سلسلة تحتوي على استجابة الروبوت عندما يتطابق إدخال المستخدم مع تعبير المستخدم. |
agent_language |
رمز لغة النية. الافتراضي: لغة الوكيل الرئيسية. لقائمة رموز اللغات، راجع cloud.google.com/dialogflow/docs/reference/language. |
sb_dialogflow_batch_intents()
إنشاء عدة نيات في Dialogflow و السماح بتخصيص أعمق من دالة sb_dialogflow_create_intent().
المعلمات
intents |
مصفوفة من النيات. يجب أن تكون كل نية كائن SBDialogflowIntent. |
language |
رمز لغة وكيل Dialogflow. الافتراضي: رمز لغة الوكيل الرئيسي. |
الاستجابة
{
"name": "projects/woocommerce-app-rojq/operations/bg-f0adhdc5-a1a1-472b-a06c-15559a12cfc7",
"done":true,
"response":{
"@type": "type.googleapis.com/google.cloud.dialogflow.v2.BatchUpdateIntentsResponse",
"intents":[
{
"name": "projects/abcde/agent/intents/abcde",
"displayName": "تفاصيل السلة",
"priority":500000,
"outputContexts":[
{
"name": "projects/abcde/agent/sessions/-/contexts/abcde",
"lifespanCount":5
}
],
"messages":[
{
"text":{
"text":[
"مرحبًا!"
]
}
}
]
},
...
]
}
}
sb_dialogflow_batch_intents_delete()
حذف عدة نيات دفعة واحدة.
المعلمات
intents |
مصفوفة من النيات. يجب أن تكون كل نية كائن SBDialogflowIntent. يمكنك الحصول على النيات الحالية باستخدام الدالة sb_dialogflow_curl('/agent/intents?pageSize=1000', '', '', 'GET'). |
sb_dialogflow_create_entity()
Create a new Dialogflow Entity.
Arguments
entity_name |
The Entity unique name. |
values |
SBDialogflowEntity object or array of Entity values. Single value syntax: ['value' => '', 'synonyms' => ['', '', ...]]. |
language |
The Dialogflow agent language code. Default: main agent language code. |
Response
Return true on success, otherwise returns the Dialogflow error response.
sb_dialogflow_update_entity()
Update an existing Dialogflow Entity.
Arguments
entity_id |
The Entity ID. You can get this value with the function sb_dialogflow_get_entity(). |
values |
SBDialogflowEntity object or array of Entity values. Single value syntax: ['value' => '', 'synonyms' => ['', '', ...]]. |
language |
The Dialogflow agent language code. Default: main agent language code. |
Response
Return true on success, otherwise returns the Dialogflow error response.
sb_dialogflow_get_entity()
Returns a Dialogflow Entity, or all Entities of the agent.
Arguments
entity_id |
The ID of the Entity. Leave empty or insert all to get all Entities. Default: all. |
language |
The Dialogflow agent language code. Default: main agent language code. |
Response
[
{
"name": "projects/small-talk-43da7/agent/entityTypes/t5td1425-2k13-16cc-a7bb-f119b8d94112a",
"displayName": "woocommerce-products",
"kind": "KIND_MAP",
"autoExpansionMode": "AUTO_EXPANSION_MODE_DEFAULT",
"entities":[
{
"value": "Abstract Print Cotton Blouse",
"synonyms":[
"Abstract Print Cotton Blouse"
]
},
{
"value": "Cashmere Carpenter Beanie",
"synonyms":[
"Cashmere Carpenter Beanie"
]
},
...
],
"enableFuzzyExtraction":true
}
]
sb_open_ai_curl()
Call the OpenAI API (ChatGPT) and return the response.
Arguments
url_part |
The URL part of the API. For example, if you want to call https://api.openai.com/v1/completions, enter only completions. |
post_fields |
The parameters of the API. |
type |
The HTTP call type. Allowed values: GET, POST, UPLOAD. |
Response
Returns the OpenAI response. More details at https://beta.openai.com/docs/api-reference/.
ووردبريس
وظائف ووردبريس.
sb_wp_get_user()
يُرجع تفاصيل مستخدم ووردبريس.
الوسائط
user_id |
معرف مستخدم ووردبريس. |
الاستجابة
{
"id": 123,
"first_name": "Don",
"last_name": "John",
"email": "email@example.com",
"password": "$P$BcCpYeU21wYnXKW2LpJj/F9xRdSmLM/"
}
يُرجع false إذا لم يتم العثور على مستخدم.
sb_wp_get_active_user()
الحصول على مستخدم ووردبريس النشط حاليًا وتسجيله كمستخدم في Alfchatbot. إذا كان هناك مستخدم في Alfchatbot نشط حاليًا، فقم بتحديثه بتفاصيل ووردبريس. بعد التسجيل، يتم تسجيل دخول المستخدم. يُرجع تفاصيل تسجيل الدخول والبيانات المشفرة لمستخدم Alfchatbot.
الوسائط
user_id |
معرف مستخدم ووردبريس النشط حاليًا. |
الاستجابة
[
{
"id": "913",
"profile_image": "https://alfchatbot.com/user.svg",
"first_name": "User",
"last_name": "#29902",
"email": null,
"user_type": "visitor",
"token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
},
"YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
sb_wp_synch()
مزامنة مستخدمي ووردبريس مع مستخدمي Alfchatbot. إذا كان تطبيق Ultimate Membership Pro مثبتًا، فإن المزامنة تستورد أيضًا تفاصيل المستخدم الإضافية.
الاستجابة
true
sb_wp_get_user_id()
يُرجع معرف مستخدم ووردبريس مع البريد الإلكتروني المحدد.
الوسائط
|
|
البريد الإلكتروني للمستخدم. |
الاستجابة
1234
يُرجع false إذا لم يتم العثور على مستخدم.
sb_wp_post()
حفظ منشور ووردبريس جديد (صفحة، منشور، ...). هذه الوظيفة تعادل wp_insert_post().
الوسائط
post_title |
عنوان المنشور. |
post_content |
محتوى المنشور. |
post_type |
نوع المنشور. مثال: صفحة، منشور. |
الاستجابة
يُرجع معرف المنشور الجديد.
sb_wp_update_option()
إنشاء أو تحديث خيار ووردبريس. هذه الوظيفة تعادل update_option().
الوسائط
name |
اسم الخيار. |
value |
قيمة الخيار. |
الاستجابة
يُرجع معرف الخيار الجديد.
sb_wp_get_option()
يُرجع قيمة خيار ووردبريس. هذه الوظيفة تعادل get_option().
الوسائط
name |
اسم الخيار. |
الاستجابة
يُرجع قيمة الخيار، أو خطأ إذا لم يتم العثور على خيار بالاسم المحدد.
sb_wp_get_image()
يُرجع عنوان URL للصورة باستخدام معرفها. هذه الوظيفة تعادل wp_get_attachment_image_src().
الوسائط
id |
معرف الصورة في ووردبريس. |
الاستجابة
https://example.com/image.jpg
يُرجع سلسلة فارغة إذا لم يتم العثور على صورة بالمعرف المحدد.
sb_wp_site_url()
يُرجع عنوان URL لموقع الويب.
الاستجابة
https://www.example.com
sb_wp_language_settings()
يُرجع إعدادات اللغة في ووردبريس.
الوسائط
plugin |
اسم المكون الإضافي متعدد اللغات. الافتراضي: المكون الإضافي المحدد في الإعدادات > ووردبريس > المكون الإضافي متعدد اللغات. |
الاستجابة
{
"default": "en",
"languages": [
"en",
"de",
"it"
],
"post-types": [
"attachment",
"wp_block",
"product",
"product_variation",
"food",
"post",
"page"
],
"taxonomies": [
"translation_priority",
"product_cat",
"product_tag",
"product_shipping_class",
"pa_colore-prodotti",
"pa_taglia-prodotti",
"category",
"post_tag"
],
"link-type": "3",
"plugin": "wpml"
}
sb_wp_language_get_page_id()
يُرجع معرف الصفحة المترجم للمعرف المحدد للصفحة.
الوسائط
id |
معرف الصفحة. |
الاستجابة
يُرجع معرف الصفحة المترجم إذا تم العثور على الترجمة، وإلا يُرجع المعرف المحدد.
WooCommerce
وظائف تطبيق WooCommerce. تطبيق WooCommerce مطلوب لاستخدام هذه المجموعة من APIs.
sb_woocommerce_get_customer()
يُرجع تفاصيل عميل WooCommerce.
الوسائط
session_key |
مفتاح جلسة العميل. يمكنك الحصول على هذه القيمة باستخدام الدالة sb_woocommerce_get_session_key(). |
الاستجابة
{
"customer_id": "1",
"user_id": null,
"username": "",
"first_name": "Don",
"last_name": "John",
"email": "email@example.com",
"date_last_active": "2020-08-03 07:21:18",
"date_registered": null,
"country": "UK",
"postcode": "E14HR",
"city": "London",
"state": ""
}
sb_woocommerce_get_user_orders()
يُرجع مصفوفة ملخص الطلبات للمستخدم. استخدم الدالة sb_woocommerce_get_last_order() للحصول فقط على آخر طلب للمستخدم.
الوسائط
user_id |
معرف المستخدم. |
الاستجابة
[
{
"id": "602",
"date": "2020-10-19 14:02:35",
"total": "0",
"status": "wc-on-hold"
},
{
"id": "601",
"date": "2020-10-18 14:02:35",
"total": "0",
"status": "wc-processing"
},
...
]
sb_woocommerce_get_order()
يُرجع تفاصيل طلب.
الوسائط
order_id |
معرف الطلب. |
الاستجابة
{
"id": "601",
"date": "2020-10-19 14:02:10",
"total": "19",
"status": "wc-on-hold",
"products": [
{
"name": "Sony Play Station 5",
"id": "53",
"quantity": "1",
"price": "199"
}
],
"billing_address": "Don John\\n501 Baker Street\\nEW578H London, UK",
"shipping_address": "",
"currency_symbol": "€"
}
sb_woocommerce_get_product()
يُرجع تفاصيل منتج.
الوسائط
product_id |
معرف المنتج. |
الاستجابة
{
"id": "53",
"name": "Sony Play Station 5",
"description": "لوريم إيبسوم دولور سيت أميت، كونسيكتتور أديبيسيسينغ إيليت...",
"price": "19",
"image": "https://example.com/image.jpg",
"rating": "",
"url": "https://example.com/?p=53"
}
sb_woocommerce_get_products()
يُرجع المنتجات التي تطابق الاستعلام المحدد إن وجدت، خلاف ذلك يُرجع جميع المنتجات.
الوسائط
filters |
مصفوفة من الفلاتر. الصيغة:
[ "filter" => "value", "filter" => "value", ... ].
استخدم الفلاتر للحصول على المنتجات التي تطابق معايير محددة. الفلاتر المتاحة:
|
pagination |
حد عدد النتائج إلى 100. اضبطها على 0 للحصول على المنتجات من 1 إلى 100، وعلى 1 للحصول على المنتجات من 101 إلى 200... |
language |
رمز لغة المنتجات. الافتراضي: false. |
الاستجابة
[
{
"id": "53",
"name": "Sony Play Station 5",
"description": "لوريم إيبسوم دولور سيت أميت، كونسيكتتور أديبيسيسينغ إيليت...",
"date": "2020-08-03 07:06:25",
"price": "19",
"image": "https://example.com/image.jpg",
"rating": "",
"url": "https://example.com?p=53"
},
{
"id": "54",
"name": "Xbox Series X",
"description": "لوريم إيبسوم دولور سيت أميت، كونسيكتتور أديبيسيسينغ إيليت...",
"date": "2020-08-03 07:08:19",
"price": "59",
"image": "https://example.com/image.jpg",
"rating": "",
"url": "https://example.com?p=54"
},
...
]
sb_woocommerce_search_products()
يُرجع المنتجات التي تطابق البحث.
الوسائط
search |
سلسلة البحث. |
الاستجابة
[
{
"id": "53",
"name": "Sony Play Station 5",
"description": "لوريم إيبسوم دولور سيت أميت، كونسيكتتور أديبيسيسينغ إيليت...",
"date": "2020-08-03 07:06:25",
"price": "19",
"image": "https://example.com/image.jpg",
"rating": "",
"url": "https://example.com?p=53"
},
{
"id": "54",
"name": "Xbox Series X",
"description": "لوريم إيبسوم دولور سيت أميت، كونسيكتتور أديبيسيسينغ إيليت...",
"date": "2020-08-03 07:08:19",
"price": "59",
"image": "https://example.com/image.jpg",
"rating": "",
"url": "https://example.com?p=54"
},
...
]
sb_woocommerce_get_taxonomies()
يُرجع فئات المنتجات أو العلامات في WooCommerce.
الوسائط
type |
أدخل category أو tag. |
language |
رمز لغة التصنيفات. الافتراضي: false. |
الاستجابة
[
{
"id": "33",
"name": "ملابس",
"slug": "clothes"
},
{
"id": "34",
"name": "إكسسوارات",
"slug": "accessories"
},
...
]
sb_woocommerce_get_attributes()
يُرجع خصائص المنتجات في WooCommerce وأسماء المصطلحات.
الوسائط
type |
اضبطها على terms للحصول فقط على أسماء المصطلحات لجميع الخصائص، و attribute للحصول فقط على أسماء الخصائص. الافتراضي: الكل. |
language |
رمز لغة الخصائص. الافتراضي: false. |
الاستجابة
الكل
{
"colors": {
"id": "1",
"name": "اللون",
"slug": "pa_color",
"terms": {
"red": "أحمر",
"yellow": "أصفر",
"green": "أخضر",
...
}
},
...
}
المصطلحات
[
{
"name": "أحمر"
},
{
"name": "أصفر"
},
{
"name": "صغير"
},
{
"name": "متوسط"
},
{
"name": "كبير"
},
...
]
الخصائص
[
{
"id": "1",
"name": "اللون",
"slug": "pa_color"
},
{
"id": "2",
"name": "الحجم",
"slug": "pa_size"
},
...
]
sb_woocommerce_get_product_id_by_name()
ابحث عن منتج بالاسم وأرجع رقمه التعريفي.
الوسائط
name |
اسم المنتج. |
الاستجابة
يُرجع رقم تعريف المنتج، أو false إذا لم يتم العثور على منتجات بالاسم المحدد.
sb_woocommerce_get_product_images()
يُرجع مصفوفة تحتوي على صور المنتج.
الوسائط
product_id |
رقم تعريف المنتج. |
الاستجابة
[
"https://example.com/image.jpg",
"https://example.com/image.jpg",
...
]
sb_woocommerce_get_product_taxonomies()
يُرجع الفئات والعلامات الخاصة بمنتج.
الوسائط
product_id |
رقم تعريف المنتج. |
الاستجابة
[
{
"term_id": "34",
"name": "أحمر",
"slug": "red",
"term_group": "0",
"taxonomy": "product_cat"
},
{
"term_id": "35",
"name": "إصدار الصيف",
"slug": "summer-edition",
"term_group": "0",
"taxonomy": "product_tag"
},
...
]
sb_woocommerce_get_attribute_by_term()
يُرجع خاصية من خاصية المصطلح.
الوسائط
term_name |
اسم المصطلح. |
الاستجابة
{
"id": "1",
"name": "اللون",
"slug": "pa_color"
}
sb_woocommerce_get_attribute_by_name()
ابحث عن خاصية حسب اسمها وأرجعها.
الوسائط
name |
اسم الخاصية. |
الاستجابة
{
"id": "1",
"name": "اللون",
"slug": "pa_color"
}
sb_woocommerce_is_in_stock()
تحقق مما إذا كان المنتج متوفرًا في المخزون.
الوسائط
product_id |
رقم تعريف المنتج. |
الاستجابة
يُرجع true إذا كان المنتج متاحًا، خلاف ذلك يُرجع false.
sb_woocommerce_coupon()
إنشاء قسيمة ويرجع رمز القسيمة.
الوسائط
discount |
نسبة الخصم. أدخل قيمة من 1 إلى 100. |
expiration |
انتهاء صلاحية القسيمة. مثال: 3 أيام, 1 دقيقة, 60 ثانية. |
product_id |
سلسلة من الأرقام المفصولة بفواصل. مثال: 11,53,63. إذا تم تحديدها، فإن القسيمة صالحة فقط للمنتجات ذات الأرقام التعريفية المحددة. |
user_id |
إذا تم تحديدها، فإن القسيمة صالحة فقط للمستخدم ذو الرقم التعريفي المحدد. |
الاستجابة
[ "fxsocl3490oq", "50" ]
[ رمز القسيمة، قيمة الخصم ]
sb_woocommerce_coupon_check()
تحقق مما إذا كانت هناك قسائم مرتبطة بالمستخدم المحدد.
الوسائط
user_id |
رقم تعريف المستخدم. |
الاستجابة
يُرجع true إذا كانت هناك قسائم مرتبطة بالمستخدم، خلاف ذلك يُرجع false.
sb_woocommerce_coupon_delete_expired()
حذف جميع القسائم المنتهية. يتم تشغيل هذه الوظيفة تلقائيًا كل ساعة عبر وظائف cron.
الاستجابة
true
sb_woocommerce_rating()
احسب وأرجع التقييم المتوسط.
الوسائط
rating |
مصفوفة من التقييمات. احصل على هذه القيمة من rating الخاصة بمنتج. |
الاستجابة
4.56
sb_woocommerce_get_url()
يُرجع عنوان URL لـ WooCommerce.
الوسائط
type |
نوع عنوان URL المطلوب الحصول عليه. القيم المقبولة: tag, category, cart, shop, , checkout. |
name |
اسم الفئة أو الرابط. |
language |
لغة صفحة عنوان URL. الافتراضي: false. |
الاستجابة
يُرجع URL إذا تم العثور عليه، خلاف ذلك يُرجع سلسلة فارغة.
sb_woocommerce_get_session()
يُرجع متغير الجلسة للمستخدم. يحتوي متغير الجلسة على تفاصيل عربة التسوق للمستخدم والمزيد.
الوسائط
session_key |
مفتاح جلسة المستخدم. احصل عليه باستخدام الوظيفة sb_woocommerce_get_session_key(). الافتراضي: مفتاح جلسة المستخدم النشط. |
الاستجابة
{
"cart": {
"d82c8d1619ah8176d665453cfb2e66f0": {
"key": "d82c8d1619ah8176d665453cfb2e66f0",
"product_id": 53,
"variation_id": 0,
"variation": [],
"quantity": 3,
"data_hash": "b5c1d6ca8bae6d4896jf1807cdf713f0",
"line_tax_data": {
"subtotal": [],
"total": []
},
"line_subtotal": 57,
"line_subtotal_tax": 0,
"line_total": 57,
"line_tax": 0
}
},
"cart_totals": {
"subtotal": "57.00",
"subtotal_tax": 0,
"shipping_total": "0.00",
"shipping_tax": 0,
"shipping_taxes": [],
"discount_total": 0,
"discount_tax": 0,
"cart_contents_total": "57.00",
"cart_contents_tax": 0,
"cart_contents_taxes": [],
"fee_total": "0.00",
"fee_tax": 0,
"fee_taxes": [],
"total": "57.00",
"total_tax": 0
},
"applied_coupons": "a:0:{}",
"coupon_discount_totals": "a:0:{}",
"coupon_discount_tax_totals": "a:0:{}",
"removed_cart_contents": "a:0:{}",
"customer": {
"id": "1",
"date_modified": "2020-08-20T09:33:03+00:00",
"postcode": "",
"city": "",
"address_1": "",
"address": "",
"address_2": "",
"state": "",
"country": "",
"shipping_postcode": "",
"shipping_city": "",
"shipping_address_1": "",
"shipping_address": "",
"shipping_address_2": "",
"shipping_state": "",
"shipping_country": "",
"is_vat_exempt": "",
"calculated_shipping": "",
"first_name": "",
"last_name": "",
"company": "",
"phone": "",
"email": "",
"shipping_first_name": "",
"shipping_last_name": "",
"shipping_company": ""
}
}
sb_woocommerce_get_session_key()
يُرجع مفتاح الجلسة للمستخدم.
الوسائط
user_id |
رقم تعريف المستخدم. الافتراضي: رقم تعريف المستخدم النشط. |
الاستجابة
يُرجع مفتاح الجلسة إذا تم العثور عليه، خلاف ذلك يُرجع false.
sb_woocommerce_payment_methods()
يُرجع طرق الدفع المتاحة في المتجر.
الاستجابة
[
"التحويل البنكي المباشر",
"مدفوعات الشيكات",
"الدفع عند التسليم",
"Alipay",
"Multibanco",
"بطاقة الائتمان (Stripe)"
]
sb_woocommerce_shipping_locations()
يُرجع مواقع الشحن في المتجر، أو يتحقق مما إذا كان المتجر يشحن إلى موقع معين.
الوسائط
country_code |
رمز البلد. إذا تم توفيره، فإنه يتحقق مما إذا كان المتجر يشحن إلى البلد ذو الرمز المعطى. الافتراضي: false. |
الاستجابة
[
"أستراليا، إيطاليا، الولايات المتحدة، ...",
[
[
"أستراليا",
"AU"
],
[
"إيطاليا",
"IT"
],
[
"الولايات المتحدة",
"US"
],
...
],
false
]
القيمة الأخيرة في المصفوفة هي true إذا كان المتجر لا يشحن إلى البلدان المعادة.
Pusher
قائمة الوظائف لـ Pusher. مزيد من التفاصيل على pusher.com.
sb_push_notification()
إرسال إشعار دفع إلى وكيل أو مستخدم أو جميع الوكلاء.
الوسائط
title |
عنوان الإشعار. |
message |
نص الرسالة. |
icon |
أيقونة الإشعار. الافتراضي: أيقونة Alfchatbot أو أيقونة الإشعارات. |
interest |
القيم المقبولة هي:
|
conversation_id |
معرف المحادثة لفتحها عندما ينقر المستخدم على الإشعار. |
user_id |
معرف المستخدم الذي أرسل الرسالة. |
attachments |
مرفقات الرسالة لعرض معاينة الصورة. الصيغة: [["name", "url"], ...]. |
الاستجابة
{
"publishId": "pubid-781799f5-6el4-4789-bc60-ee293543781"
}
إرجاع false إذا كانت الإشعارات الدفترية غير مفعلة في منطقة الإعدادات.
sb_pusher_trigger()
تفعيل حدث على قناة Pusher.
المعلمات
channel |
اسم القناة. |
event |
اسم الحدث. |
data |
مجموعة من القيم. الصيغة: [ "name" => "value" ]. |
الاستجابة
true
sb_pusher_get_online_users()
إرجاع مصفوفة من معرّفات المستخدمين والعملاء المتواجدين على القناة المخصصة.
الاستجابة
[
{
"id": "1538"
},
{
"id": "1758"
},
...
]
sb_pusher_agents_online()
التحقق مما إذا كان هناك عميل واحد على الأقل متصل عن طريق التحقق من القناة المخصصة.
الاستجابة
true إذا كان متصلاً، false إذا كان غير متصل.
sb_pusher_active()
التحقق مما إذا كان Pusher مفعلًا في الإعدادات > المتفرقات > Pusher.
الاستجابة
true إذا كان مفعلًا، false خلاف ذلك.
sb_pusher_init()
تهيئة SDK PHP لـ Pusher.
وظائف إضافية
وظائف متنوعة تؤدي مهام مختلفة.
sb_email()
إرسال بريد إلكتروني إلى مستخدم موجود باستخدام القوالب والإعدادات الخاصة بـ الإعدادات > الإشعارات. يتم ترجمة البريد الإلكتروني تلقائيًا.
المعلمات
recipient_id |
معرّف المستخدم الذي سيتم إرسال البريد الإلكتروني إليه. |
message |
رسالة البريد الإلكتروني. |
attachments |
مجموعة من المرفقات بصيغة JSON. صيغة المصفوفة: [["name", "link"], ["name", "link"], ...]. استبدل name باسم المرفق و link بعنوان URL الكامل للمرفق. من مسؤوليتك رفع المرفقات إلى خادم بعيد، هذه المعلمة تقبل فقط عنوان URL للملفات التي تم رفعها بالفعل. الافتراضي: []. |
sender_id |
معرّف المستخدم المرسل. الافتراضي: معرّف المستخدم النشط. |
الاستجابة
true
sb_email_send()
إرسال بريد إلكتروني عام إلى عنوان بريد إلكتروني. عنوان البريد الإلكتروني واسم المرسل هما الذين تم تعيينهما في الإعدادات > الإشعارات > إعدادات البريد الإلكتروني.
المعلمات
to |
عنوان البريد الإلكتروني. |
subject |
موضوع البريد الإلكتروني. |
message |
رسالة البريد الإلكتروني. |
sender_suffix |
إلحاق النص المقدم باسم المرسل. الافتراضي: فارغ. |
الاستجابة
true
sb_email_piping()
تشغيل مزامنة أنابيب البريد الإلكتروني مع Alfchatbot وتحويل الرسائل الإلكترونية إلى رسائل دردشة.
المعلمات
force |
تعيينه إلى true لتنفيذ المزامنة، بشكل افتراضي يتم تنفيذ المزامنة مرة واحدة كحد أقصى في الدقيقة. الافتراضي: false. |
الاستجابة
true
sb_send_sms()
إرسال رسالة نصية إلى مستخدم أو عميل. إذا كانت معلمة القالب صحيحة، يتم ترجمة الرسالة تلقائيًا.
المعلمات
message |
الرسالة النصية. |
to |
رقم الهاتف. |
template |
تعيينه إلى false لإرسال الرسالة فقط بدون محتوى القالب. الافتراضي: يتم إرسال الرسالة ضمن قالب الإعدادات > إشعارات SMS. |
conversation_id |
تعيينه إذا كانت الرسالة تحتوي على معلمة URL {conversation_url_parameter}. |
attachments |
مجموعة من المرفقات. صيغة المصفوفة: [["name", "link"], ["name", "link"], ...] أو ["link", "link", ...]. استبدل name باسم المرفق و link بعنوان URL الكامل للمرفق. من مسؤوليتك رفع المرفقات إلى خادم بعيد، هذه المعلمة تقبل فقط عنوان URL للملفات التي تم رفعها بالفعل. الافتراضي: false. |
الاستجابة
{
"sid": "SM1f0e8ae6ade43cb3c0ce4525424e404f",
"date_created": "الجمعة، 13 أغسطس 2010 01:16:24 +0000",
"date_updated": "الجمعة، 13 أغسطس 2010 01:16:24 +0000",
"date_sent": null,
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"to": "+15305431221",
"from": "+15104564545",
"body": "رسالة اختبار",
"status": "قيد الانتظار",
"flags":["صادرة"],
"api_version": "2010-04-01",
"price": null,
"uri": "\/2010-04-01\/Accounts\/ACXXXX\/Messages\/SM1f004f.json"
}
sb_send_agents_notifications()
إرسال جميع إشعارات الوكلاء: إشعار عبر البريد الإلكتروني، إشعار عبر الدفع، وإشعار عبر الرسائل القصيرة.
الوسائط
message |
نص الرسالة. |
bottom_message |
رسالة إضافية لإضافتها في نهاية إشعار البريد الإلكتروني. |
conversation_id |
معرف المحادثة المرتبط بالرسالة. إذا لم يتم تعيين هذه القيمة، يتم إرسال الإشعارات لجميع الوكلاء. |
attachments |
مصفوفة من المرفقات. تنسيق المصفوفة: [["name", "link"], ["name", "link"], ...]. استبدل name باسم المرفق و link بالرابط الكامل للمرفق. من مسؤوليتك رفع المرفقات إلى خادم بعيد، هذه الوسيطة تقبل فقط عنوان URL للملفات التي تم تحميلها بالفعل. الافتراضي: خطأ. |
user |
مستخدم المحادثة كمصفوفة من تفاصيل المستخدم. |
extra |
مصفوفة من القيم. أدخل القيمة force: true لفرض الإشعارات حتى إذا كان الوكيل متصلاً بالإنترنت. أدخل القيمة email: [email_content] لإرسال رسالة مختلفة فقط لإشعار البريد الإلكتروني. |
الاستجابة
true
sb_get_setting()
إرجاع إعداد من منطقة الإعدادات.
الوسائط
setting |
معرف الإعداد. يمكنك الحصول على معرفات جميع الإعدادات من الملف resources\json\settings.json. |
الاستجابة
إرجاع القيمة للإعداد.
sb_get_settings()
إرجاع مصفوفة تحتوي على جميع الإعدادات.
الاستجابة
{
"chat-manual-init": [
false,
"checkbox"
],
"chat-login-init": [
false,
"checkbox"
],
"init-dashboard": [
true,
"checkbox"
],
"chat-timetable-disable": [
false,
"checkbox"
],
"rtl": [
false,
"checkbox"
],
"front-auto-translations": [
true,
"checkbox"
],
...
}
sb_save_settings()
حفظ إعدادات الدردشة. تقوم هذه الدالة بكتابة جميع الإعدادات بالقيِّم المقدمة.
الوسائط
settings |
مصفوفة من الإعدادات. يمكنك الحصول على مصفوفة الإعدادات الحالية باستخدام الدالة sb_get_settings(). |
external_settings |
مصفوفة من الإعدادات الإضافية. يتم حفظ كل قيمة من المصفوفة في صف جديد من جدول sb_settings في قاعدة البيانات. الافتراضي []. |
external_settings_translations |
مصفوفة من ترجمات الإعدادات الإضافية. يتم حفظ كل لغة من المصفوفة في صف جديد من جدول sb_settings في قاعدة البيانات. تنسيق المصفوفة: [ "es" => [], "it" => [], ...] الافتراضي []. |
الاستجابة
true
sb_get_multilingual_setting()
إرجاع القيمة المترجمة لإعداد متعدد اللغات والقيم من منطقة الإعدادات.
الوسائط
name |
معرف الإعداد. قم بتعيينه إلى emails للحصول على إعدادات البريد الإلكتروني. |
sub_name |
معرف الإعداد الفرعي. مثال: email-agent. احصل على قائمة بجميع المعرفات من الملف resources/json/settings.json. |
language |
رمز اللغة. إذا لم تكن هناك ترجمات لرمز اللغة المحدد، أو إذا كان مضبوطًا على false أو en، يتم إرجاع اللغة الافتراضية بدلاً من ذلك. الافتراضي: false. |
الاستجابة
true
sb_is_error()
تحقق مما إذا كانت المتغيرات من نوع SBError. استخدم الطريقة $error->code() للحصول على رمز الخطأ، والطريقة $result->function_name() للحصول على اسم الدالة التي أنشأت الخطأ، والطريقة $result->message() للحصول على رسالة الخطأ.
الوسائط
object |
الكائن الذي تريد التحقق منه. |
الاستجابة
false
الاستجابة
[
{
"id": "6P2Oq",
"title": "ما الجديد في واجهة برمجة التطبيقات V2؟",
"content": "واجهة برمجة التطبيقات V2 هي الإصدار الجديد من واجهة برمجة التطبيقات للمطورين...",
"link": "https://alfchatbot.com",
"categories": ["ols85"]
},
{
"id": "qf7kD",
"title": "هل يجب أن أنتقل إلى واجهة البرمجة الجديدة؟",
"content": "نعم. الإصدار الأحدث (V2) من الإعدادات...",
"link": "https://alfchatbot.com",
"categories": []
},
...
]
استجابة مقال واحد
{
"id": "6P2Oq",
"title": "ما الجديد في واجهة برمجة التطبيقات V2؟",
"content": "واجهة برمجة التطبيقات V2 هي الإصدار الجديد من واجهة برمجة التطبيقات للمطورين. الواجهة الجديدة تتكامل...",
"link": "https://alfchatbot.com",
"categories": ["ols85"]
}
sb_save_articles()
احفظ جميع المقالات. تقوم هذه الوظيفة باستبدال جميع المقالات الحالية بمقالات المصفوفة المعطاة.
الوسائط
articles |
المصفوفة التي تحتوي على المقالات. استخدم الوظيفة
sb_get_articles() للحصول على مصفوفة المقالات.
صيغة المصفوفة:
[["id" => "", "title" => "", "content" => "", "link" => ""], ["title" => "", "content" => "", "link" => "", "id" => ""], ...] |
categories |
مصفوفة من معرّفات الفئات. قم بتعيينها إلى delete_all لحذف جميع الفئات. |
translations |
المصفوفة التي تحتوي على ترجمات المقالات. استخدم الوظيفة
sb_get_articles() للحصول على مصفوفة المقالات.
صيغة المصفوفة:
[ "es" => [["id" => "", "title" => "", "content" => "", "link" => ""], ...], "it" => [...], ...] |
الاستجابة
true
sb_search_articles()
يُعيد المقالات المطابقة للبحث.
الوسائط
search |
سلسلة تحتوي على مصطلحات البحث. تدعم وظيفة البحث العنوان والمحتوى. |
articles_language |
ابحث فقط في المقالات باللغة التي تحمل رمز اللغة المعطى. إذا لم تكن هناك مقالات بالرمز اللغوي المعطى، فإن البحث يُعيد المقالات باللغة الافتراضية. قم بتعيينه إلى all للحصول على جميع الترجمات. الافتراضي: false. |
الاستجابة
[
{
"id": "6P2Oq",
"title": "ما الجديد في واجهة برمجة التطبيقات V2؟",
"content": "واجهة برمجة التطبيقات V2 هي الإصدار الجديد من واجهة برمجة التطبيقات للمطورين...",
"link": "https://alfchatbot.com",
"categories": ["ols85"]
},
{
"id": "qf7kD",
"title": "هل يجب أن أنتقل إلى واجهة البرمجة الجديدة؟",
"content": "نعم. الإصدار الأحدث (V2) من الإعدادات...",
"link": "https://alfchatbot.com",
"categories": []
},
...
]
sb_get_articles_categories()
يُعيد مصفوفة تحتوي على جميع فئات المقالات.
الاستجابة
[
{
"id": "Nv9PG",
"title": "الأعمال"
},
{
"id": "csPVh",
"title": "السفر والسياحة"
},
{
"id": "pl5S7",
"title": "المالية"
},
...
]
sb_save_articles_categories()
احفظ أو قم بتحديث مصفوفة فئات المقالات.
الوسائط
categories |
مصفوفة من الفئات. صيغة المصفوفة: [ { "id": "123456", "title": "اسم الفئة" }, { "id": "123456", "title": "اسم الفئة" }, ...]. احصل على مصفوفة الفئات الحالية باستخدام الوظيفة get_articles_categories(). |
الاستجابة
true
sb_article_ratings()
احصل على تقييمات مقال أو أضف تقييمًا جديدًا له.
الوسائط
article_id |
معرّف المقال. |
rating |
التقييم الذي ترغب في إضافته. أدخل 1 لتقييم إيجابي أو 0 لتقييم سلبي. إذا تم تعيين هذه الوسيطة، فإن الوظيفة تضيف التقييم، خلاف ذلك، تُعيد التقييمات الحالية. الافتراضي: false. |
الاستجابة
[-1, 1, 1, -1, ...]
تُعيد true إذا تم تعيين الوسيطة rating.
sb_get_versions()
تُعيد إصدار Alfchatbot المثبت والتطبيقات.
الاستجابة
{
"sb": "3.0.4",
"dialogflow": "1.0.2",
"slack": "1.0.3"
}
sb_update()
ابدأ تحديث Alfchatbot وجميع التطبيقات. تقوم هذه الوظيفة بفرض التحديث وتقوم دائمًا بكتابة جميع ملفات الإضافات والتطبيقات.
الاستجابة
success
sb_wp_synch()
ابدأ مزامنة مستخدمي WordPress واستيراد المستخدمين الجدد من WordPress إلى Alfchatbot. تتوفر هذه الوظيفة فقط في إصدار WordPress.
الاستجابة
true
sb_wp_update_option()
احفظ خيارًا في جدول wp_options. هذه الوظيفة تعادل وظيفة WordPress update_option().
الوسائط
name |
اسم الخيار. |
value |
قيمة الخيار. |
الاستجابة
true
sb_app_get_key()
يُعيد مفتاح الترخيص لتطبيق Alfchatbot مثل تطبيق Slack أو تطبيق Dialogflow.
الوسائط
app_name |
أدخل أحد القيم التالية: slack , dialogflow . |
الاستجابة
9300AB16-014ZEE12-91E199EA-997CEX40
sb_app_activation()
قم بتفعيل التطبيق، قم بتحميله، وقم بتثبيته.
الوسائط
app_name |
أدخل أحد القيم التالية: slack , dialogflow . |
key |
مفتاح الترخيص للتطبيق. يمكنك الحصول على المفتاح باستخدام الوظيفة app_get_key. |
الاستجابة
success
sb_csv_users()
قم بتصدير جميع المستخدمين في ملف CSV وأعد الرابط.
الاستجابة
يُعيد الرابط لملف CSV.
sb_transcript()
قم بتصدير محادثة في ملف CSV أو TXT وأعد الرابط.
الوسائط
conversation_id |
معرّف المحادثة التي ترغب في تصديرها. |
type |
قم بتعيينه إلى csv لتصدير المحادثة كملف CSV، قم بتعيينه إلى txt لتصدير المحادثة كملف نصي، قم بتعيينه إلى false لاستخدام النوع المحدد في الإعدادات > المشرف > نوع المحادثة. الافتراضي: false. |
الاستجابة
يعيد رابط ملف CSV.
sb_json_array()
تحويل سلسلة JSON إلى مصفوفة.
الوسائط
json |
سلسلة JSON. |
default |
القيمة التي يتم إرجاعها إذا كانت عملية التحويل غير ناجحة. الافتراضي: []. |
الاستجابة
يعيد مصفوفة PHP إذا كانت عملية التحويل ناجحة، وإلا، فإنه يرجع القيمة الافتراضية.
sb_office_hours()
التحقق مما إذا كان الوقت الحالي ضمن ساعات العمل.
الاستجابة
يعيد true إذا كان الوقت الحالي ضمن ساعات العمل، وإلا، يعيد false.
sb_encryption()
تشفير سلسلة أو فك تشفير سلسلة مشفرة.
الوسائط
string |
السلسلة للتشفير أو فك التشفير. |
encrypt |
قم بتعيينها إلى false لفك التشفير. الافتراضي: true. |
الاستجابة
يعيد السلسلة المشفرة أو السلسلة المفككة.
sb_string_slug()
تحويل سلسلة إلى سلايد أو سلايد إلى سلسلة. عند تحويل سلسلة إلى سلايد، يتم تحويل جميع المسافات إلى - وجميع الأحرف إلى حروف صغيرة. عند تحويل سلايد إلى سلسلة، يتم تحويل جميع حالات الحرف - إلى مسافات ويكون أول حرف حرف كبير.
الوسائط
string |
السلسلة للتحويل. |
action |
أدخل slug لتحويل سلسلة إلى سلايد، أدخل string لتحويل سلايد إلى سلسلة. الافتراضي: "slug". |
الاستجابة
يعيد السلايد أو السلسلة المحولة.
sb_curl()
إرسال البيانات إلى عنوان URL للحصول على استجابة JSON.
الوسائط
url |
عنوان URL الوجهة الذي سيستقبل البيانات. |
post_fields |
مصفوفة تحتوي على السمات. يمكن أن تكون مصفوفة، مثال: ["attribute" => "value", "attribute" => "value", ...]. يمكن أن تكون سلسلة تحتوي على مصفوفة في تنسيق JSON. |
header |
رأس HTTP. عادة ما يكون مصفوفة مثل ["Content-Type: application/json", "Content-Length: 123456"]. |
method |
طريقة HTTP. الافتراضي: POST. |
الاستجابة
يعيد مصفوفة PHP تحتوي على بيانات مصفوفة JSON التي أعادها الخادم.
sb_download()
يعيد بيانات عنوان URL.
الوسائط
<
URL |
عنوان URL الوجهة. |
الاستجابة
الملف أو البيانات التي يعيدها الخادم.
sb_download_file()
تنزيل ملف، حفظه في مجلد التحميلات، وإرجاع عنوان URL.
الوسائط
URL |
عنوان URL الوجهة. |
file_name |
اسم الملف المحفوظ. الافتراضي: اسم الملف الأصلي. |
mime |
قم بتعيينه إلى true لاسترداد امتداد الملف تلقائيًا. قم بتعيينه إلى سلسلة نوع MIME لتعيين امتداد MIME إلى اسم الملف. |
الاستجابة
عنوان URL للملف المحفوظ في مجلد التحميلات.
sb_csv()
إنشاء ملف CSV من مصفوفة.
الوسائط
items |
مصفوفة تحتوي على البيانات التي سيتم حفظها في ملف CSV. يجب أن تكون مصفوفة أساسية، كل عنصر هو صف جديد في ملف CSV. |
header |
مصفوفة تحتوي على عناصر الرأس. مثال: ["ID", "الاسم الأول", "الاسم الأخير", "البريد الإلكتروني"]. |
filename |
اسم ملف CSV. |
الاستجابة
يعيد عنوان URL لملف CSV. يتم حفظ الملف في مجلد التحميلات. بشكل افتراضي، يقع في مجلد alfchatbot أو في مجلد wp-content/uploads إذا كنت تستخدم نسخة WordPress.
sb_file()
إنشاء ملف جديد يحتوي على المحتوى المحدد وحفظه في مسار الوجهة.
الوسائط
path |
مسار نظام الملفات الوجهة، سيتم حفظ الملف هناك. |
content |
محتوى الملف. |
الاستجابة
true
sb_clean_data()
تقوم هذه الوظيفة بما يلي: حذف الزوار الذين مر عليهم أكثر من 24 ساعة، حذف الرسائل في المهملات التي مر عليها أكثر من 30 يومًا، أرشفة المحادثات التي مضى عليها أكثر من 24 ساعة بحالة رمز يساوي 0 أو 1 (في انتظار رد من المستخدم أو بدون أي رد من المستخدم).
الاستجابة
true
sb_cron_jobs()
تشغيل مهام الجدولة (الكرون).
sb_get_shortcode()
تحويل الشيفرة القصيرة إلى مصفوفة تحتوي على اسم الشيفرة القصيرة وإعدادات الشيفرة القصيرة.
الوسائط
shortcode |
سلسلة الشيفرة القصيرة. مثال: [rating title="Rate your conversation" message="Tell us your experience." success="Thank you!"]. |
name |
اسم الشيفرة القصيرة. مثال: inputs. الافتراضي: false. |
type |
قم بتعيينه إلى merge إذا كانت الشيفرة القصيرة هي حقل دمج مثل {}. |
الاستجابة
{
"shortcode": "[rating title=\"Rate your conversation\" message=\"Tell us your experience.\" success=\"Thank you!\"]",
"shortcode_name": "rating",
"title": "Rate your conversation",
"message": "Tell us your experience.",
"success": "Thank you!"
}
sb_cron_jobs()
التحقق من مهام الجدولة (الكرون) وتشغيلها إذا كانت التاريخ والوقت يتطابقان مع وقت المهمة.
sb_css()
إرجاع أو عرض نمط CSS لألوان الدردشة.
الوسائط
color_1 |
اللون الأول بصيغة RGB أو HEX. الافتراضي: اللون الأول المحفوظ في منطقة الإعدادات. |
color_2 |
اللون الثاني بصيغة RGB أو HEX. الافتراضي: اللون الثاني المحفوظ في منطقة الإعدادات. |
color_3 |
اللون الثالث بصيغة RGB أو HEX. الافتراضي: اللون الثالث المحفوظ في منطقة الإعدادات. |
return |
قم بتعيينه إلى true لإرجاع الشيفرة بدلاً من عرضها. الافتراضي: false. |
الاستجابة
رمز CSS
sb_get_notes()
إرجاع الملاحظات الداخلية لمحادثة.
الوسائط
conversation_id |
معرف المحادثة. |
الاستجابة
[
{
"id": 98207,
"user_id": "1538",
"name": "Lorem ipsum dolor sit amet",
"message": "Lorem ipsum dolor sit amet, consectetur elit, sed do eiusmod tempor incididunt."
},
{
"id": 76986,
"user_id": "1596",
"name": "Lorem ipsum dolor",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor."
},
...
]
sb_add_note()
إضافة ملاحظة داخلية جديدة.
الوسائط
conversation_id |
معرف المحادثة الذي سيتم ربط الملاحظة به. |
user_id |
معرف الوكيل أو المسؤول الذي أنشأ الملاحظة. |
name |
اسم الملاحظة. |
message |
رسالة الملاحظة. |
الاستجابة
معرف الملاحظة
sb_delete_note()
حذف ملاحظة داخلية.
الوسائط
conversation_id |
معرف المحادثة المرتبط بالملاحظة. |
note_id |
معرف الملاحظة. |
الاستجابة
true
sb_automations_get()
إرجاع جميع عمليات الأتمتة.
الاستجابة
[
{
"emails": [
{
"id": "0BOaG",
"conditions": [
[
"datetime",
"is-between",
"10/04/2021 - 13/04/2021"
],
[
"include_urls",
"contains",
"https://example.com"
],
...
],
"name": "Excepteur sint",
"message": "Excepteur sint occaecat cupidatat non proident.",
"subject": "Cupidatat non proident"
},
...
],
"sms": [
{
"id": "vo2sY",
"conditions": [
[
"datetime",
"is-exactly",
"13/04/2021"
]
],
"name": "Excepteur sint",
"message": "Excepteur sint occaecat cupidatat non caecat cupidatat non proident"
},
{
"id": "hwkmQ",
"name": "Excepteur sint occaecat cupidatat non proident",
"message": "Excepteur sint occaecat cupidatat non occaecat cupidatat non proident"
},
...
],
"messages": [],
"popups": [
{
"id": "ckN24",
"conditions": [
[
"user_type",
"is-user"
],
[
"languages",
"en"
]
],
"name": "s",
"message": "Excepteur sint occaecat cupidatat non prcaecat cupidatat non proident",
"title": "Excepteur sint occaecat",
"profile_image": "https://example.com/image.jpg"
},
...
],
"design": [
{
"id": "bX1qA",
"conditions": [
[
"user_type",
"is-user"
]
],
"name": "Excepteur sint",
"message": "Excepteur sint occaecat cupidatat caecat cupidatat non proident",
"title": "",
"color_1": "rgb(0, 235, 26)",
"color_2": "rgb(255, 0, 0)",
"color_3": "rgb(255, 0, 0)",
"background": "https://example.com/image.jpg",
"brand": "https://example.com/image.jpg",
"icon": "https://example.com/image.jpg"
},
...
]
},
{
"fr": {
"messages": [
{
"id": "y6hNE",
"name": "XXXX",
"message": "XXXX"
}
]
},
...
}
]
sb_automations_save()
حفظ جميع عمليات الأتمتة.
الوسائط
automations |
مصفوفة الأتمتة. احصل عليها من sb_get_automations(). |
translations |
مصفوفة ترجمات الأتمتة. احصل عليها من sb_get_automations(). |
الاستجابة
true
sb_automations_validate()
التحقق من صحة الأتمتة.
الوسائط
automation |
الأتمتة. |
الاستجابة
{
"conditions": [
[
"user_type",
"is-user"
],
...
],
"repeat_id": ""
}
يعرض فقط الشروط الخاصة بالعميل والشروط غير الصالحة من جانب الخادم التي يمكن التحقق منها لاحقًا. إذا لم يتم إرجاع أي شروط، فإن الأتمتة صالحة ويمكن تنفيذها. يعيد false إذا كانت الأتمتة غير صالحة.
sb_automations_run_all()
التحقق من جميع الأتمتة، تنفيذ الصالحة منها، وإرجاع الأتمتة التي تحتوي على شروط خاصة بالعميل، شروط غير صالحة من جانب الخادم، وأتمتة النوافذ المنبثقة والتصميم.
الاستجابة
[
{
"id": "0BOaG",
"conditions": [
[
"datetime",
"is-between",
"10/04/2021 - 13/04/2021"
],
[
"include_urls",
"contains",
"https://example.com"
],
...
],
"name": "Excepteur sint",
"message": "Excepteur sint occaecat cupidatat non proident.",
"subject": "Cupidatat non proident",
"type": "emails"
},
{
"id": "bX1qA",
"conditions": [
[
"user_type",
"is-user"
]
],
"name": "Excepteur sint",
"message": "Excepteur sint occaecat cupidatat caecat cupidatat non proident",
"title": "",
"color_1": "rgb(0, 235, 26)",
"color_2": "rgb(255, 0, 0)",
"color_3": "rgb(255, 0, 0)",
"background": "https://example.com/image.jpg",
"brand": "https://example.com/image.jpg",
"icon": "https://example.com/image.jpg",
"type": "design"
},
...
]
sb_automations_run()
تنفيذ أتمتة واحدة والتحقق منها اختياريًا قبل تنفيذها.
الوسائط
automation |
الأتمتة. |
validate |
قم بتعيينه إلى true للتحقق من الأتمتة قبل تنفيذها. الافتراضي: false. |
الاستجابة
true