تنزيل node crisp api واجهة برمجة node crisp api

غلاف واجهة برمجة تطبيقات هش

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

حقوق الطبع والنشر 2024 كريسب IM SAS. انظر ترخيص نسخ المعلومات.

الأدوات : مرجع REST API (V1) في المراجعة: 17/10/2024
؟ المشرفون : baptistejamin ، eliottvincent ، valeriansaliou

تثبيت

npm install --save crisp-api

المصادقة

للمصادقة مقابل واجهة برمجة التطبيقات ، الحصول على Keypair المميز الخاص بك عن طريق اتباع دليل مصادقة API REST. ستحصل على رمز Keypair مصنوع من قيمتين.

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

ثم ، أضف معلمات المصادقة إلى مثيل client الخاص بك مباشرة بعد إنشائه:

 var Crisp = require ( "crisp-api" ) ;
var CrispClient = new Crisp ( ) ;

// Authenticate to API with your plugin token (identifier, key)
// eg. CrispClient.authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
CrispClient . authenticateTier ( "plugin" , identifier , key ) ;

// Now, you can use authenticated API sections.

ملخص

يمكنك اتباع دليل REST API QuickStart ، والذي سيحفزك مع API REST في دقائق.

 var Crisp = require ( "crisp-api" ) ;
var CrispClient = new Crisp ( ) ;

CrispClient . authenticateTier ( "plugin" , identifier , key ) ;

CrispClient . website . listConversations ( websiteID , 1 )
  . then ( function ( conversations ) {
    console . log ( "Listed conversations:" , conversations ) ;
  } )
  . catch ( function ( error ) {
    console . error ( "Error listing conversations:" , error ) ;
  } ) ;

أمثلة

إنشاء الروبوت الخاص بك!

 var Crisp = require ( "crisp-api" ) ;
var CrispClient = new Crisp ( ) ;

CrispClient . authenticateTier ( "plugin" , identifier , key ) ;

// Notice: make sure to authenticate before listening for an event
CrispClient . on ( "message:send" , function ( message ) {
  CrispClient . website . sendMessageInConversation (
    message . website_id , message . session_id ,

    {
      type    : "text" ,
      content : "I'm a bot" ,
      from    : "operator" , // or user
      origin  : "chat"
    }
  )
    . then ( function ( message ) {
      console . log ( "Message sent:" , message ) ;
    } )
    . catch ( function ( error ) {
      console . error ( "Error sending message:" , error ) ;
    } ) ;
} )
  . then ( function ( ) {
    console . error ( "Requested to listen to sent messages" ) ;
  } )
  . catch ( function ( error ) {
    console . error ( "Failed listening to sent messages:" , error ) ;
  } ) ;

طرق الموارد

يتم تنفيذ جميع موارد واجهة برمجة التطبيقات الواضحة المتاحة بالكامل. تتم تسمية أسماء الطرق البرمجية باسم اسم التسمية في مرجع REST API .

جميع الطرق التي ستحتاجها على الأرجح عند بناء تكامل واضح مسبوق برمز Star ().

️ لاحظ أنه بناءً على طبقة الرمز المميز للمصادقة ، والتي هي إما user أو plugin ، قد لا يُسمح لك باستخدام جميع الطرق من المكتبة. عندما تكون في شك ، راجع أوصاف طريقة المكتبة أدناه. على الأرجح ، أنت تستخدم رمزًا plugin .

موقع إلكتروني

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

البرنامج المساعد

Connect Connect
اشتراك البرنامج المساعد

وسائط

الرسوم المتحركة الإعلامية

دلو

عنوان URL دلو

أحداث RTM

أحداث الجلسة
أحداث الرسائل
أحداث الناس
أحداث الحملة
أحداث تصفح
استدعاء الأحداث
أحداث عنصر واجهة المستخدم
أحداث الحالة
أحداث الموقع
أحداث دلو
الأحداث الإعلامية
أحداث البريد الإلكتروني
أحداث البرنامج المساعد

موقع إلكتروني

محادثات الموقع

قائمة المحادثات [ user ، plugin ]: مرجع

CrispClient.website.listConversations(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listConversations ( websiteID , pageNumber ) ;

قائمة قطاعات المحادثة المقترحة [ user ، plugin ]: مرجع

CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedConversationSegments ( websiteID , pageNumber ) ;

حذف قطاع المحادثة المقترح [ user ، plugin ]: مرجع

CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var segment = "bug" ;

CrispClient . website . deleteSuggestedConversationSegment ( websiteID , segment ) ;

قائمة مفاتيح بيانات المحادثة المقترحة [ user ، plugin ]: مرجع
- CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedConversationDataKeys ( websiteID , pageNumber ) ;
```

حذف مفتاح بيانات المحادثة المقترح [ user ، plugin ]: مرجع

CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var key = "price" ;

CrispClient . website . deleteSuggestedConversationDataKey ( websiteID , key ) ;

قائمة محادثات البريد العشوائي [ user ]: المرجع

CrispClient.website.listSpamConversations(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSpamConversations ( websiteID , pageNumber ) ;

حل محتوى محادثة البريد العشوائي [ user ]: مرجع

CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10" ;

CrispClient . website . resolveSpamConversationContent ( websiteID , spamID ) ;

إرسال قرار محادثة البريد العشوائي [ user ]: مرجع

CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10" ;

var action = "reject" ;

CrispClient . website . submitSpamConversationDecision ( websiteID , spamID , action ) ;

محادثة الموقع

قم بإنشاء محادثة جديدة [ user ، plugin ]: مرجع
- CrispClient.website.createNewConversation(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . createNewConversation ( websiteID ) ;
```

تحقق مما إذا كانت المحادثة موجودة [ user ، plugin ]: مرجع

CrispClient.website.checkConversationExists(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . checkConversationExists ( websiteID , sessionID ) ;

احصل على محادثة [ user ، plugin ]: مرجع

CrispClient.website.getConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversation ( websiteID , sessionID ) ;

إزالة محادثة [ user ، plugin ]: مرجع

CrispClient.website.removeConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . removeConversation ( websiteID , sessionID ) ;

بدء محادثة مع الجلسة الحالية [ user ، plugin ]: مرجع

CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . initiateConversationWithExistingSession ( websiteID , sessionID ) ;

احصل على رسائل في محادثة [ user ، plugin ]: مرجع

CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var timestampBefore = 1641206011000 ;

CrispClient . website . getMessagesInConversation ( websiteID , sessionID , timestampBefore ) ;

أرسل رسالة في محادثة [ user ، plugin ]: مرجع

CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var message = {
  "type" : "text" ,
  "from" : "operator" ,
  "origin" : "chat" ,
  "content" : "Hey there! Need help?"
} ;

CrispClient . website . sendMessageInConversation ( websiteID , sessionID , message ) ;

احصل على رسالة في محادثة [ user ، plugin ]: مرجع

CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var fingerprint = 524653764345 ;

CrispClient . website . getMessageInConversation ( websiteID , sessionID , fingerprint ) ;

قم بتحديث رسالة في المحادثة [ user ، plugin ]: مرجع

CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var fingerprint = 524653764345 ;

var content = "Hey there! Need help?" ;

CrispClient . website . updateMessageInConversation ( websiteID , sessionID , fingerprint , content ) ;

إزالة رسالة في محادثة [ user ، plugin ]: مرجع

CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var fingerprint = 524653764345 ;

CrispClient . website . removeMessageInConversation ( websiteID , sessionID , fingerprint ) ;

قم بتكوين رسالة في محادثة [ user ، plugin ]: مرجع

CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var compose = {
  "type" : "start" ,
  "from" : "operator"
} ;

CrispClient . website . composeMessageInConversation ( websiteID , sessionID , compose ) ;

علامة الرسائل كما هو قراءتها في المحادثة [ user ، plugin ]: مرجع

CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var read = {
  "from" : "operator" ,
  "origin" : "urn:crisp.im:slack:0" ,
  "fingerprints" : [
    "5719231201"
  ]
} ;

CrispClient . website . markMessagesReadInConversation ( websiteID , sessionID , read ) ;

وضع علامة على الرسائل كما تم تسليمها في محادثة [ user ، plugin ]: مرجع

CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var delivered = {
  "from" : "operator" ,
  "origin" : "urn:crisp.im:slack:0" ,
  "fingerprints" : [
    "5719231201"
  ]
} ;

CrispClient . website . markMessagesDeliveredInConversation ( websiteID , sessionID , delivered ) ;

تحديث محادثة فتح الحالة [ user ، plugin ]: مرجع

CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var opened = true ;

CrispClient . website . updateConversationOpenState ( websiteID , sessionID , opened ) ;

احصل على محادثة توجيه التعيين [ user ، plugin ]: مرجع

CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationRoutingAssign ( websiteID , sessionID ) ;

تعيين توجيه المحادثة [ user ، plugin ]: مرجع

CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var assign = {
  "assigned" : {
    "user_id" : "a4c32c68-be91-4e29-8a05-976e93abbe3f"
  }
} ;

CrispClient . website . assignConversationRouting ( websiteID , sessionID , assign ) ;

تحديث صندوق الوارد للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var inboxID = "bf6935c9-43b3-4f8e-87ea-175c1e1ed1a9" ;

CrispClient . website . updateConversationInbox ( websiteID , sessionID , inboxID ) ;

احصل على Metas محادثة [ user ، plugin ]: مرجع

CrispClient.website.getConversationMetas(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationMetas ( websiteID , sessionID ) ;

تحديث Metas محادثة [ user ، plugin ]: مرجع

CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var metas = {
  "nickname" : "John Doe" ,
  "email" : "[email protected]" ,
  "segments" : [
    "happy" ,
    "customer" ,
    "love"
  ] ,
  "data" : {
    "type" : "customer" ,
    "signup" : "finished"
  }
} ;

CrispClient . website . updateConversationMetas ( websiteID , sessionID , metas ) ;

احصل على رسالة أصلية في محادثة [ user ، plugin ]: مرجع

CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd" ;

CrispClient . website . getOriginalMessageInConversation ( websiteID , sessionID , originalID ) ;

قائمة صفحات المحادثة [ user ، plugin ]: مرجع

CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pageNumber = 1 ;

CrispClient . website . listConversationPages ( websiteID , sessionID , pageNumber ) ;

قائمة أحداث المحادثة [ user ، plugin ]: مرجع

CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pageNumber = 1 ;

CrispClient . website . listConversationEvents ( websiteID , sessionID , pageNumber ) ;

قائمة ملفات المحادثة [ user ، plugin ]: مرجع

CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pageNumber = 1 ;

CrispClient . website . listConversationFiles ( websiteID , sessionID , pageNumber ) ;

احصل على حالة المحادثة [ user ، plugin ]: مرجع

CrispClient.website.getConversationState(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationState ( websiteID , sessionID ) ;

تغيير حالة المحادثة [ user ، plugin ]: مرجع

CrispClient.website.changeConversationState(websiteID, sessionID, state)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var state = "unresolved" ;

CrispClient . website . changeConversationState ( websiteID , sessionID , state ) ;

احصل على المشاركين في المحادثة [ user ، plugin ]: مرجع

CrispClient.website.getConversationParticipants(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationParticipants ( websiteID , sessionID ) ;

حفظ المشاركين في المحادثة [ user ، plugin ]: مرجع

CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var participants = {
  "participants" : [
    {
      "type" : "email" ,
      "target" : "[email protected]"
    }
  ]
} ;

CrispClient . website . saveConversationParticipants ( websiteID , sessionID , participants ) ;

احصل على حالة كتلة للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getBlockStatusForConversation ( websiteID , sessionID ) ;

قم بحظر الرسائل الواردة للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var blocked = true ;

CrispClient . website . blockIncomingMessagesForConversation ( websiteID , sessionID , blocked ) ;

احصل على حالة التحقق من المحادثة [ user ، plugin ]: مرجع

CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getVerifyStatusForConversation ( websiteID , sessionID ) ;

تحديث التحقق من حالة المحادثة [ user ، plugin ]: مرجع

CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var verified = true ;

CrispClient . website . updateVerifyStatusForConversation ( websiteID , sessionID , verified ) ;

طلب نسخة بريد إلكتروني للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var email = {
  "to" : "operator" ,
  "email" : "[email protected]"
} ;

CrispClient . website . requestEmailTranscriptForConversation ( websiteID , sessionID , to , email ) ;

اطلب تطهير ربط مربع الدردشة للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . requestChatboxBindingPurgeForConversation ( websiteID , sessionID ) ;

اطلب ملاحظات المستخدم للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . requestUserFeedbackForConversation ( websiteID , sessionID ) ;

قائمة جلسات التصفح للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . listBrowsingSessionsForConversation ( websiteID , sessionID ) ;

بدء جلسة التصفح للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . initiateBrowsingSessionForConversation ( websiteID , sessionID ) ;

أرسل الإجراء إلى جلسة تصفح موجودة [ user ، plugin ]: مرجع

CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa" ;

var action = "start" ;

CrispClient . website . sendActionToExistingBrowsingSession ( websiteID , sessionID , browsingID , action ) ;

مساعدة جلسة التصفح الحالية [ user ، plugin ]: مرجع

CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa" ;

var assist = {
  "action" : "mouse" ,
  "mouse" : {
    "x" : 0 ,
    "y" : 784
  }
} ;

CrispClient . website . assistExistingBrowsingSession ( websiteID , sessionID , browsingID , assist ) ;

بدء جلسة مكالمة جديدة للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var mode = "audio" ;

CrispClient . website . initiateNewCallSessionForConversation ( websiteID , sessionID , mode ) ;

احصل على جلسة اتصال مستمرة للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getOngoingCallSessionForConversation ( websiteID , sessionID ) ;

إحباط جلسة الاتصال المستمرة للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56" ;

CrispClient . website . abortOngoingCallSessionForConversation ( websiteID , sessionID , callID ) ;

نقل الإشارات في جلسة المكالمات المستمرة [ user ، plugin ]: مرجع

CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56" ;

var payload = {
  "type" : "sdp" ,
  "payload" : { }
} ;

CrispClient . website . transmitSignalingOnOngoingCallSession ( websiteID , sessionID , callID , payload ) ;

قم بتسليم إجراء زر واجهة المستخدم للمحادثة [ user ]: مرجع

CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292" ;
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785" ;

var value = {
  "section_id" : "payments" ,
  "item_id" : "refund_on_stripe" ,
  "data" : {
    "invoice" : "D-1929-X"
  }
} ;

CrispClient . website . deliverWidgetButtonActionForConversation ( websiteID , sessionID , pluginID , sectionID , itemID , data , value ) ;

قم بتسليم إجراءات جلب بيانات القطعة للمحادثة [ user ]: مرجع

CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292" ;
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785" ;

var data = {
  "section_id" : "payments" ,
  "item_id" : "unpaid_balance" ,
  "action" : "fetch" ,
  "data" : { }
} ;

CrispClient . website . deliverWidgetDataFetchActionForConversation ( websiteID , sessionID , pluginID , sectionID , itemID , data ) ;

قم بتسليم إجراء تحرير بيانات القطعة للمحادثة [ user ]: مرجع

CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292" ;
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785" ;

var data = {
  "section_id" : "payments" ,
  "item_id" : "unpaid_balance" ,
  "action" : "fetch" ,
  "data" : { }
} ;

CrispClient . website . deliverWidgetDataFetchActionForConversation ( websiteID , sessionID , pluginID , sectionID , itemID , data ) ;

جدولة تذكير للمحادثة [ user ، plugin ]: مرجع

CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var note = {
  "date" : "2018-05-29T09:00:00Z" ,
  "note" : "Call this customer."
} ;

CrispClient . website . scheduleReminderForConversation ( websiteID , sessionID , date , note ) ;

موقع الويب (هؤلاء هم المستخدمون النهائيون)

احصل على إحصائيات الأشخاص [ user ، plugin ]: مرجع
- CrispClient.website.getPeopleStatistics(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . getPeopleStatistics ( websiteID ) ;
```

القائمة المقترحة للأفراد شرائح [ user ، plugin ]: المرجع

CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedPeopleSegments ( websiteID , pageNumber ) ;

حذف قطاع الأشخاص المقترحين [ user ، plugin ]: مرجع

CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var segment = "poweruser" ;

CrispClient . website . deleteSuggestedPeopleSegment ( websiteID , segment ) ;

قائمة مفاتيح بيانات الأشخاص المقترحة [ user ، plugin ]: مرجع
- CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedPeopleDataKeys ( websiteID , pageNumber ) ;
```

حذف مفتاح بيانات الأشخاص المقترح [ user ، plugin ]: مرجع

CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var key = "price" ;

CrispClient . website . deleteSuggestedPeopleDataKey ( websiteID , key ) ;

قائمة أحداث الأشخاص المقترحة [ user ، plugin ]: مرجع

CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedPeopleEvents ( websiteID , pageNumber ) ;

حذف حدث الأشخاص المقترح [ user ، plugin ]: مرجع

CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var text = "Removed item from basket" ;

CrispClient . website . deleteSuggestedPeopleEvent ( websiteID , text ) ;

سرد ملفات تعريف الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleProfiles ( websiteID , pageNumber , searchField , searchOrder , searchOperator , searchFilter , searchText ) ;

أضف ملف تعريف الأشخاص الجدد [ user ، plugin ]: مرجع

CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var peopleProfile = {
  "email" : "[email protected]" ,
  "person" : {
    "nickname" : "Valerian Saliou"
  }
} ;

CrispClient . website . addNewPeopleProfile ( websiteID , peopleProfile ) ;

تحقق مما إذا كان ملف تعريف الأشخاص موجودًا [ user ، plugin ]: مرجع

CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . checkPeopleProfileExists ( websiteID , peopleID ) ;

احصل على ملف تعريف الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.getPeopleProfile(websiteID, peopleID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . getPeopleProfile ( websiteID , peopleID ) ;

حفظ ملف تعريف الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleProfile = {
  "email" : "[email protected]" ,
  "person" : {
    "nickname" : "Valerian Saliou"
  }
} ;

CrispClient . website . savePeopleProfile ( websiteID , peopleID , peopleProfile ) ;

تحديث ملف تعريف الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleProfile = {
  "email" : "[email protected]" ,
  "person" : {
    "nickname" : "Valerian Saliou"
  }
} ;

CrispClient . website . updatePeopleProfile ( websiteID , peopleID , peopleProfile ) ;

إزالة ملف تعريف الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.removePeopleProfile(websiteID, peopleID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . removePeopleProfile ( websiteID , peopleID ) ;

اذكر محادثات الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleConversations ( websiteID , peopleID , pageNumber ) ;

سرد حملات الأشخاص [ user ]: المرجع

CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleCampaigns ( websiteID , peopleID , pageNumber ) ;

أضف حدث الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleEvent = {
  "text" : "Added item to basket" ,
  "data" : {
    "price" : 10.99 ,
    "currency" : "USD"
  } ,
  "color" : "red"
} ;

CrispClient . website . addPeopleEvent ( websiteID , peopleID , peopleEvent ) ;

اذكر أحداث الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleEvents ( websiteID , peopleID , pageNumber ) ;

احصل على بيانات الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.getPeopleData(websiteID, peopleID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . getPeopleData ( websiteID , peopleID ) ;

حفظ بيانات الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleData = {
  "data" : {
    "type" : "customer" ,
    "signup" : "finished"
  }
} ;

CrispClient . website . savePeopleData ( websiteID , peopleID , peopleData ) ;

تحديث بيانات الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleData = {
  "data" : {
    "signup" : "finished"
  }
} ;

CrispClient . website . updatePeopleData ( websiteID , peopleID , peopleData ) ;

احصل على حالة اشتراك الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . getPeopleSubscriptionStatus ( websiteID , peopleID ) ;

تحديث حالة اشتراك الأشخاص [ user ، plugin ]: مرجع

CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleSubscription = {
  "email" : true
} ;

CrispClient . website . updatePeopleSubscriptionStatus ( websiteID , peopleID , peopleSubscription ) ;

تصدير ملفات تعريف الأشخاص [ user ]: مرجع
- CrispClient.website.exportPeopleProfiles(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . exportPeopleProfiles ( websiteID ) ;
```

استيراد ملفات تعريف الأشخاص [ user ]: المرجع

CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var profileImportSetup = {
  "url" : "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv" ,
  "mapping" : [
    {
      "column" : 1 ,
      "field" : "email"
    } ,
    {
      "column" : 2 ,
      "field" : "person.nickname"
    }
  ] ,
  "options" : {
    "column_separator" : ";" ,
    "skip_header" : true
  }
} ;

CrispClient . website . importPeopleProfiles ( websiteID , profileImportSetup ) ;

إشعار: يمكن أن تكون حجة peopleID بريدًا إلكترونيًا أو peopleID .

موقع مساعدة الموقع

تحقق مما إذا كان هناك HelpDesk موجود [ user ، plugin ]: مرجع
- CrispClient.website.checkHelpdeskExists(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . checkHelpdeskExists ( websiteID ) ;
```

حل المساعدة [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdesk(websiteID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . resolveHelpdesk ( websiteID ) ;

تهيئة HelpDesk [ user ]: مرجع

CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var name = "Valerian Helpdesk" ;
var domainBasic = "valerian" ;

CrispClient . website . initializeHelpdesk ( websiteID , name , domainBasic ) ;

حذف Helpdesk [ user ]: مرجع

CrispClient.website.deleteHelpdesk(websiteID, verify)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var verify = {
  "method" : "password" ,
  "secret" : "MySuperSecurePassword" ;
} ;

CrispClient . website . deleteHelpdesk ( websiteID , verify ) ;

اذكر kispdesk standes [ user ، plugin ]: مرجع

CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options={})

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocales ( websiteID , pageNumber , {
  order_visits : "1"
} ) ;

أضف لغة الإدارة [ user ، plugin ]: مرجع

CrispClient.website.addHelpdeskLocale(websiteID, locale)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . addHelpdeskLocale ( websiteID , locale ) ;

تحقق مما إذا كان هناك لغة HelpDesk موجودة [ user ، plugin ]: مرجع

CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . checkHelpdeskLocaleExists ( websiteID , locale ) ;

حل موقع Helpdesk [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . resolveHelpdeskLocale ( websiteID , locale ) ;

حذف لغة الإعدام [ user ، plugin ]: مرجع

CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . deleteHelpdeskLocale ( websiteID , locale ) ;

plugin مقالات user موقع Helpdesk

CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleArticles ( websiteID , locale , pageNumber ) ;

أضف مقالًا جديدًا لموقع HelpDesk [ user ، plugin ]: مرجع

CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var title = "How to use $crisp JavaScript SDK?" ;

CrispClient . website . addNewHelpdeskLocaleArticle ( websiteID , locale , title ) ;

تحقق مما إذا كانت مقالة موقع HelpDesk موجودة [ user ، plugin ]: مرجع

CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . checkHelpdeskLocaleArticleExists ( websiteID , locale , articleId ) ;

plugin مقالة لغة user

CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . resolveHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

احفظ مقالة لغة المساعدة [ user ، plugin ]: مرجع

CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

var article = {
  "title" : "How to use $crisp JavaScript SDK?" ,
  "description" : null ,
  "content" : "Crisp lets you create your customized chatbox easily. **It's easy to setup**." ,
  "featured" : false ,
  "order" : 1
} ;

CrispClient . website . saveHelpdeskLocaleArticle ( websiteID , locale , articleId , article ) ;

قم plugin مقالة لغة user

CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

var article = {
  "content" : "Crisp lets you create your customized chatbox easily. **It's easy to setup**."
} ;

CrispClient . website . updateHelpdeskLocaleArticle ( websiteID , locale , articleId , article ) ;

plugin مقالة لغة user

CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . deleteHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

حل صفحة المقالة المحلية المحلية حلها [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . resolveHelpdeskLocaleArticlePage ( websiteID , locale , articleId ) ;

حل plugin مقالة لغة user

CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . resolveHelpdeskLocaleArticleCategory ( websiteID , locale , articleId ) ;

تحديث plugin مقالة لغة user

CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId, sectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var categoryId = "00d344a3-8948-45b5-9bc4-82ec249fcd44" ;

CrispClient . website . updateHelpdeskLocaleArticleCategory ( websiteID , locale , articleId , categoryId ) ;

اذكر مقالة LISEDSDESK LOCAALE البديلة [ user ، plugin ]: مرجع

CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . listHelpdeskLocaleArticleAlternates ( websiteID , locale , articleId ) ;

تحقق مما إذا كان مقالة موقع HelpDesk البديلة موجودة [ user ، plugin ]: مرجع

CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;

CrispClient . website . checkHelpdeskLocaleArticleAlternateExists ( websiteID , locale , articleId , localeLinked ) ;

حل مقالة تحديد موقع Helpdesk البديل [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;

CrispClient . website . resolveHelpdeskLocaleArticleAlternate ( websiteID , locale , articleId , localeLinked ) ;

احفظ مقالة LOCEND SCALALE PELTER [ user ، plugin ]: مرجع

CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;
var articleIdLinked = "9dc0e823-56b0-43ca-9ca3-47e25a8eb543" ;

CrispClient . website . saveHelpdeskLocaleArticleAlternate ( websiteID , locale , articleId , localeLinked , articleIdLinked ) ;

plugin مقالة alsoale alsale user

CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;

CrispClient . website . deleteHelpdeskLocaleArticleAlternate ( websiteID , locale , articleId , localeLinked ) ;

نشر مقالة لغة المساعدة [ user ، plugin ]: مرجع

CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . publishHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

مقالة LOCKALIST unpublish Helpdesk locale [ user ، plugin ]: مرجع

CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . unpublishHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

اذكر plugin لغة user

CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleCategories ( websiteID , locale , pageNumber ) ;

أضف فئة plugin user

CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var name = "Chatbox" ;

CrispClient . website . addHelpdeskLocaleCategory ( websiteID , locale , name ) ;

تحقق مما إذا كانت فئة Local Locale موجودة [ user ، plugin ]: مرجع

CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

CrispClient . website . checkHelpdeskLocaleCategoryExists ( websiteID , locale , categoryId ) ;

حل فئة Localdesk Locale [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

CrispClient . website . resolveHelpdeskLocaleCategory ( websiteID , locale , categoryId ) ;

احفظ plugin لغة user

CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

var category = {
  "name" : "Chatbox" ,
  "description" : "Help on how to setup and use the Crisp chatbox." ,
  "color" : "#377FEA" ,
  "image" : null ,
  "order" : 1
} ;

CrispClient . website . saveHelpdeskLocaleCategory ( websiteID , locale , categoryId , category ) ;

قم بتحديث فئة LocalDesk Locale [ user ، plugin ]: مرجع

CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

var category = {
  "color" : "#377FEA"
} ;

CrispClient . website . updateHelpdeskLocaleCategory ( websiteID , locale , categoryId , category ) ;

حذف فئة LocalDesk Locale [ user ، plugin ]: مرجع

CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

CrispClient . website . deleteHelpdeskLocaleCategory ( websiteID , locale , categoryId ) ;

plugin أقسام لغة user

CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleSections ( websiteID , locale , categoryId , pageNumber ) ;

أضف قسم لغة الإدارة [ user ، plugin ]: مرجع

CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var name = "Integrate with our SDKs" ;

CrispClient . website . addHelpdeskLocaleSection ( websiteID , locale , categoryId , name ) ;

تحقق مما إذا كان هناك قسم لغة HESPLESDESK [ user ، plugin ]: مرجع

CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

CrispClient . website . checkHelpdeskLocaleSectionExists ( websiteID , locale , categoryId , sectionId ) ;

حل القسم user plugin

CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

CrispClient . website . resolveHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId ) ;

احفظ قسم لغة المساعدة في المساعدة [ user ، plugin ]: مرجع

CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

var section = {
  "name" : "Integrate with our SDKs" ,
  "order" : 1
} ;

CrispClient . website . saveHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId , section ) ;

قم بتحديث قسم لغة الإعدام [ user ، plugin ]: مرجع

CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

var section = {
  "name" : "Integrate with our SDKs" ,
  "order" : 1
} ;

CrispClient . website . updateHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId , section ) ;

حذف قسم لغة الإبلاغ عن المساعدة [ user ، plugin ]: مرجع

CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

CrispClient . website . deleteHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId ) ;

MAP Helpdesk Locale Residents تصنيفات [ user ، plugin ]: مرجع
- CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . mapHelpdeskLocaleFeedbackRatings ( websiteID , locale ) ;
```

plugin التعليقات المتعلقة user

CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber, filterDateStart, filterDateEnd)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleFeedbacks ( websiteID , locale , pageNumber ) ;

استيراد مكتب المساعدة الخارجية إلى اللغة [ user ]: مرجع

CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var helpdeskUrl = "https://docs.acme.com/" ;

CrispClient . website . importExternalHelpdeskToLocale ( websiteID , locale , helpdeskUrl ) ;

تصدير المقالات المحلية للمساعدة [ user ]: مرجع

CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . exportHelpdeskLocaleArticles ( websiteID , locale ) ;

اذكر إعادة توجيهات Redivisions [ user ، plugin ]: مرجع

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

أضف إعادة توجيه HelpDesk [ user ، plugin ]: مرجع

CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var redirectionPath = "/en/article/how-can-i-automatically-set-custom-user-data/" ;
var redirectionTarget = "/en/article/how-can-i-automatically-set-custom-user-data-1xh7pqk/" ;

CrispClient . website . addHelpdeskRedirection ( websiteID , redirectionPath , redirectionTarget ) ;

تحقق مما إذا كان إعادة توجيه HelpDesk موجودة [ user ، plugin ]: مرجع

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25" ;

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

حل إعادة توجيه Helpdesk [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25" ;

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

حذف إعادة توجيه Helpdesk [ user ، plugin ]: مرجع

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25" ;

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

حل إعدادات HelpDesk [ user ، plugin ]: مرجع

CrispClient.website.resolveHelpdeskSettings(websiteID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;

احفظ إعدادات HelpDesk [ user ، plugin ]: مرجع

CrispClient.website.saveHelpdeskSettings(websiteID, settings)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var settings = {
  "name" : "Valerian Helpdesk" ,

  "appearance" : {
    "logos" : {
      "header" : null ,
      "footer" : null
    } ,

    "banner" : null
  } ,

  "behavior" : {
    "frequently_read" : true ,
    "show_category_images" : true ,
    "show_chatbox" : true ,
    "ask_feedback" : false ,
    "locale_picker" : false ,
    "refer_link" : true ,
    "forbid_indexing" : false ,
    "status_health_dead" : true
  } ,

  "include" : {
    "html" : null
  } ,

  "access" : {
    "password" : null
  }
} ;

CrispClient . website . saveHelpdeskSettings ( websiteID , settings ) ;

حل مجال Helpdesk [ user ]: مرجع

CrispClient.website.resolveHelpdeskDomain(websiteID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . resolveHelpdeskDomain ( websiteID ) ;

طلب تغيير مجال HELPDESKN [ user ]: مرجع

CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var basic = "valerian" ;
var custom = "help.valeriansaliou.name" ;

CrispClient . website . requestHelpdeskDomainChange ( websiteID , basic , custom ) ;

قم بإنشاء تدفق إعداد مجال Helpdesk [ user ]: مرجع

CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var custom = "help.valeriansaliou.name" ;

CrispClient . website . generateHelpdeskDomainSetupFlow ( websiteID , custom ) ;

قاعدة الموقع
- تحقق مما إذا كان موقع الويب موجودًا [ user ، plugin ]: مرجع
  - CrispClient.website.checkWebsiteExists(domain)
  - انظر المثال
    CrispClient . website . checkWebsiteExists ( domain ) ;
- إنشاء موقع ويب [ user ]: مرجع
  - CrispClient.website.createWebsite(websiteData)
  - انظر المثال
    CrispClient . website . createWebsite ( websiteData ) ;
- احصل على موقع ويب [ user ، plugin ]: مرجع
  - CrispClient.website.getWebsite(websiteID)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsite ( websiteID ) ;
- حذف موقع ويب [ user ]: مرجع
  - CrispClient.website.deleteWebsite(websiteID, verify)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var verify = { "method" : "password" , "secret" : "MySuperSecurePassword" ; } ; CrispClient . website . deleteWebsite ( websiteID , verify ) ;
- إحباط حذف موقع الويب [ user ]: مرجع
  - CrispClient.website.abortWebsiteDeletion(websiteID)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

إعدادات الموقع

احصل على إعدادات الموقع [ user ، plugin ]: مرجع
- CrispClient.website.getWebsiteSettings(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . getWebsiteSettings ( websiteID ) ;
```

تحديث إعدادات الموقع [ user ، plugin ]: مرجع

CrispClient.website.updateWebsiteSettings(websiteID, settings)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var settings = {
  "name" : "Crisp" ,
  "domain" : "crisp.chat" ,
  "logo" : "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png" ,
  "audit" : {
    "log" : true
  } ,
  "contact" : {
    "email" : "[email protected]" ,
    "phone" : "+33757905447"
  } ,
  "inbox" : {
    "lock_removal" : false ,
    "force_operator_token" : false
  } ,
  "emails" : {
    "rating" : true ,
    "transcript" : true ,
    "enrich" : true ,
    "junk_filter" : true
  } ,
  "chatbox" : {
    "tile" : "default" ,
    "wait_game" : false ,
    "website_logo" : true ,
    "last_operator_face" : false ,
    "ongoing_operator_face" : true ,
    "activity_metrics" : true ,
    "operator_privacy" : false ,
    "availability_tooltip" : true ,
    "hide_vacation" : false ,
    "hide_on_away" : false ,
    "hide_on_mobile" : false ,
    "position_reverse" : false ,
    "email_visitors" : false ,
    "phone_visitors" : false ,
    "force_identify" : false ,
    "ignore_privacy" : false ,
    "visitor_compose" : false ,
    "file_transfer" : true ,
    "overlay_search" : true ,
    "overlay_mode" : false ,
    "helpdesk_link" : true ,
    "helpdesk_only" : false ,
    "status_health_dead" : true ,
    "check_domain" : false ,
    "color_theme" : "blue" ,
    "text_theme" : "default" ,
    "welcome_message" : "default" ,
    "locale" : "en" ,
    "allowed_pages" : [ ] ,
    "blocked_pages" : [
      "status/*/" ,
      "docs.crisp.chat/*" ,
      "crisp.chat/terms/" ,
      "https://crisp.chat/privacy/"
    ] ,
    "blocked_countries" : [
      "IT"
    ] ,
    "blocked_locales" : [
      "fa" ,
      "he"
    ] ,
    "blocked_ips" : [
      "8.8.8.8" ,
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334" ,
      "192.168.1.1/24"
    ]
  }
} ;

CrispClient . website . updateWebsiteSettings ( websiteID , settings ) ;

مشغل الموقع

قائمة مشغلي موقع الويب [ user ، plugin ]: مرجع
- CrispClient.website.listWebsiteOperators(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listWebsiteOperators ( websiteID ) ;
```
قائمة آخر مشغلات موقع الويب النشطين [ user ، plugin ]: مرجع
- CrispClient.website.listLastActiveWebsiteOperators(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listLastActiveWebsiteOperators ( websiteID ) ;
```
مشغلو موقع الويب النشط الأخير [ user ]: مرجع
- CrispClient.website.flushLastActiveWebsiteOperators(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . flushLastActiveWebsiteOperators ( websiteID ) ;
```

أرسل بريدًا إلكترونيًا إلى مشغلو المواقع [ user ، plugin ]: مرجع

CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var emailData = {
  "recipient" : "owners" ,
  "subject" : "Plugin limits reached" ,
  "message" : "Hi, you've reached the Slack plugin limits. Please contact our support team."
} ;

CrispClient . website . sendEmailToWebsiteOperators ( websiteID , emailData ) ;

احصل على مشغل موقع ويب [ user ، plugin ]: مرجع

CrispClient.website.getWebsiteOperator(websiteID, userID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f" ;

CrispClient . website . getWebsiteOperator ( websiteID , userID ) ;

دعوة مشغل موقع ويب [ user ]: مرجع

CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var email = "[email protected]" ;
var role = "member" ;

var verify = {
  "method" : "password" ,
  "secret" : "MySuperSecurePassword" ;
} ;

CrispClient . website . inviteWebsiteOperator ( websiteID , email , role , verify ) ;

تغيير عضوية المشغل [ user ]: المرجع

CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f" ;

var title = {
  "role" : "owner" ,
  "title" : "CTO"
} ;

CrispClient . website . changeOperatorMembership ( websiteID , userID , role , title ) ;

عامل غير متخيل من موقع الويب [ user ]: مرجع

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f" ;

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

زوار الموقع
- عد الزوار [ user ، plugin ]: مرجع
  - CrispClient.website.countVisitors(websiteID)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . countVisitors ( websiteID ) ;
- قائمة الزوار [ user ، plugin ]: مرجع
  - CrispClient.website.listVisitors(websiteID, pageNumber)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var pageNumber = 1 ; CrispClient . website . listVisitors ( websiteID , pageNumber ) ;
- حدد الزوار على الخريطة [ user ، plugin ]: مرجع
  - CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . pinpointVisitorsOnMap ( websiteID , centerLongitude , centerLatitude , centerRadius ) ;
- احصل على معرف الجلسة من الرمز المميز [ user ، plugin ]: مرجع
  - CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904" ; CrispClient . website . getSessionIdentifierFromToken ( websiteID , tokenID ) ;
- عدد الزوار المحظور [ user ]: مرجع
  - CrispClient.website.countBlockedVisitors(websiteID)
- عدد الزوار المحظور في القاعدة [ user ]: مرجع
  - CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . countBlockedVisitorsInRule ( websiteID , rule ) ;
- مسح الزوار المحظور في القاعدة [ user ]: المرجع
  - CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . clearBlockedVisitorsInRule ( websiteID , rule ) ;
توافر الموقع
- احصل على حالة توافر الموقع [ user ، plugin ]: مرجع
  - CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;
- قائمة مشغل موقع الويب [ user ، plugin ]: مرجع
  - CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;
تحليلات الموقع
- إنشاء تحليلات [ user ]: مرجع
  - CrispClient.website.generateAnalytics(websiteID, query)
  - انظر المثال
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . generateAnalytics ( websiteID , query ) ;

دفعة الموقع

محادثات حل الدُفعات [ user ]: مرجع

CrispClient.website.batchResolveConversations(websiteID, operation)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var operation = {
  "inbox_id" : null ,

  "sessions" : [
    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
  ]
} ;

CrispClient . website . batchResolveConversations ( websiteID , operation ) ;

محادثات قراءة الدُفعة [ user ]: مرجع

CrispClient.website.batchReadConversations(websiteID, operation)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var operation = {
  "inbox_id" : null ,

  "sessions" : [
    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
  ]
} ;

CrispClient . website . batchReadConversations ( websiteID , operation ) ;

دفعة إزالة المحادثات [ user ]: مرجع

CrispClient.website.batchRemoveConversations(websiteID, operation)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var operation = {
  "inbox_id" : null ,

  "sessions" : [
    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
  ]
} ;

CrispClient . website . batchRemoveConversations ( websiteID , operation ) ;

دفعة إزالة الأشخاص [ user ]: مرجع

CrispClient.website.batchRemovePeople(websiteID, people)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var sessions = [
  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
] ;

CrispClient . website . batchRemoveConversations ( websiteID , sessions ) ;

التحقق من الموقع

احصل على إعدادات التحقق [ user ، plugin ]: مرجع
- CrispClient.website.getVerifySettings(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . getVerifySettings ( websiteID ) ;
```

تحديث تحديث الإعدادات [ user ، plugin ]: مرجع

CrispClient.website.updateVerifySettings(websiteID, settings)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var settings = {
  "enabled" : true
} ;

CrispClient . website . updateVerifySettings ( websiteID , settings ) ;

احصل على مفتاح التحقق [ user ، plugin ]: مرجع
- CrispClient.website.getVerifyKey(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . getVerifyKey ( websiteID ) ;
```

Roll تحقق من مفتاح [ user ، plugin ]: مرجع

CrispClient.website.rollVerifyKey(websiteID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . rollVerifyKey ( websiteID ) ;

حملات الموقع

قائمة الحملات [ user ]: المرجع

CrispClient.website.listCampaigns(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listCampaigns ( websiteID , pageNumber ) ;

قائمة علامات الحملة [ user ]: المرجع

CrispClient.website.listCampaignTags(websiteID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listCampaignTags ( websiteID ) ;

قائمة قوالب الحملة [ user ، plugin ]: مرجع

CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listCampaignTemplates ( websiteID , pageNumber ) ;

قم بإنشاء قالب حملة جديد [ user ، plugin ]: مرجع

CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var templateName = {
  "name" : "HTML Template" ,
  "format" : "html"
} ;

CrispClient . website . createNewCampaignTemplate ( websiteID , templateFormat , templateName ) ;

تحقق مما إذا كان قالب الحملة [ user ، plugin ]: مرجع

CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

CrispClient . website . checkCampaignTemplateExists ( websiteID , templateID ) ;

احصل على قالب حملة [ user ، plugin ]: مرجع

CrispClient.website.getCampaignTemplate(websiteID, templateID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

CrispClient . website . getCampaignTemplate ( websiteID , templateID ) ;

احفظ قالب الحملة [ user ، plugin ]: مرجع

CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

var template = {
  "name" : "HTML Template" ,
  "format" : "html" ,
  "content" : "<html><body><a href="{{url.unsubscribe}}"></a></body></html>"
} ;

CrispClient . website . saveCampaignTemplate ( websiteID , templateID , template ) ;

قم بتحديث قالب الحملة [ user ، plugin ]: مرجع

CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

var template = "<html><body><a href="{{url.unsubscribe}}"></a></body></html>" ;

CrispClient . website . updateCampaignTemplate ( websiteID , templateID , template ) ;

قم بإزالة قالب الحملة [ user ، plugin ]: مرجع

CrispClient.website.removeCampaignTemplate(websiteID, templateID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

CrispClient . website . removeCampaignTemplate ( websiteID , templateID ) ;

حملة الموقع

إنشاء حملة جديدة [ user ]: مرجع

CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var campaignName = {
  "type" : "one-shot" ,
  "name" : "Welcome!"
} ;

CrispClient . website . createNewCampaign ( websiteID , campaignType , campaignName ) ;

تحقق مما إذا كانت الحملة موجودة [ user ]: مرجع

CrispClient.website.checkCampaignExists(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . checkCampaignExists ( websiteID , campaignID ) ;

احصل على حملة [ user ]: مرجع

CrispClient.website.getCampaign(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . getCampaign ( websiteID , campaignID ) ;

حفظ حملة [ user ]: المرجع

CrispClient.website.saveCampaign(websiteID, campaignID, campaign)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

var campaign = {
  "type" : "one-shot" ,
  "format" : "markdown" ,
  "name" : "Welcome!" ,
  "sender" : {
    "user_id" : "aa0b64dd-9fb4-4db9-80d6-5a49eb84087b"
  } ,
  "recipients" : {
    "type" : "all"
  } ,
  "message" : "*Hey there*, welcome on Crisp!" ,
  "options" : {
    "deliver_to_chatbox" : true ,
    "deliver_to_email" : true ,
    "sender_name_website" : false ,
    "sender_email_reply" : null ,
    "tracking" : true
  }
} ;

CrispClient . website . saveCampaign ( websiteID , campaignID , campaign ) ;

تحديث حملة [ user ]: المرجع

CrispClient.website.updateCampaign(websiteID, campaignID, campaign)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

var campaign = {
  "message" : "*Hey there*, welcome on Crisp folks!"
} ;

CrispClient . website . updateCampaign ( websiteID , campaignID , campaign ) ;

إزالة حملة [ user ]: المرجع

CrispClient.website.removeCampaign(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . removeCampaign ( websiteID , campaignID ) ;

إرسال حملة [ user ]: مرجع

CrispClient.website.dispatchCampaign(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . dispatchCampaign ( websiteID , campaignID ) ;

استئناف حملة [ user ]: مرجع

CrispClient.website.resumeCampaign(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . resumeCampaign ( websiteID , campaignID ) ;

إيقاف حملة [ user ]: مرجع

CrispClient.website.pauseCampaign(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . pauseCampaign ( websiteID , campaignID ) ;

اختبر حملة [ user ]: مرجع

CrispClient.website.testCampaign(websiteID, campaignID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . testCampaign ( websiteID , campaignID ) ;

قائمة المستفيدين من الحملة [ user ]: المرجع

CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;
var pageNumber = 1 ;

CrispClient . website . listCampaignRecipients ( websiteID , campaignID , pageNumber ) ;

قائمة إحصائيات الحملة [ user ]: المرجع

CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;
var pageNumber = 1 ;

CrispClient . website . listCampaignStatistics ( websiteID , campaignID , action , pageNumber ) ;

البرنامج المساعد

Connect Connect
- احصل على حساب الاتصال [ plugin ]: مرجع
  - CrispClient.plugin.getConnectAccount()
  - انظر المثال
    CrispClient . plugin . getConnectAccount ( ) ;
- تحقق من صحة جلسة الاتصال [ plugin ]: مرجع
  - CrispClient.plugin.checkConnectSessionValidity()
  - انظر المثال
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- اذكر جميع مواقع الويب Connect [ plugin ]: مرجع
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - انظر المثال
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- قائمة مواقع الاتصال منذ [ plugin ]: مرجع
  - CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
  - انظر المثال
    var dateSince = "2023-08-16T09:00:00Z" ; CrispClient . plugin . listConnectWebsitesSince ( dateSince , filterConfigured ) ;
- احصل على نقاط نهاية الاتصال [ plugin ]: مرجع
  - CrispClient.plugin.getConnectEndpoints()
  - انظر المثال
    CrispClient . plugin . getConnectEndpoints ( ) ;

اشتراك البرنامج المساعد

قائمة جميع الاشتراكات النشطة [ user ]: المرجع
- CrispClient.plugin.listAllActiveSubscriptions()
- انظر المثال
```
 CrispClient . plugin . listAllActiveSubscriptions ( ) ;
```
قائمة الاشتراكات لموقع ويب [ user ]: مرجع
- CrispClient.plugin.listSubscriptionsForWebsite(websiteID)
- انظر المثال
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . plugin . listSubscriptionsForWebsite ( websiteID ) ;
```

احصل على تفاصيل الاشتراك [ user ، plugin ]: مرجع

CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . getSubscriptionDetails ( websiteID , pluginID ) ;

موقع الاشتراك في البرنامج المساعد [ user ]: مرجع

CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var pluginID = "98454664-9f7d-4d95-a9ce-f37356f5e65a" ;

CrispClient . plugin . subscribeWebsiteToPlugin ( websiteID , pluginID ) ;

إلغاء الاشتراك المكون الإضافي من موقع الويب [ user ]: مرجع

CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . unsubscribePluginFromWebsite ( websiteID , pluginID ) ;

احصل على إعدادات الاشتراك [ user ، plugin ]: مرجع

CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . getSubscriptionSettings ( websiteID , pluginID ) ;

احفظ إعدادات الاشتراك [ user ، plugin ]: مرجع

CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var settings = {
  "chatbox" : {
    "25" : "#bbbbbb"
  }
} ;

CrispClient . plugin . saveSubscriptionSettings ( websiteID , pluginID , settings ) ;

تحديث إعدادات الاشتراك [ user ، plugin ]: مرجع

CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var settings = {
  "chatbox" : {
    "25" : "#bbbbbb"
  }
} ;

CrispClient . plugin . updateSubscriptionSettings ( websiteID , pluginID , settings ) ;

احصل على فواتير استخدام البرنامج المساعد [ user ، plugin ]: مرجع

CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . getPluginUsageBills ( websiteID , pluginID ) ;

الإبلاغ عن استخدام البرنامج المساعد إلى فاتورة [ plugin ]: مرجع

CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var usage = {
  "name" : "Paid messages sent" ,
  "units" : 250 ,
  "price" : 0.10
} ;

CrispClient . plugin . reportPluginUsageToBill ( websiteID , pluginID , usage ) ;

حمولة مكون الإضافي إلى القناة [ user ، plugin ]: مرجع

CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var payload = {
  "namespace" : "bot:step" ,
  "payload" : {
    "step" : 1
  }
} ;

CrispClient . plugin . forwardPluginPayloadToChannel ( websiteID , pluginID , payload ) ;

حدث إرسال البرنامج المساعد [ user ، plugin ]: مرجع

CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)

انظر المثال

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var payload = {
  "name" : "bot-is-running" ,
  "data" : {
    "bot" : "Sales" ,
    "email" : "[email protected]"
  }
} ;

CrispClient . plugin . dispatchPluginEvent ( websiteID , pluginID , payload ) ;

وسائط

الرسوم المتحركة الإعلامية
- قائمة وسائط الرسوم المتحركة [ user ]: المرجع
  - CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)
  - انظر المثال
    var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3" ; var pageNumber = 1 ; CrispClient . media . listAnimationMedias ( pageNumber , listID , searchQuery ) ;

دلو

عنوان URL دلو
- قم بإنشاء عنوان URL لدلو [ user ، plugin ]: مرجع
  - CrispClient.bucket.generateBucketURL(data)
  - انظر المثال
    CrispClient . bucket . generateBucketURL ( data ) ;

أحداث الوقت الحقيقي

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

لن تتلقى أي حدث إذا لم تقم بالاشتراك بشكل صريح في الأحداث الحقيقية ، حيث لا تتصل المكتبة بالواجهة الخلفية في الوقت الفعلي تلقائيًا.

هناك طريقتان لتلقي أحداث في الوقت الفعلي:

باستخدام خطافات الويب ( الموصى بها )
باستخدام WebSockets مع API RTM

قبل أن تبدأ بأحداث RTM ، يرجى النظر في ما يلي:

لن تتلقى أي حدث إذا لم تقم بالاشتراك بشكل صريح في الأحداث الحقيقية باستخدام CrispClient.on() ، حيث لا تتصل المكتبة بالواجهة الخلفية في الوقت الفعلي تلقائيًا. هذه الطريقة تُرجع كائن Promise .
كلما كان من المستحيل على قائمة مواقع الويب التي يحق لك رمز المصادقة الحصول على أحداث للتغييرات ، ستحتاج إلى الاتصال بـ CrispClient.rebindSocket() . هذه الطريقة أيضا إرجاع كائن Promise . هذا ينطبق فقط على WebSockets مع API RTM .

تلقي أحداث الوقت الحقيقي

تلقي الأحداث عبر خطافات الويب

لبدء الاستماع للأحداث وربط معالج ، تحقق من مثال على السنانير على الويب.

ستحتاج إلى ضبط الكود الخاص بك بحيث:

تم تعيين وضع أحداث RTM على خطافات الويب: CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
تقوم نقطة نهاية HTTP الخاصة بك بتركيب مسار يستمع لطلبات البريد ، وعند استلام الطلبات:
1. إنه يتحقق من الطلبات مع: CrispClient.verifyHook(secret, body, timestamp, signature)
2. يتلقى خطاف الويب مع: CrispClient.receiveHook(body)

ستحتاج خطافات الويب المكوّنة الإضافية إلى تكوينها أولاً حتى تعمل هذا. تحقق من دليل QuickStart QuickStart الخاص بسنانير ويب ومرجع خطاف الويب الخاص بنا للبدء.

تلقي الأحداث عبر WebSockets (RTM API)

لبدء الاستماع للأحداث وربط معالج ، تحقق من مثال الأحداث على WebSockets.

ستحتاج إلى ضبط الكود الخاص بك بحيث:

تم تعيين وضع أحداث RTM على WebSockets: CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

أحداث الوقت الحقيقي المتاحة

الأحداث المتاحة مدرجة أدناه:

أحداث الجلسة : مرجع
- توافر تحديث الجلسة [ user ، plugin ]:
  - session:update_availability
- تحديث الجلسة تحقق [ user ، plugin ]:
  - session:update_verify
- بدأ طلب الجلسة [ user ، plugin ]:
  - session:request:initiated
- تعيين بريد إلكتروني للجلسة [ user ، plugin ]:
  - session:set_email
- هاتف SET SET [ user ، plugin ]:
  - session:set_phone
- عنوان تعيين الجلسة [ user ، plugin ]:
  - session:set_address
- موضوع مجموعة الجلسة [ user ، plugin ]:
  - session:set_subject
- مجموعة الجلسة الصورة الرمزية [ user ، plugin ]:
  - session:set_avatar
- لقب مجموعة الجلسة [ user ، plugin ]:
  - session:set_nickname
- بيانات تعيين الجلسة [ user ، plugin ]:
  - session:set_data
- صفحات مزامنة الجلسة [ user ، plugin ]:
  - session:sync:pages
- أحداث مزامنة الجلسة [ user ، plugin ]:
  - session:sync:events
- إمكانيات مزامنة الجلسة [ user ، plugin ]:
  - session:sync:capabilities
- Session Sync GeoLocation [ user ، plugin ]:
  - session:sync:geolocation
- نظام مزامنة الجلسة [ user ، plugin ]:
  - session:sync:system
- شبكة مزامنة الجلسة [ user ، plugin ]:
  - session:sync:network
- المنطقة الزمنية Sync Sync [ user ، plugin ]:
  - session:sync:timezone
- أماكن مزامنة الجلسة [ user ، plugin ]:
  - session:sync:locales
- تصنيف مزامنة الجلسة [ user ، plugin ]:
  - session:sync:rating
- موضوع مزامنة الجلسة [ user ، plugin ]:
  - session:sync:topic
- حالة مجموعة الجلسة [ user ، plugin ]:
  - session:set_state
- كتلة مجموعة الجلسة [ user ، plugin ]:
  - session:set_block
- شرائح تعيين الجلسة [ user ، plugin ]:
  - session:set_segments
- تم فتح الجلسة [ user ، plugin ]:
  - session:set_opened
- مجموعة جلسة مغلقة [ user ، plugin ]:
  - session:set_closed
- مجموعة الجلسة المشاركين [ user ، plugin ]:
  - session:set_participants
- يذكر مجموعة الجلسة [ user ، plugin ]:
  - session:set_mentions
- توجيه مجموعة الجلسة [ user ، plugin ]:
  - session:set_routing
- تعيين جلسة البريد الوارد [ user ، plugin ]:
  - session:set_inbox
- تمت إزالة الجلسة [ user ، plugin ]:
  - session:removed
أحداث الرسائل : مرجع
- تحديث الرسالة [ user ، plugin ]:
  - message:updated
- إرسال الرسالة [ user ، plugin ]:
  - message:send
- تم استلام الرسالة [ user ، plugin ]:
  - message:received
- تمت إزالة الرسالة [ user ، plugin ]:
  - message:removed
- رسالة تأليف إرسال [ user ، plugin ]:
  - message:compose:send
- تشكيل الرسالة تلقي [ user ، plugin ]:
  - message:compose:receive
- إقرار الرسالة قراءة إرسال [ user ، plugin ]:
  - message:acknowledge:read:send
- رسالة إقرار القراءة القراءة [ user ، plugin ]:
  - message:acknowledge:read:received
- إقرار الرسالة التي يتم تسليمها [ user ، plugin ]:
  - message:acknowledge:delivered
- رسالة إخطار الإرسال غير المقروء [ user ، plugin ]:
  - message:notify:unread:send
- رسالة إبلاغ غير مقروء [ user ، plugin ]:
  - message:notify:unread:received
أحداث البريد العشوائي : مرجع
- رسالة البريد العشوائي [ user ]:
  - spam:message
- قرار البريد العشوائي [ user ]:
  - spam:decision
أحداث الناس : مرجع
- تم إنشاء ملف تعريف الأشخاص [ user ، plugin ]:
  - people:profile:created
- تم تحديث ملف تعريف الأشخاص [ user ، plugin ]:
  - people:profile:updated
- تمت إزالة ملف تعريف الأشخاص [ user ، plugin ]:
  - people:profile:removed
- يربط الأشخاص جلسة [ user ، plugin ]:
  - people:bind:session
- ملف تعريف الأشخاص [ user ، plugin ]:
  - people:sync:profile
- الناس يستوردون التقدم [ user ]:
  - people:import:progress
- استيراد الأشخاص المنجزون [ user ]:
  - people:import:done
أحداث الحملة : مرجع
- تقدم الحملة [ user ]:
  - campaign:progress
- تم إرسال الحملة [ user ]:
  - campaign:dispatched
- تشغيل الحملة [ user ]:
  - campaign:running
أحداث التصفح : مرجع
- بدأ طلب التصفح [ user ، plugin ]:
  - browsing:request:initiated
- تم رفض طلب التصفح [ user ، plugin ]:
  - browsing:request:rejected
أحداث الاتصال : المرجع
- بدأ طلب المكالمات [ user ، plugin ]:
  - call:request:initiated
- تم رفض طلب المكالمات [ user ، plugin ]:
  - call:request:rejected
أحداث القطعة : مرجع
- تم معالجة إجراء عنصر واجهة المستخدم [ user ]:
  - widget:action:processed
أحداث الحالة : المرجع
- تم تغيير صحة الحالة [ user ]:
  - status:health:changed
أحداث الموقع : مرجع
- عدد زوار تحديث الموقع [ user ، plugin ]:
  - website:update_visitors_count
- توافر مشغلات تحديث الموقع [ user ، plugin ]:
  - website:update_operators_availability
- مستخدمو الموقع المتاحون [ user ، plugin ]:
  - website:users:available
أحداث دلو : مرجع
- تم إنشاء تحميل URL لدلو [ user ، plugin ]:
  - bucket:url:upload:generated
- تم إنشاء Avatar url عن URL [ user ، plugin ]:
  - bucket:url:avatar:generated
- تم إنشاء موقع URL عن عنوان URL [ user ، plugin ]:
  - bucket:url:website:generated
- تم إنشاء حملة عنوان URL لدلو [ user ، plugin ]:
  - bucket:url:campaign:generated
- تم إنشاؤه في Bucket URL Helpdesk [ user ، plugin ]:
  - bucket:url:helpdesk:generated
- تم إنشاء حالة عنوان URL لدلو [ user ، plugin ]:
  - bucket:url:status:generated
- معالجة عنوان URL لبروفة تم إنشاؤها [ user ، plugin ]:
  - bucket:url:processing:generated
الأحداث الإعلامية : مرجع
- الرسوم المتحركة الوسائط المدرجة [ user ]:
  - media:animation:listed
أحداث البريد الإلكتروني : مرجع
- اشتراك البريد الإلكتروني [ user ، plugin ]:
  - email:subscribe
- عرض مسار البريد الإلكتروني [ user ، plugin ]:
  - email:track:view
أحداث البرنامج المساعد : مرجع
- قناة البرنامج المساعد [ user ، plugin ]:
  - plugin:channel
- حدث البرنامج المساعد [ user ، plugin ]:
  - plugin:event
- تم حفظ إعدادات البرنامج المساعد [ user ، plugin ]:
  - plugin:settings:saved

يوسع

node crisp api

غلاف واجهة برمجة تطبيقات هش

تثبيت

المصادقة

ملخص

أمثلة

إنشاء الروبوت الخاص بك!

طرق الموارد

موقع إلكتروني

محادثات الموقع

محادثة الموقع

موقع الويب (هؤلاء هم المستخدمون النهائيون)

موقع مساعدة الموقع

قاعدة الموقع

إعدادات الموقع

مشغل الموقع

زوار الموقع

توافر الموقع

تحليلات الموقع

دفعة الموقع

التحقق من الموقع

حملات الموقع

حملة الموقع

البرنامج المساعد

Connect Connect

اشتراك البرنامج المساعد

وسائط

الرسوم المتحركة الإعلامية

دلو

عنوان URL دلو

أحداث الوقت الحقيقي

تلقي أحداث الوقت الحقيقي

تلقي الأحداث عبر خطافات الويب

تلقي الأحداث عبر WebSockets (RTM API)

أحداث الوقت الحقيقي المتاحة

أحداث الجلسة : مرجع

أحداث الرسائل : مرجع

أحداث البريد العشوائي : مرجع

أحداث الناس : مرجع

أحداث الحملة : مرجع

أحداث التصفح : مرجع

أحداث الاتصال : المرجع

أحداث القطعة : مرجع

أحداث الحالة : المرجع

أحداث الموقع : مرجع

أحداث دلو : مرجع

الأحداث الإعلامية : مرجع

أحداث البريد الإلكتروني : مرجع

أحداث البرنامج المساعد : مرجع