ابدء

قم بالتسجيل/تسجيل الدخول وإنشاء موقع في لوحة التحكم
احصل على مفتاح API وقم بتضمين الكود
Paste into your site's <head> and optionally set visitor id/nickname

1. تضمين البرنامج النصي

Place the following code in your website's <head>, replace with your actual domain and API KEY:

<script>
// اختياري: قم بتعيين معرف الزائر واللقب قبل تحميل البرنامج النصي، لإلغاء البيانات المكررة والعرضwindow.OCS = {
  externalId: 'user_12345', // معرف ثابت لنفس المستخدم  nickname: 'جون دو'        // سيتم عرضه في عنوان النافذة/الواجهة الخلفية};
</script>
<script>(function(){
  var s=document.createElement('script');
  s.src='http://chatgonow.com/api/widget.js?key=YOUR_API_KEY';
  s.async=true;document.head.appendChild(s);
})();</script>

2. الموضوع والأسلوب

يمكنك التخصيص في "مواقعي":

اللون الأساسي، لون النص، ألوان الرأس
متغيرات الموضوع: كلاسيكي / الحد الأدنى / فقاعة
موضع الزر: أسفل اليسار / أسفل اليمين
نص الترحيب

3. تحميل الصور والرسائل النصية

تدعم نافذة الزائر إرسال النصوص والصور (png/jpg/gif). يتم تحميل الصور بشكل آمن إلى النظام الأساسي ويتم عرضها في كل من الواجهة الخلفية وجانب الزائر.

4. الحد من المعدل

يمكنك تعيين الحد الأقصى للرسائل في الدقيقة في "مواقعي" لمنع البريد العشوائي. سيؤدي تجاوز الحد إلى إظهار "الإرسال بشكل متكرر جدًا".

حد معدل Chat API: يشترك الجلب والرد في نفس حد الدقيقة ولكن يتم حسابهما بشكل منفصل.

5. إلغاء تكرار الزائر

يعطي النظام الأولوية لاستخدام window.OCS.externalId لإلغاء البيانات المكررة. إذا لم يتم تعيينه، فإنه يقوم تلقائيًا بإنشاء ocs_external_id وإعادة استخدامه في ملف تعريف الارتباط/LocalStorage المحلي. يتم التعامل مع نفس المعرف الخارجي الموجود ضمن نفس الموقع على أنه نفس الزائر.

6. وحدة تحكم المشغل

بعد تسجيل الدخول، أدخل إلى وحدة التحكم في الدردشة عبر الإنترنت من "مواقعي" لعرض جلسات الزائر في الوقت الفعلي، وإرسال النصوص/الصور، والتحقق من الإشعارات غير المقروءة.

7. افتح واجهة برمجة التطبيقات

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

آخر 50 رسالة (حسب الموقع): GET /api/chat_api.php?action=get_recent_messages&key=CHAT_API_KEY
الرد كوكيل: POST /api/chat_api.php?action=reply_as_agent&key=CHAT_API_KEY
هام: هناك نوعان من مفاتيح API:

مفتاح واجهة برمجة الأداة：تستخدم لتضمين القطعة على مواقع العملاء
مفتاح واجهة برمجة تطبيقات الدردشة：يستخدم لواجهة برمجة التطبيقات المفتوحة (جلب/رد)

وصف حقل API

الحصول على حقول استجابة API للرسائل:

اسم الحقل	يكتب	وصف
`conversation_id`	string	معرف المحادثة للتعرف على جلسة الدردشة
`sender_type`	string	نوع المرسل: زائر أو وكيل
`sender_user_id`	string	معرف المرسل: عشوائي للزوار، مفتاح API للوكلاء
`message_type`	string	نوع الرسالة: نص أو صورة
`content`	string	محتوى الرسالة، فارغ للرسائل المصورة
`image_url`	string\|null	عنوان URL للصورة، للرسائل المصورة فقط
`created_at`	string	وقت إنشاء الرسالة (التنسيق: YYYY-MM-DD HH:MM:SS)

حقول طلب واجهة برمجة تطبيقات رد الوكيل:

اسم الحقل	يكتب	مطلوب	وصف
`conversation_id`	integer	✓	معرف المحادثة
`content`	string	✓*	محتوى الرد (إما هذا أو image_base64)
`image_base64`	string	✓*	صورة مشفرة Base64 (إما هذا أو المحتوى)
`agent_name`	string	-	اسم الوكيل، الافتراضي هو "الوكيل"

* يعني أنه يجب توفير المحتوى أو image_base64

مثال

1. احصل على الرسائل الأخيرة

طلب مثال

curl "http://chatgonow.com/api/chat_api.php?action=get_recent_messages&key=CHAT_API_KEY"

مثال على استجابة النجاح:

بيانات الاستجابة

{
  "success": true,
  "data": [
    {
      "conversation_id": "123",
      "sender_type": "visitor",
      "sender_user_id": "visitor_abc123",
      "message_type": "text",
      "content": "السلام عليكم أود الاستفسار عن أسعار المنتجات",
      "image_url": null,
      "created_at": "2024-01-15 14:30:25"
    },
    {
      "conversation_id": "123",
      "sender_type": "agent",
      "sender_user_id": "chat_xyz789",
      "message_type": "text",
      "content": "Hello! I'm happy to help you. Which product pricing would you like to know about?",
      "image_url": null,
      "created_at": "2024-01-15 14:31:10"
    },
    {
      "conversation_id": "124",
      "sender_type": "visitor",
      "sender_user_id": "visitor_def456",
      "message_type": "image",
      "content": "",
      "image_url": "/uploads/chat_images/visitor_20240115_143200.jpg",
      "created_at": "2024-01-15 14:32:00"
    }
  ]
}

أمثلة على الاستجابة للخطأ:

ردود الأخطاء

// مفتاح واجهة برمجة التطبيقات مفقود{
  "success": false,
  "message": "missing key"
}

// مفتاح واجهة برمجة التطبيقات غير صالح{
  "success": false,
  "message": "invalid key"
}

// طلبات كثيرة جدًا{
  "success": false,
  "message": "too many requests, wait 3s"
}

2. رد الوكيل

طلب مثال

curl -X POST "http://chatgonow.com/api/chat_api.php?action=reply_as_agent&key=CHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"conversation_id":123,"content":"مرحباً، لقد تلقينا رسالتك","agent_name":"العميل وانغ"}'

مثال على استجابة النجاح:

بيانات الاستجابة

{
  "success": true
}

أمثلة على الاستجابة للخطأ:

ردود الأخطاء

// مفتاح واجهة برمجة التطبيقات مفقود{
  "success": false,
  "message": "missing key"
}

// مفتاح واجهة برمجة التطبيقات غير صالح{
  "success": false,
  "message": "invalid key"
}

// لم يتم العثور على المحادثة{
  "success": false,
  "message": "conversation not found"
}

// محتوى فارغ{
  "success": false,
  "message": "empty content"
}