الإعداد والاستخدام

توفر واجهة برمجة التطبيقات JavaScript مجموعة من الدوال والأحداث التي تدعم معظم وظائف Alfchatbot. لبدء استخدام واجهة برمجة التطبيقات JavaScript، اتبع الدليل أدناه.

الاستخدام

تأكد من تحميل الدردشة عن طريق تضمين النص البرمجي التالي في الصفحة التي تريد استخدام واجهات البرمجة فيها. تأكد من أن الروابط صحيحة. إذا كنت تستخدم نسخة WordPress، فهذه الخطوة غير مطلوبة.

                                <script src="alfchatbot/js/min/jquery.min.js"></script>
                                <script id="sbinit" src="alfchatbot/js/main.js"></script>
                            

أدخل مقاطع الشيفرة البرمجية، والدوال، والأساليب من هذه الوثائق في الدالة أدناه.

                                (function ($) {
                                    $(document).on("SBInit", function () {
                                        // أدخل شيفرتك هنا
                                    });
                                }(jQuery));
                            

معلمات الدالة

أدخل معلمات الدالة بنفس ترتيب هذه الوثائق. مثال: SBChat.sendMessage(user_id, message, attachments).

التصحيح

تحقق من وحدة التحكم في المتصفح للأخطاء ومعلومات التصحيح.

الكائنات

الكائنات البرمجية في JavaScript المستخدمة من قبل Alfchatbot مذكورة أدناه. في بعض الحالات، ستحتاج إلى استخدام هذه الكائنات لاستخدام وظيفة معينة.

SBUser

يمثل مستخدمًا.

الاستخدام

new SBUser(settings, extra)

• settings هو مصفوفة تحتوي على تفاصيل المستخدم. مثال: { first_name: "", last_name: "", profile_image: "", email: "", user_type: "" }
• extra هو مصفوفة تحتوي على تفاصيل إضافية للمستخدم. مثال: { phone: "", city: "", language: "", country: "", birthday: "" }

طرق

id

type

name

nameBeautified

image

get(key)

getExtra(key)

set(key, value)

setExtra(key, value)

update(function(){})

getConversations(function(conversations){}, exclude_id)

getConversationsCode(conversations)

getFullConversation(conversation_id, function(conversation){})

getConversationByID(conversation_id, index)

addConversation(conversation)

removeConversation(conversation_id)

getLastConversation()

isConversationsEmpty()

isExtraEmpty()

delete(function(){})

language()

المتغيرات

details

extra

conversations

SBMessage

تمثل رسالة في محادثة.

الاستخدام

new SBMessage(details)

• details هي مصفوفة تحتوي على تفاصيل الرسالة. مثال: { "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

attachments

message

get(key)

set(key, value)

payload(key, value)

getCode(translation)

render(message)

strip(message)

المتغيرات

details

SBConversation

تمثل محادثة.

الاستخدام

new SBConversation(messages, details)

• messages هي مصفوفة من كائنات SBMessage.
• details اختياري وهو مصفوفة تحتوي على تفاصيل المحادثة. مثال: { conversation_status_code: "2", conversation_time: "2020-05-18 11:48:09", department: null, first_name: "Don", last_name: "John", id: "102", profile_image: "https://alfchatbot.com/user.jpg", title: "", user_id: "897", user_type: "lead" }

الطرق

id

get(key)

set(key, value)

getMessage(ID)

getLastMessage()

getLastUserMessage(index, agent)

updateMessage(ID, message)

addMessages(messages)

getCode()

deleteMessage(ID)

searchMessages(search, exact_match)

getUserMessages(user_type)

getAttachments()

getLastConversationID()

updateMessagesStatus(ids)

المتغيرات

details

المتغيرات

المتغيرات في القائمة أدناه متاحة للوصول إليها عبر JavaScript.

SB_ARTICLES_PAGE

SB_LOCAL_SETTINGS

SB_DISABLED

SB_REGISTRATION_REQUIRED

SB_TICKETS

SB_DEFAULT_USER

SB_DEFAULT_DEPARTMENT

SB_DEFAULT_AGENT

SBChat.initialized

SBChat.conversation

SBChat.is_busy

SBChat.chat_open

SBChat.agent_id

SBChat.agent_online

SBChat.user_online

SBChat.timetable

SBChat.dashboard

الدوال

دوال لإدارة الدردشة، المستخدمين، المحادثات، والرسائل.

SBChat.submit()

تشغيل حدث النقر على زر الإرسال في محرر الدردشة، إرسال رسالة بالمحتويات المدخلة من قبل المستخدم (الرسالة و/أو المرفقات)، ومسح المحرر.

SBChat.sendMessage()

إضافة رسالة جديدة إلى المحادثة النشطة.

الوسائط

user_id

message

attachments

onSuccess

payload

conversation_status_code

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.updateMessage()

تغيير نص رسالة موجودة.

الوسائط

message_id

message

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.
• إذا كان المستخدم النشط وكيلًا أو مسؤولًا، يمكن تحديث رسائل أي مستخدم. إذا كان المستخدم النشط مستخدمًا، يمكن فقط تحديث رسائل المستخدم النشط.

SBChat.sendEmail()

إرسال بريد إلكتروني إلى المستخدمين أو الوكلاء الذين يتم إرجاعهم بواسطة getRecipientUserID().

الوسائط

message

attachments

send_to_active_user

SBChat.sendSMS()

إرسال رسالة نصية إلى المستخدمين أو الوكلاء الذين يتم إرجاعهم بواسطة getRecipientUserID().

الوسائط

message

SBChat.desktopNotification()

إرسال إشعار سطح المكتب (إشعار ويب) إلى المستخدم، أو الوكيل المسجل إذا تم إرسال الإشعار من منطقة الإدارة.

الوسائط

title

message

icon

conversation_id

SBChat.getRecipientUserID()

إذا كان المستخدم النشط مستخدمًا، يُرجع معرف الوكيل الأخير الذي أجاب على المحادثة، بخلاف ذلك يُرجع معرف الوكيل المعين للمحادثة، بخلاف ذلك يُرجع معرف القسم المعين للمحادثة، بخلاف ذلك يُرجع agents (بمعنى جميع الوكلاء). إذا كان المستخدم النشط مسؤولًا أو وكيلًا، يُرجع معرف المستخدم النشط.

SBChat.initChat()

تهيئة الدردشة وعرض زر الدردشة.

المعلومات

• استخدم هذه الوظيفة بالاقتران مع الإعداد Manual initialization من منطقة Settings > Chat.
• يجب عدم إدراج هذه الطريقة في الحدث $(document).on("SBInit", function () { ... });. استخدم بدلاً من ذلك $(document).on("SBReady", function () { ... });.

SBChat.open()

فتح أو إغلاق نافذة الدردشة.

الوسائط

open

SBChat.openConversation()

فتح محادثة وعرضها في نافذة الدردشة.

الوسائط

conversation_id

SBChat.update()

تحديث المحادثة النشطة والتحقق مما إذا كانت هناك رسائل جديدة. يتم استدعاء هذه الوظيفة تلقائيًا كل 1000 مللي ثانية.

المعلومات

• المتطلبات. يجب أن تكون المحادثة نشطة.
• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.populateConversations()

تعبئة قائمة محادثات المستخدم في لوحة القيادة بجميع المحادثات الخاصة بالمستخدم.

الوسائط

onSuccess

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.updateConversations()

تحديث قائمة محادثات المستخدم في لوحة القيادة والتحقق مما إذا كانت هناك محادثات جديدة. يتم استدعاء هذه الوظيفة تلقائيًا كل 10000 مللي ثانية.

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.newConversation()

إنشاء محادثة جديدة وإضافة الرسالة الأولى إليها بشكل اختياري.

الوسائط

status_code

user_id

message

attachments

department

agent_id

onSuccess

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.setConversation()

تعيين محادثة موجودة كمحادثة نشطة.

الوسائط

conversation

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.startRealTime()

بدء التحقق من الرسائل الجديدة في الوقت الحقيقي للمحادثة النشطة كل 1000 مللي ثانية.

SBChat.stopRealTime()

إيقاف التحقق من الرسائل الجديدة في الوقت الحقيقي.

SBChat.busy()

عرض أو إخفاء رمز التحميل وتمكين أو تعطيل وضع الانشغال في الدردشة. عندما تكون الدردشة في وضع الانشغال، لا يمكن إرسال الرسائل أو المرفقات.

الوسائط

value

المعلومات

• يظهر رمز التحميل فقط في منطقة المحادثة، وليس في لوحة القيادة أو في لوحات أخرى.
• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.lastAgent()

يُرجع آخر وكيل في المحادثة النشطة.

الوسائط

bot

الاستجابة

    {
        "user_id": "123456",
        "full_name": "Don John",
        "profile_image": "https://alfchatbot.com/agent.svg"
    }

SBChat.scrollBottom()

تمرير الدردشة إلى الأسفل.

الوسائط

top

SBChat.isBottom()

تحقق مما إذا كانت الدردشة في الأسفل.

SBChat.showDashboard()

عرض لوحة القيادة.

SBChat.hideDashboard()

إخفاء لوحة القيادة.

SBChat.showPanel()

عرض المنطقة المحددة داخل أداة الدردشة.

الوسائط

name

SBChat.hidePanel()

إخفاء اللوحة النشطة داخل أداة الدردشة.

SBChat.clear()

مسح منطقة المحادثة في أداة الدردشة وتعطيل المحادثة النشطة.

SBChat.updateNotifications()

تحديث عداد الإشعارات الحمراء لزر الدردشة الذي ينبه المستخدم بالرسائل الجديدة والمحادثات الجديدة.

الوسائط

action

conversation_id

SBChat.setConversationStatus()

تحديث رمز الحالة لمحادثة.

الوسائط

status_code

المعلومات

• المتطلبات. يجب أن يكون المستخدم نشطًا.

SBChat.typing()

إدارة التسمية "جاري الكتابة ..." في رأس الدردشة.

الوسائط

user_id

action

المعلومات

• يظهر ملصق الكتابة فقط عندما تكون المحادثة مفتوحة.

SBChat.showArticles()

عرض منطقة المقالات أو مقال واحد.

الوسائط

id

SBChat.getArticles()

يُرجع قائمة المقالات أو محتوى مقال واحد.

الوسائط

id

onSuccess

category

count

الاستجابة

                                [
                                    {
                                        "id": "6P2Oq",
                                        "title": "What's new with the API V2?p",
                                        "content": "The API V2 is the new iteration of our developer API ...",
                                        "link": "https://alfchatbot.com",
                                        "categories": ["Nv9PG"]
                                    },
                                    {
                                        "title": "Which API version am I currently using?",
                                        "content": "The API version is configured separately for each ...",
                                        "link": "",
                                        "id": "IDkft",
                                        "categories": []
                                    },
                                    ...
                                ]
                            

إذا كان مقالًا واحدًا، تكون القيمة المُرجعة هي المقال:

                                {
                                    "id": "6P2Oq",
                                    "title": "What's new with the API V2?p",
                                    "content": "The API V2 is the new iteration of our developer API. The new API integrates Google Cloud Spe API V2 is the new iteration of our developer API. ",
                                    "link": "https://alfchatbot.com"
                                }
                            

المعلومات

• يحتوي كل مقال في القائمة على مقتطف فقط من المحتوى.

SBChat.searchArticles()

عرض المقالات التي تطابق البحث في صندوق مقالات لوحة القيادة.

الوسائط

search

button

target

المعلومات

• المتطلبات. يجب أن تكون لوحة القيادة نشطة.
• المتطلبات. يجب أن تكون المقالات نشطة.

SBChat.setArticleRating()

تعيين تقييم لمقال.

الوسائط

article_id

rating

onSuccess

SBChat.categoryEmoji()

اختيار فئة من صندوق الرموز التعبيرية.

الوسائط

category

SBChat.searchEmoji()

البحث عن الرموز التعبيرية التي تطابق مصطلحات البحث وعرضها في صندوق الرموز التعبيرية.

الوسائط

search

SBChat.insertText()

إدراج سلسلة في محرر الدردشة.

الوسائط

text

المعلومات

• المتطلبات. يجب أن تكون المحادثة نشطة ومفتوحة.

SBChat.privacy()

عرض رسالة الخصوصية وإجبار المستخدم على قبول الشروط قبل بدء الدردشة.

SBChat.popup()

عرض رسالة منبثقة أو إغلاقها.

الوسائط

close

content

المعلومات

• المتطلبات. يجب إغلاق الدردشة.

SBChat.slackMessage()

إرسال رسالة إلى Slack.

الوسائط

user_id

full_name

profile_image

message

attachments

المعلومات

• المتطلبات. يجب أن تكون المحادثة نشطة.

SBChat.deleteMessage()

حذف رسالة من قاعدة البيانات ومن المحادثة النشطة إذا كانت متاحة.

الوسائط

message_id

المعلومات

• يمكن فقط حذف رسائل محادثات المستخدم النشط.
• المتطلبات. يجب أن تكون المحادثة نشطة.

SBChat.registration()

عرض منطقة التسجيل أو تسجيل الدخول أو التحقق مما إذا كان التسجيل مطلوبًا.

الوسائط

check

type

SBChat.addUserAndLogin()

تسجيل مستخدم جديد كـ زائر وتسجيل الدخول تلقائيًا بعد التسجيل. اختياريًا، تنفيذ وظيفة عند الانتهاء.

الوسائط

onSuccess

الاستجابة

                                [
                                    {
                                        "id": "913",
                                        "profile_image": "https://alfchatbot.com/user.svg",
                                        "first_name": "Don",
                                        "last_name": "John",
                                        "email": "hello@example.com",
                                        "user_type": "user",
                                        "token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
                                    },
                                    "YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
                                ]
                            

القيمة الأخيرة هي بيانات تسجيل الدخول المشفرة جاهزة للتخزين في تخزين الويب لمتصفح المستخدم. استخدم الوظيفة SBF.loginCookie(response[1]); لتخزينها.

المعلومات

• إذا كان المستخدم قد سجل الدخول بالفعل، يلزم إعادة تحميل الصفحة لتفعيل المستخدم الجديد.

SBChat.getDepartmentCode()

يعيد رمز HTML مع تفاصيل القسم المعطى أو جميع الأقسام. تفاصيل القسم: id, color, image, name.

الوسائط

department_id

onSuccess

الاستجابة

                                <div data-color="red"><img src="sales.jpg" /><div>Sales<div></div>
                            

SBChat.offlineMessage()

يتحقق مما إذا كانت الرسالة غير المتصلة يمكن إرسالها ثم يرسلها.

المعلومات

• المتطلبات. يجب أن تكون المحادثة نشطة.

SBChat.isInitDashboard()

يتحقق مما إذا كان يتم عرض لوحة القيادة افتراضيًا عند تهيئة أداة الدردشة.

SBChat.closeChat()

أرشفة محادثة وإخفائها من أداة الدردشة.

الوسائط

update_conversation_status

SBChat.flashNotification()

بدء إشعار الفلاش.

SBChat.playSound()

تشغيل الصوت الذي يُشغل عند تلقي رسالة جديدة.

الوسائط

repeat

SBChat.automations.runAll()

يتحقق من جميع الأتمتة ويشغلها إذا تم التحقق من شروط التفعيل.

التطبيقات

قائمة الوظائف لتطبيقات Alfchatbot.

SBApps.is()

يتحقق مما إذا كان التطبيق متاحًا.

الوسائط

name

SBApps.wordpress.ajax()

إجراء مكالمة AJAX لوردبريس.

الوسائط

action

data

onSuccess

SBApps.dialogflow.message()

إرسال رسالة إلى Dialogflow وإضافة رد Dialogflow إلى المحادثة النشطة كرسالة جديدة.

الوسائط

message

attachments

delay

parameters

المعلومات

• المتطلبات. يتطلب تطبيق Dialogflow ويجب أن يكون Dialogflow نشطًا في منطقة الإعدادات.
• المتطلبات. يجب أن يكون المستخدم نشطًا.
• استخدم SBApps.dialogflow.project_id = AGENT_ID لتغيير وكيل Dialogflow الافتراضي.

SBApps.dialogflow.active()

تحقق مما إذا كان Dialogflow نشطًا أو قم بإيقاف تشغيله.

الوسائط

active

الاستجابة

تعيد true إذا كان بوت Dialogflow نشطًا، خلاف ذلك، تعيد false.

SBApps.dialogflow.welcome()

يشغل Intent الترحيب الخاص بـ Dialogflow ويعرض رسالة الترحيب من Dialogflow.

المعلومات

• المتطلبات. يتطلب تطبيق Dialogflow ويجب أن يكون Dialogflow نشطًا في منطقة الإعدادات.

SBApps.dialogflow.openAI()

يرسل رسالة إلى OpenAI (ChatGPT)، يعيد الرد، ويضيف الرد كرسالة جديدة إذا رغبت.

الوسائط

message

onSuccess

المعلومات

• المتطلبات. يتطلب تطبيق Dialogflow ويجب أن يكون الإعدادات > Dialogflow > OpenAI > نشط نشطًا.
• إذا كانت المحادثة نشطة، يتم تلقائيًا إضافة رد OpenAI كرسالة جديدة.

SBApps.dialogflow.typing()

يبدأ حركة الكتابة في عنصر واجهة الدردشة.

SBApps.dialogflow.humanTakeover()

يبدأ استيلاء الإنسان على Dialogflow من الإعدادات > Dialogflow > استيلاء الإنسان.

SBApps.dialogflow.humanTakeoverActive()

تحقق مما إذا كان استيلاء الإنسان نشطًا للمحادثة النشطة.

SBApps.dialogflow.translate()

ترجمة عدة نصوص عبر Google Translate.

الوسائط

strings

language_code

onSuccess

SBApps.woocommerce.updateCart()

تحديث سلة التسوق للمستخدم النشط.

الوسائط

action

product_id

SBApps.woocommerce.waitingList()

عرض رسالة قائمة الانتظار.

الوسائط

action

product_id

التذاكر

قائمة الدوال لتطبيق التذاكر.

SBTickets.showPanel()

عرض لوحة أو منطقة المحادثة.

الوسائط

name

title

SBTickets.showSidePanels()

عرض أو إخفاء اللوحات الجانبية.

الوسائط

show

SBTickets.setAgent()

الحصول على تفاصيل الوكيل وملء منطقة ملف تعريف الوكيل في اللوحة اليمنى.

الوسائط

agent_id

SBTickets.activateConversation()

تنشيط وعرض محادثة.

الوسائط

conversation

SBTickets.selectConversation()

تعيين نمط محادثة في اللوحة اليسرى كمحادثة نشطة.

الوسائط

conversation_id

SBTickets.getActiveConversation()

يعيد عنصر HTML DOM للمحادثة النشطة.

الوسائط

type

Pusher

قائمة الدوال لـ Pusher. لمزيد من التفاصيل، انظر pusher.com.

SBPusher.init()

تهيئة Pusher وتنفيذ وظيفة اختيارية عند اكتمال التهيئة.

الوسائط

onSuccess

SBPusher.start()

بدء Pusher وإرسال الإشعارات. قم بتشغيل هذه الوظيفة بعد SBPusher.init() وبعد أن يكون المستخدم نشطًا.

SBPusher.subscribe()

الاشتراك في قناة Pusher للمستخدم النشط.

الوسائط

channel_name

onSuccess

المعلومات

• إذا لم يتم تهيئة Pusher، فإن الوظيفة تقوم تلقائيًا بتهيئته.
• يمكنك الوصول إلى القناة من SBPusher.channels['CHANNEL NAME'].

SBPusher.event()

الاشتراك في حدث من قناة Pusher وتنفيذ الوظيفة المعطاة عند تلقي الحدث.

الوسائط

event

callback

channel

المعلومات

• إذا لم يتم تهيئة Pusher، فإن الوظيفة تقوم تلقائيًا بتهيئته.
• إذا لم يكن المستخدم مشتركًا في القناة، فإن الوظيفة تقوم تلقائيًا بالاشتراك.

SBPusher.trigger()

تفعيل حدث على قناة Pusher.

الوسائط

event

data

channel

SBPusher.presence()

الاشتراك في قناة الحضور المستخدمة لحالة الاتصال بالإنترنت للمستخدمين والمديرين.

الوسائط

index

onSuccess

المعلومات

• إذا لم يتم تهيئة Pusher، فإن الوظيفة تقوم تلقائيًا بتهيئته.

SBPusher.presenceUnsubscribe()

إلغاء الاشتراك في قناة الحضور.

SBPusher.pushNotification()

إرسال إشعار دفع إلى آخر وكيل في المحادثة، أو إلى جميع الوكلاء إذا لم يرد أي وكيل بعد.

الوسائط

message

المعلومات

• تعمل هذه الوظيفة فقط إذا كانت إشعارات الدفع مفعلة في منطقة الإعدادات.
• حاليًا، تدعم إشعارات الدفع فقط على أجهزة Mac وWindows وAndroid. لا تدعم أجهزة iPhone وiOS.
• لمزيد من التفاصيل انقر هنا.

وظائف أخرى

قائمة بالوظائف المتنوعة التي تقوم بمهام مختلفة.

SBF.translate()

ترجمة سلسلة إلى لغة المستخدم النشط.

الوسائط

string

المعلومات

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

SBF.activeUser()

يعيد المستخدم النشط ككائن SBUser، ويعيد false إذا لم يتم العثور على المستخدم النشط.

تمثيل JSON للمستخدم النشط

        {
            "details": {
                "id": "914",
                "profile_image": "https://alfchatbot.com/user.svg",
                "first_name": "User",
                "last_name": "#23262",
                "email": null,
                "user_type": "visitor",
                "token": "bc308e274473fb685a729abe8a4bf82d3c49cd2f"
            },
            "extra": {},
            "conversations": []
        }
    

المعلومات

• لطرق المستخدم والمزيد من التفاصيل، راجع وثائق SBUser.

SBF.getActiveUser()

تفعيل المستخدم المسجل وإعادة تفاصيل المستخدم.

الوسائط

db

onSuccess

الاستجابة

    {
        "id": "914",
        "profile_image": "https://alfchatbot.com/user.svg",
        "first_name": "Don",
        "last_name": "John",
        "email": "hello@example.com",
        "user_type": "user",
        "token": "bc308e274473fb685a729abe8a4bf82d3c49cd2f"
    }

المعلومات

• لطرق المستخدم والمزيد من التفاصيل، راجع وثائق SBUser.

SBF.cors()

تنفيذ طلب HTTP POST أو GET إلى عنوان URL وإرجاع الاستجابة.

الوسائط

method

url

onSuccess

SBF.null()

تحقق مما إذا كانت متغير موجودًا أو فارغًا.

الوسائط

variable

المعلومات

• يعيد true إذا كان المتغير سلسلة فارغة، null، 'null'، غير معرف.

SBF.deactivateAll()

إخفاء جميع النوافذ المنبثقة والنوافذ. تُستخدم هذه الوظيفة بشكل أساسي في منطقة الإدارة.

SBF.getURL()

البحث عن معلمة في عنوان URL وإرجاع قيمتها أو إرجاع مصفوفة بجميع المعلمات.

الوسائط

name

url

SBF.restoreJson()

تحويل سلسلة مشفرة بصيغة JSON إلى نص عادي.

الوسائط

value

SBF.stringToSlug()

تحويل سلسلة إلى شريحة (slug) عن طريق إزالة جميع الأحرف الخاصة، واستبدال جميع المسافات بالحرف -، وجعل السلسلة بالحروف الصغيرة.

الوسائط

value

المعلومات

• استخدم الوظيفة slugToString(slug) لتحويل شريحة (slug) إلى سلسلة مرة أخرى.

SBF.settingsStringToArray()

تحويل سلسلة إلى مصفوفة من القيم. صيغة السلسلة: name:value,name:value,....

الوسائط

value

الاستجابة

    {
        "name": "value",
        "name": "value",
        ...
    }

SBF.random()

يعيد سلسلة عشوائية تتكون من أحرف وأرقام.

SBF.isAgent()

تحقق مما إذا كان نوع المستخدم وكيلًا. يعيد true فقط إذا كان نوع المستخدم هو agent، أو admin، أو bot.

الوسائط

user_type

SBF.error()

تفعيل خطأ JavaScript مخصص من Alfchatbot.

الوسائط

message

SBF.errorValidation()

تحقق مما إذا كانت الاستجابة من مكالمة AJAX هي خطأ في التحقق.

الوسائط

response

SBF.login()

تسجيل دخول مستخدم أو وكيل. يمكن إتمام تسجيل الدخول بطريقتين: عبر البريد الإلكتروني وكلمة المرور، أو عبر معرّف المستخدم ورمز التوثيق.

الوسائط

email

password

user_id

token

onSuccess

الاستجابة

                                [
                                    {
                                        "id": "913",
                                        "profile_image": "https://alfchatbot.com/user.svg",
                                        "first_name": "Don",
                                        "last_name": "John",
                                        "email": "support@alfchatbot.com",
                                        "user_type": "user",
                                        "token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
                                    },
                                    "YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
                                ]
                            

يعيد false إذا كان تسجيل الدخول غير ناجح.

SBF.logout()

تسجيل خروج المستخدم المسجل حاليًا وإعادة تحميل الصفحة.

SBF.loginCookie()

إنشاء أو تحديث ملف تعريف الارتباط لتسجيل الدخول.

الوسائط

value

SBF.reset()

تسجيل خروج المستخدم المسجل حاليًا، إزالة جميع البيانات المخزنة في Alfchatbot، وإعادة تحميل الصفحة.

SBF.lightbox()

عرض المحتوى المقدم في نافذة منبثقة (lightbox).

الوسائط

content

SBF.storage()

إدارة التخزين المحلي لـ Alfchatbot. التخزين المحلي هو تقنية تحفظ أي بيانات في المتصفح، بشكل دائم.

الوسائط

key

value

SBF.storageTime()

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

الوسائط

key

hours

الاستجابة

إذا كانت خاصية hours محددة، تعيد true إذا كان مجموع التاريخ والوقت المحفوظين والساعات المعطاة أقل من التاريخ والوقت الحالي، خلاف ذلك، تعيد false. مثال: إذا كان الوقت المحفوظ هو 5:00 مساءً، وأدخلت 3، ستعيد الوظيفة true فقط إذا كان الوقت الحالي هو 8:01 مساءً أو أكثر.

SBF.setting()

يعيد قيمة إعداد.

الوسائط

value

الإعدادات المتاحة

بعض من الإعدادات المتاحة والقيم في القائمة أدناه.

                                {
                                    "registration-required": "",
                                    "registration-timetable": false,
                                    "registration-offline": false,
                                    "registration-link": "",
                                    "visitors-registration": false,
                                    "privacy": false,
                                    "popup": true,
                                    "popup-mobile-hidden": true,
                                    "welcome": false,
                                    "welcome-trigger": "open",
                                    "welcome-delay": 0,
                                    "follow": false,
                                    "follow-delay": "1000",
                                    "chat-manual-init": false,
                                    "chat-login-init": false,
                                    "sound": ["code": "n", "volume": 0.5, "repeat": 5],
                                    "header-name": true,
                                    "desktop-notifications": "all",
                                    "flash-notifications": "all",
                                    "push-notifications": true,
                                    "notifications-icon": "",
                                    "bot-id": "377",
                                    "bot-name": "Bruce Peterson",
                                    "bot-image": "",
                                    "bot-delay": 0,
                                    "bot-office-hours": false,
                                    "dialogflow-active": true,
                                    "dialogflow-human-takeover": false,
                                    "slack-active": false,
                                    "rich-messages": [
                                        "email",
                                        "registration",
                                        "login",
                                        "timetable",
                                        "articles",
                                        "immagine",
                                        "video"
                                    ],
                                    "display-users-thumb": true,
                                    "hide-agents-thumb": true,
                                    "notify-user-email": true,
                                    "notify-agent-email": false,
                                    "translations": false,
                                    "auto-open": false,
                                    "office-hours": true,
                                    "disable-office-hours": false,
                                    "disable-offline": false,
                                    "timetable": false,
                                    "timetable-hide": [
                                        false,
                                        "checkbox"
                                    ],
                                    "articles": true,
                                    "articles-title": "",
                                    "init-dashboard": false,
                                    "wp": false,
                                    "wp-users-system": "sb",
                                    "queue": false,
                                    "queue-message": "",
                                    "queue-message-success": "",
                                    "queue-response-time": "",
                                    "routing": false,
                                    "webhooks": true,
                                    "agents-online": false,
                                    "timetable-message": "",
                                    "tickets-registration-required": true,
                                    "tickets-registration-redirect": "",
                                    "tickets-default-form": "login",
                                    ...
                                }
                            

SBF.shortcode()

تحويل الرمز القصير إلى مصفوفة تحتوي على اسم الرمز القصير وإعدادات الرمز القصير.

الوسائط

SBF.shortcode()

تحويل الرمز القصير إلى مصفوفة تحتوي على اسم الرمز القصير وإعدادات الرمز القصير.

الوسائط

shortcode

الاستجابة

                                [
                                    "rating",
                                    {
                                        "title": "Rate your conversation",
                                        "message": "Tell us your experience.",
                                        "success": "Thank you!"
                                    }
                                ]
                            

SBF.openWindow()

فتح صفحة ويب في نافذة جديدة.

الوسائط

link

width

height

SBF.loadResource()

تضمين ملف .js أو .css في منطقة <head< من الصفحة.

الوسائط

url

script

SBF.debounce()

تنفيذ الوظيفة المعطاة مرة واحدة فقط في فترة معينة، تأخير بالميلي ثانية بعد آخر استدعاء لها، ويُعاد تعيين المؤقت في كل مرة يُستدعى فيها.

الوسائط

bounceFunction

id

interval

SBF.translate()

ترجمة سلسلة باستخدام ترجمات Alfchatbot.

الوسائط

string

SBF.escape()

تهريب سلسلة.

الوسائط

string

SBF.convertUTCDateToLocalDate()

تحويل التاريخ إلى الوقت المحلي.

الوسائط

datetime

UTCoffset

الاستجابة

Mon Jan 30 2023 10:45:00 GMT+0000 (Greenwich Mean Time)

SBF.getLocationTimeString()

يعيد سلسلة تحتوي على الموقع والوقت المحلي الحالي للمنطقة الزمنية المعطاة.

الوسائط

details

onSuccess

الاستجابة

05:15 AM in London, United Kingdom

SBF.beautifyTime()

تحويل التاريخ إلى التنسيق المحلي وإجراء تحسينات أخرى لجعل التاريخ أكثر ودية.

الوسائط

date

extended

future

الاستجابة

<span>30/01/2023</span>

SBF.dateDB()

تحويل تنسيق التاريخ إلى تنسيق التاريخ الخاص بقاعدة البيانات وضبط UTC على +0.

الوسائط

date

SBF.UTC()

يعيد التاريخ والوقت المحددين بتنسيق unix باستخدام تعويض UTC المحدد في الإعدادات > متفرقات > تعويض UTC.

الوسائط

datetime

الاستجابة

1675075500000

SBF.unix()

الحصول على قيمة الطابع الزمني unix لسلسلة التاريخ والوقت بتنسيق yyyy-mm-dd hh:mm:ss.

الوسائط

datetime

الاستجابة

1675075500000

الأحداث

تتيح لك الأحداث اعتراض إجراءات Alfchatbot في الوقت الفعلي وتنفيذ رمز JavaScript مخصص عندما يتم تشغيل إجراء.

الاستخدام

استخدم الكود أدناه واستبدل EVENT-NAME باسم الحدث. يمثل response القيمة المرتجعة إذا كان هناك سمة واحدة فقط، وإلا فهو مصفوفة من القيم. JQuery مطلوب.

        $(document).on("EVENT-NAME", function (e, response) {
            // أدخل كودك هنا
        });
    

مثال:

        $(document).on("SBMessageSent", function (e, response) {
            console.log(response["user_id"]);
            console.log(response["conversation_id"]);
            console.log(response["message"]);
        });
    

SBReady

الحدث الذي يتم إطلاقه عند تحميل الصفحة بعد تحميل نص الشات main.js. يتم إطلاق هذا الحدث أيضًا في منطقة الإدارة.

SBInit

الحدث الذي يتم إطلاقه عند تحميل الصفحة عندما يكتمل الشات التهيئة.

SBTicketsInit

الحدث الذي يتم إطلاقه عند تحميل الصفحة عندما تكتمل تهيئة منطقة التذاكر. هذا الحدث متاح فقط عندما تكون تطبيقات التذاكر نشطة.

SBLogout

الحدث الذي يتم إطلاقه عندما يقوم المستخدم النشط بتسجيل الخروج.

SBError

الحدث الذي يتم إطلاقه عندما يحدث خطأ في Alfchatbot.

الاستجابة

message

function_name

SBDoubleLoginError

الحدث الذي يتم إطلاقه عند تهيئة الشات إذا كان وكيل أو مسؤول قد سجل الدخول بالفعل.

SBUserDeleted

الحدث الذي يتم إطلاقه عندما يتم حذف مستخدم.

الاستجابة

معرف المستخدم الذي تم حذفه.

SBMessageSent

الحدث الذي يتم إطلاقه عندما يتم إرسال رسالة جديدة.

الاستجابة

user_id

user

conversation_id

conversation_status

message_id

message

attachments

SBBotMessage

الحدث الذي يتم إطلاقه عندما يرد بوت Dialogflow على رسالة.

الاستجابة

response

message

SBSlackMessageSent

الحدث الذي يتم إطلاقه عندما يتم إرسال رسالة إلى Slack.

الاستجابة

message

conversation_id

SBEmailSent

الحدث الذي يتم إطلاقه عندما يتم إرسال بريد إلكتروني إشعاري إلى مستخدم أو وكيل.

الاستجابة

recipent_id

message

attachments

SBNotificationsUpdate

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

الاستجابة

action

conversation_id

SBConversationOpen

الحدث الذي يتم إطلاقه عندما يتم تحميل المحادثة بالكامل وفتحها في الدردشة.

الاستجابة

response

SBNewMessagesReceived

الحدث الذي يتم إطلاقه عندما تكون هناك رسائل جديدة في المحادثة النشطة.

الاستجابة

قائمة الرسائل الجديدة. كل رسالة هي كائن SBMessage.

response

SBMessageDeleted

الحدث الذي يتم إطلاقه عندما يتم حذف رسالة.

الاستجابة

معرف الرسالة التي تم حذفها.

SBNewConversationReceived

الحدث الذي يتم إطلاقه عندما يتم تلقي محادثة جديدة.

الاستجابة

المحادثة الجديدة ككائن SBConversation.

SBNewConversationCreated

الحدث الذي يتم إطلاقه عندما يتم إنشاء محادثة جديدة.

الاستجابة

المحادثة الجديدة ككائن SBConversation.

SBActiveConversationChanged

الحدث الذي يتم إطلاقه عندما يتم تغيير المحادثة النشطة.

الاستجابة

المحادثة النشطة الجديدة ككائن SBConversation.

SBActiveConversationStatusUpdated

الحدث الذي يتم إطلاقه عندما يتم تحديث رمز حالة المحادثة النشطة.

الاستجابة

conversation_id

status_code

SBChatOpen

الحدث الذي يتم إطلاقه عندما يتم فتح الدردشة.

SBChatClose

الحدث الذي يتم إطلاقه عندما يتم إغلاق الدردشة.

SBQueueUpdate

الحدث الذي يتم إطلاقه عندما تبدأ الطابور وفي كل مرة يتم فيها تحديث الطابور.

الاستجابة

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

SBBusy

الحدث الذي يتم إطلاقه عندما يتغير حالة انشغال الدردشة. تكون الدردشة مشغولة إذا كانت تعمل، مثل إرسال رسالة. عندما تكون الدردشة مشغولة لا يمكن تنفيذ بعض الوظائف، مثل إرسال رسالة جديدة.

الاستجابة

true إذا كانت الدردشة مشغولة، خلاف ذلك false.

SBDashboard

الحدث الذي يتم إطلاقه عندما يتم عرض لوحة القيادة.

SBDashboardClosed

الحدث الذي يتم إطلاقه عندما يتم إغلاق لوحة القيادة وعرض محادثة بدلاً منها.

SBTyping

الحدث الذي يتم إطلاقه عندما يكون المستخدم أو الوكيل يكتب في المحرر.

الاستجابة

true إذا كان المستخدم أو الوكيل يكتب، خلاف ذلك false.

SBArticles

الحدث الذي يتم إطلاقه عندما يتم عرض لوحة المقالات أو عندما يتم فتح مقال واحد.

الاستجابة

id

articles

SBPrivacy

الحدث الذي يتم إطلاقه عند تهيئة الدردشة إذا تم عرض نموذج الخصوصية.

SBPopup

الحدث الذي يتم إطلاقه عندما يتم عرض رسالة منبثقة.

الاستجابة

المصفوفة التي تحتوي على محتويات الرسالة المنبثقة: { image: "", title: "", message: "" }.

SBFollowUp

الحدث الذي يتم إطلاقه عندما يتم إرسال رسالة متابعة.

SBWelcomeMessage

الحدث الذي يتم إطلاقه عندما يتم إرسال رسالة الترحيب.

SBLoginForm

الحدث الذي يتم إطلاقه عندما يقوم المستخدم بتسجيل الدخول بنجاح من نموذج تسجيل الدخول في الدردشة. يتم إطلاق هذا الحدث فقط إذا كان تسجيل الدخول ناجحًا.

الاستجابة

المستخدم ككائن SBUser.

SBRegistrationForm

الحدث الذي يتم إطلاقه عندما يقوم المستخدم بالتسجيل بنجاح من نموذج التسجيل في الدردشة. يتم إطلاق هذا الحدث فقط إذا كان التسجيل ناجحًا. يتم إطلاق هذا الحدث أيضًا إذا تم تحديث التسجيل عبر نموذج الرسائل الغنية.

الاستجابة

user

extra

SBRichMessageSubmit

الحدث الذي يتم إطلاقه عندما يتم تلقي استجابة من رسالة غنية.

الاستجابة

result

data

id

SBAttachments

الحدث الذي يتم إطلاقه عندما يقوم المستخدم بإرفاق ملف.

SBNewEmailAddress

الحدث الذي يتم إطلاقه عندما يسجل المستخدم بريده الإلكتروني عبر رسالة متابعة أو نموذج التسجيل.

الاستجابة

name

email

ID

SBPanelActive

الحدث الذي يتم إطلاقه عندما يتم فتح لوحة من منطقة التذاكر. يتوفر هذا الحدث فقط عندما يكون تطبيق التذاكر نشطًا.

الاستجابة

name

email

SBWoocommerceCartUpdated

الحدث الذي يتم إطلاقه عندما تضيف الدردشة منتجًا إلى عربة تسوق WooCommerce في WordPress. في معظم الحالات، يتم إطلاق هذا الحدث بواسطة روبوت الدردشة Dialogflow.

الاستجابة

action

product

SBBotPayload

الحدث الذي يتم إطلاقه عندما تحتوي رسالة Dialogflow على حمولة Alfchatbot. أمثلة الحمولة: human-takeover, redirect, woocommerce-update-cart, woocommerce-checkout.

الاستجابة

اسم الحمولة.

SBBotAction

الحدث الذي يتم إطلاقه عندما تحتوي رسالة Dialogflow على إجراء Dialogflow. حاليًا، يتوفر فقط الإجراء end (إنهاء المحادثة).

الاستجابة

اسم الإجراء.

SBSMSSent

الحدث الذي يتم إطلاقه عندما يتم إرسال إشعار رسالة نصية إلى مستخدم أو وكيل.

الاستجابة

recipent_id

message

response

SBActiveUserLoaded

الحدث الذي يتم إطلاقه عندما يتم تحميل المستخدم النشط.

الاستجابة

recipent_id

message

response

وظائف AJAX

قائمة وظائف AJAX. وظائف AJAX مشابهة لـ WEB API، حيث تستخدم نفس اسم الدالة، ونفس المعلمات، وتعيد نفس الاستجابات. استخدم الدالة أدناه لبدء مكالمة AJAX:

    SBF.ajax({
        function: 'FUNCTION-NAME',
        parameter: value,
        parameter: value,
        ...
    }, (response) => {

       // أضف الشيفرة الخاصة بك هنا

    });

استبدل FUNCTION-NAME باسم إحدى الدوال أدناه. استبدل قائمة parameter: value بمعلمات الدالة.

المعلمات والاستجابات هي نفسها كما في WEB API. الاستجابة بصيغة JSON.

الدوال

saved-replies

get-settings

save-settings

is-online

add-user

add-user-and-login

get-user

get-users

get-new-users

get-user-extra

get-user-language

get-online-users

get-user-from-conversation

agents-online

search-users

search-users

delete-user

delete-users

update-user

update-user-to-lead

count-users

get-conversations

get-new-conversations

get-conversation

get-user-conversations

get-new-user-conversations

search-conversations

search-user-conversations

new-conversation

update-conversation-status

update-conversation-department

update-conversation-agent

get-new-messages

send-message

send-email

send-slack-message

update-message

update-messages-status

delete-message

slack-users

archive-slack-channels

slack-channels

current-url

set-rating

get-rating

get-articles

save-articles

search-articles

get-articles-categories

save-articles-categories

article-ratings

get-versions

update

app-get-key

app-activation

csv-users

transcript

is-agent-typing

dialogflow-message

dialogflow-get-intents

dialogflow-create-intent

dialogflow-update-intent

dialogflow-entity

dialogflow-get-entity

dialogflow-get-token

dialogflow-get-agent

dialogflow-set-active-context

dialogflow-curl

dialogflow-human-takeover

dialogflow-smart-reply

cron-jobs

woocommerce-get-customer

woocommerce-get-user-orders

woocommerce-get-order

woocommerce-get-product

woocommerce-get-products

woocommerce-search-products

woocommerce-get-taxonomies

woocommerce-get-attributes

woocommerce-get-product-id-by-name

woocommerce-get-product-images

woocommerce-get-product-taxonomies

woocommerce-get-attribute-by-term

woocommerce-get-attribute-by-name

woocommerce-is-in-stock

woocommerce-coupon

woocommerce-coupon-check

woocommerce-coupon-delete-expired

woocommerce-get-url

woocommerce-get-session

woocommerce-get-session-key

woocommerce-payment-methods

woocommerce-shipping-locations

chat-css

get-avatar

get-agents-ids

get-users-with-details

send-custom-email

send-sms

email-piping

get-notes

add-note

delete-note

automations-get

automations-save

automations-validate

automations-run-all

automations-run

get-agents-in-conversation

get-departments

login

logout

update-login

is-typing

set-typing

clean-data

get-translation

get-translations

save-translations

delete-leads

reports

reports-update

direct-message

count-conversations

updates-available

google-translate

google-language-detection-update-user

export-settings

import-settings

check-conversations-assignment

وظائف AJAX الإضافية

الوظائف التالية متاحة فقط عبر AJAX.

إغلاق الرسالة

إرسال رسالة إغلاق إلى محادثة. يمكنك تعيين رسالة الإغلاق في الإعدادات > الدردشة.

المتطلبات

• هذه وظيفة إدارية وتعمل فقط إذا كان المستخدم النشط هو وكيل.

المعلمات

function

bot_id

conversation_id

الاستجابة

                                {
                                    "success": true,
                                    "response": {
                                        "status": "success",
                                        "message-id": 123456,
                                        "queue": false
                                    }
                                }
                            

تحديث المستخدم والرسالة

تحديث تفاصيل المستخدم ومحتوى الرسالة.

المتطلبات

• إذا كان المستخدم النشط هو مستخدم، يمكن تحديث المستخدم النشط فقط والرسائل المرتبطة بمحادثات المستخدم فقط. إذا كان المستخدم النشط هو وكيل أو مسؤول، تعمل الوظيفة لأي مستخدم وأي رسالة.

المعلمات

function

user_id

settings

settings_extra

{ "ID": ["value", "Name"], "ID": ["value", "Name"], ...}

message_id

message

payload

الاستجابة

true

الحصول على تفاصيل الوكيل

يعيد تفاصيل الوكيل أو المسؤول أو البوت.

المعلمات

agent_id

الاستجابة

                                {
                                    "id": "2",
                                    "first_name": "Don",
                                    "last_name": "John",
                                    "department": null,
                                    "flag": "gb.png",
                                    "country_code": "GB",
                                    "details": [
                                        {
                                            "slug": "city",
                                            "name": "المدينة",
                                            "value": "London"
                                        },
                                        {
                                            "slug": "country",
                                            "name": "البلد",
                                            "value": "United Kingdom"
                                        },
                                        {
                                            "slug": "sport",
                                            "name": "البريد الإلكتروني",
                                            "value": "email@example.com"
                                        },
                                        {
                                            "slug": "timezone",
                                            "name": "المنطقة الزمنية",
                                            "value": "Europe/London"
                                        }
                                        ...
                                    ]
                                }
                            

البيانات التلقائية للمستخدم

استرجاع التفاصيل التالية عن المستخدم النشط وتحديث تفاصيل المستخدم: IP، المدينة، الموقع، البلد، المنطقة الزمنية، العملة، المتصفح، لغة المتصفح، نظام التشغيل.

المعلمات

user_id

الاستجابة

                                true