node crisp api Download - node crisp api Quellcode Download

Knusprige API -Wrapper

Die knusprige API -Knotenwrapper. Authentifizieren, senden Sie Nachrichten, holen Sie Konversationen und greifen Sie auf Ihre Agentenkonten aus Ihrem JavaScript -Code zu.

Geräte : REST -API -Referenz (v1) bei Revision: 17/10/2024
? Betreuer : @baptistejamin, @eliottvincent, @valeriansaliou

Installation

npm install --save crisp-api

Authentifizierung

Um sich mit der API zu authentifizieren, erhalten Sie Ihre Authentifizierungs -Token -Tastatur, indem Sie dem REST -API -Authentifizierungshandbuch folgen. Sie erhalten einen Token -Tastatur aus 2 Werten.

Halten Sie Ihre Token-Tastaturwerte privat und bewahren Sie sie sicher für den langfristigen Gebrauch auf.

Fügen Sie dann Ihre client -Instanz direkt nach dem Erstellen der Authentifizierungsparameter hinzu:

 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.

Überblick

Sie können dem REST -API QuickStart -Handbuch folgen, mit dem Sie in wenigen Minuten mit der Rest -API laufen können.

 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 ) ;
  } ) ;

Beispiele

Erstellen Sie Ihren eigenen Bot!

 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 ) ;
  } ) ;

Ressourcenmethoden

Alle verfügbaren Crisp API -Ressourcen sind vollständig implementiert. Programmatische Methodennamen werden nach ihrem Labelnamen in der REST -API -Referenz benannt .

Alle Methoden, die Sie beim Erstellen einer knusprigen Integration höchstwahrscheinlich benötigen, werden mit einem Sternsymbol () vorangestellt.

Euen Beachten Sie, dass Sie abhängig von Ihrer Authentifizierungs -Token -Stufe, bei der es sich entweder um user oder plugin handelt, nicht alle Methoden aus der Bibliothek verwenden dürfen. Im Zweifelsfall finden Sie in den folgenden Beschreibungen der Bibliotheksmethoden. Höchstwahrscheinlich verwenden Sie ein plugin -Token.

Webseite

Website -Gespräche
Website -Konversation
Website -Leute
Website Helpdesk
Website -Betreiber
Verfügbarkeit von Website
Website -Analyse
Website -Stapel
Website überprüfen
Website -Kampagnen
Website -Kampagne

Plugin

Plugin Connect
Plugin -Abonnement

Medien

Medienanimation

Eimer

Eimer -URL

RTM -Ereignisse

Sitzungsereignisse
Nachrichtenereignisse
People -Ereignisse
Kampagnenereignisse
Durchsuchen von Ereignissen
Rufen Sie Ereignisse an
Widget -Ereignisse
Statusereignisse
Website -Veranstaltungen
Eimer -Events
Medienereignisse
E -Mail -Ereignisse
Plugin -Events

Webseite

Website -Gespräche

Listen Sie Konversationen auf [ user , plugin ]: Referenz

CrispClient.website.listConversations(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listConversations ( websiteID , pageNumber ) ;

Liste Vorgeschlagene Konversationsegmente [ user , plugin ]: Referenz

CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listSuggestedConversationSegments ( websiteID , pageNumber ) ;

Löschen Sie das vorgeschlagene Konversationsegment [ user , plugin ]: Referenz

CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)

Siehe Beispiel

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

var segment = "bug" ;

CrispClient . website . deleteSuggestedConversationSegment ( websiteID , segment ) ;

Liste Vorgeschlagene Konversationsdatenschlüssel [ user , plugin ]: Referenz

CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listSuggestedConversationDataKeys ( websiteID , pageNumber ) ;

Löschen Sie den vorgeschlagenen Gesprächsdatenschlüssel [ user , plugin ]: Referenz

CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)

Siehe Beispiel

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

var key = "price" ;

CrispClient . website . deleteSuggestedConversationDataKey ( websiteID , key ) ;

Listen Sie Spam -Konversationen auf [ user ]: Referenz

CrispClient.website.listSpamConversations(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listSpamConversations ( websiteID , pageNumber ) ;

Spam -Konversationsinhalt auflösen [ user ]: Referenz

CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

Siehe Beispiel

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

CrispClient . website . resolveSpamConversationContent ( websiteID , spamID ) ;

Senden Sie die Spam -Konversationsentscheidung [ user ]: Referenz

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

Siehe Beispiel

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

var action = "reject" ;

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

Website -Konversation

Erstellen Sie eine neue Konversation [ user , plugin ]: Referenz

CrispClient.website.createNewConversation(websiteID)

Siehe Beispiel

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

CrispClient . website . createNewConversation ( websiteID ) ;

Überprüfen Sie, ob eine Konversation vorliegt [ user , plugin ]: Referenz

CrispClient.website.checkConversationExists(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . checkConversationExists ( websiteID , sessionID ) ;

Holen Sie sich eine Konversation [ user , plugin ]: Referenz

CrispClient.website.getConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getConversation ( websiteID , sessionID ) ;

Entfernen Sie eine Konversation [ user , plugin ]: Referenz

CrispClient.website.removeConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . removeConversation ( websiteID , sessionID ) ;

Initiieren Sie eine Konversation mit vorhandener Sitzung [ user , plugin ]: Referenz

CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . initiateConversationWithExistingSession ( websiteID , sessionID ) ;

Meldungen in Conversation [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Senden Sie eine Nachricht in der Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Holen Sie sich eine Nachricht in der Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Aktualisieren Sie eine Nachricht in der Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Entfernen Sie eine Nachricht in der Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Verfassen Sie eine Nachricht in der Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Markieren Sie Nachrichten wie in Conversation [ user , plugin ]: Referenz: Referenz

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

Siehe Beispiel

 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 ) ;

Markieren Sie Nachrichten wie in Conversation [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Update Conversation Open Status [ user , plugin ]: Referenz

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

Siehe Beispiel

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

var opened = true ;

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

Holen Sie sich Conversation Routing zuweisen [ user , plugin ]: Referenz

CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getConversationRoutingAssign ( websiteID , sessionID ) ;

Konversationsrouting zuweisen [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie den Konversationseingang [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Holen Sie sich Gesprächsmetas [ user , plugin ]: Referenz

CrispClient.website.getConversationMetas(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getConversationMetas ( websiteID , sessionID ) ;

Aktualisieren Sie Konversationsmetas [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Erhalten Sie eine Originalnachricht in der Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Listen Sie Gesprächsseiten [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Listen Sie Gesprächsereignisse [ user , plugin ]: Referenz: Referenz

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

Siehe Beispiel

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

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

Listen Sie Konversationsdateien auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Holen Sie sich den Gesprächsstatus [ user , plugin ]: Referenz

CrispClient.website.getConversationState(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getConversationState ( websiteID , sessionID ) ;

Gesprächszustand ändern [ user , plugin ]: Referenz

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

Siehe Beispiel

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

var state = "unresolved" ;

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

Holen Sie sich Gesprächsteilnehmer [ user , plugin ]: Referenz

CrispClient.website.getConversationParticipants(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getConversationParticipants ( websiteID , sessionID ) ;

Konversationsteilnehmer speichern [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Holen Sie sich den Blockstatus für die Konversation [ user , plugin ]: Referenz

CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getBlockStatusForConversation ( websiteID , sessionID ) ;

Blockanweisungen zur Konversation blockieren [ user , plugin ]: Referenz

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

Siehe Beispiel

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

var blocked = true ;

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

Erhalten Sie den Status für Konversation [ user , plugin ]: Referenz: Referenz

CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getVerifyStatusForConversation ( websiteID , sessionID ) ;

Aktualisieren Sie den Status für die Konversation [ user , plugin ]: Referenz: Referenz

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

Siehe Beispiel

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

var verified = true ;

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

E -Mail -Transkript für Konversation [ user , plugin ]: Referenz: Referenz

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

Siehe Beispiel

 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 ) ;

Anfrage Chatbox -Bindungsrein für Konversation [ user , plugin ]: Referenz

CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . requestChatboxBindingPurgeForConversation ( websiteID , sessionID ) ;

Benutzerfedback für Konversation anfordern [ user , plugin ]: Referenz

CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . requestUserFeedbackForConversation ( websiteID , sessionID ) ;

Listenbrowsing -Sitzungen für Konversation [ user , plugin ]: Referenz

CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . listBrowsingSessionsForConversation ( websiteID , sessionID ) ;

Initiieren Sie die Browsersitzung für Konversation [ user , plugin ]: Referenz

CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . initiateBrowsingSessionForConversation ( websiteID , sessionID ) ;

Aktion an eine vorhandene Browsersitzung [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Unterstützung vorhandener Browsersitzungen [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Initiieren Sie eine neue Call -Sitzung für Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

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

var mode = "audio" ;

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

Holen Sie sich eine laufende Anrufsitzung für Konversation [ user , plugin ]: Referenz

CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

Siehe Beispiel

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

CrispClient . website . getOngoingCallSessionForConversation ( websiteID , sessionID ) ;

Laufende Anrufsitzung für Konversation [ user , plugin ]: Referenz: Referenz

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

Siehe Beispiel

 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 ) ;

Signalisierung der Signalübertragung auf laufender Anrufsitzung [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Liefern Sie die Widget -Schaltfläche Aktion [ user ]: Referenz: Referenz

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

Siehe Beispiel

 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 ) ;

Liefern Sie Widget Data Abrufenaktionen für Konversation [ user ]: Referenz

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

Siehe Beispiel

 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 ) ;

Liefern Sie Widget -Datenbearbeitungsaktionen für Konversation [ user ]: Referenz: Referenz

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

Siehe Beispiel

 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 ) ;

Planen Sie eine Erinnerung für die Konversation [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Website-Leute (das sind Ihre Endbenutzer)

Get People Statistics [ user , plugin ]: Referenz

CrispClient.website.getPeopleStatistics(websiteID)

Siehe Beispiel

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

CrispClient . website . getPeopleStatistics ( websiteID ) ;

LISTED SEPPT PEOT -SEGMENTEN [ user , plugin ]: Referenz

CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listSuggestedPeopleSegments ( websiteID , pageNumber ) ;

Löschen Sie das vorgeschlagene Personensegment [ user , plugin ]: Referenz

CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

Siehe Beispiel

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

var segment = "poweruser" ;

CrispClient . website . deleteSuggestedPeopleSegment ( websiteID , segment ) ;

LISTED PEOD -Datenschlüssel [ user , plugin ]: Referenz: Referenz

CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listSuggestedPeopleDataKeys ( websiteID , pageNumber ) ;

Löschen Sie den vorgeschlagenen Personendatenschlüssel [ user , plugin ]: Referenz

CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)

Siehe Beispiel

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

var key = "price" ;

CrispClient . website . deleteSuggestedPeopleDataKey ( websiteID , key ) ;

LISTED SURE PEOTER EREIGNISSE [ user , plugin ]: Referenz

CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listSuggestedPeopleEvents ( websiteID , pageNumber ) ;

Löschen Sie das vorgeschlagene Personenereignis [ user , plugin ]: Referenz: Referenz

CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

Siehe Beispiel

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

var text = "Removed item from basket" ;

CrispClient . website . deleteSuggestedPeopleEvent ( websiteID , text ) ;

Listen Sie Personenprofile auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Fügen Sie ein neues Personalprofil hinzu [ user , plugin ]: Referenz

CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

Siehe Beispiel

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

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

CrispClient . website . addNewPeopleProfile ( websiteID , peopleProfile ) ;

Überprüfen Sie, ob das Peop -Profil vorhanden ist [ user , plugin ]: Referenz

CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

Siehe Beispiel

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

CrispClient . website . checkPeopleProfileExists ( websiteID , peopleID ) ;

Get People Profile [ user , plugin ]: Referenz

CrispClient.website.getPeopleProfile(websiteID, peopleID)

Siehe Beispiel

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

CrispClient . website . getPeopleProfile ( websiteID , peopleID ) ;

Speichern Sie das People -Profil [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie das People -Profil [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Entfernen Sie das People -Profil [ user , plugin ]: Referenz

CrispClient.website.removePeopleProfile(websiteID, peopleID)

Siehe Beispiel

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

CrispClient . website . removePeopleProfile ( websiteID , peopleID ) ;

Listen Sie Personengespräche auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Listen Sie Personenkampagnen auf [ user ]: Referenz

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

Siehe Beispiel

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

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

Fügen Sie ein People -Ereignis hinzu [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Listen Sie Personenereignisse auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

People Data erhalten [ user , plugin ]: Referenz

CrispClient.website.getPeopleData(websiteID, peopleID)

Siehe Beispiel

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

CrispClient . website . getPeopleData ( websiteID , peopleID ) ;

Speichern Sie Personendaten [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie Personendaten [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Holen Sie sich den Status des People -Abonnements [ user , plugin ]: Referenz

CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

Siehe Beispiel

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

CrispClient . website . getPeopleSubscriptionStatus ( websiteID , peopleID ) ;

Aktualisieren Sie den Status des People -Abonnements [ user , plugin ]: Referenz

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

Siehe Beispiel

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

var peopleSubscription = {
  "email" : true
} ;

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

Exportieren Sie Personenprofile [ user ]: Referenz

CrispClient.website.exportPeopleProfiles(websiteID)

Siehe Beispiel

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

CrispClient . website . exportPeopleProfiles ( websiteID ) ;

Personenprofile importieren [ user ]: Referenz

CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

Siehe Beispiel

 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 ) ;

Hinweis: Das peopleID -Argument kann eine E -Mail oder die peopleID sein.

Website Helpdesk

Überprüfen Sie, ob Helpdesk existiert [ user , plugin ]: Referenz

CrispClient.website.checkHelpdeskExists(websiteID)

Siehe Beispiel

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

CrispClient . website . checkHelpdeskExists ( websiteID ) ;

Lösen Sie Helpdesk [ user , plugin ]: Referenz: Referenz

CrispClient.website.resolveHelpdesk(websiteID)

Siehe Beispiel

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

CrispClient . website . resolveHelpdesk ( websiteID ) ;

Initialisieren Sie Helpdesk [ user ]: Referenz

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

Siehe Beispiel

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

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

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

Helpdesk [ user ] löschen: Referenz

CrispClient.website.deleteHelpdesk(websiteID, verify)

Siehe Beispiel

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

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

CrispClient . website . deleteHelpdesk ( websiteID , verify ) ;

Listen Sie Helpdesk -Orte auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

Fügen Sie Helpdesk Locale [ user , plugin ]: Referenz hinzu

CrispClient.website.addHelpdeskLocale(websiteID, locale)

Siehe Beispiel

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

var locale = "en" ;

CrispClient . website . addHelpdeskLocale ( websiteID , locale ) ;

Überprüfen Sie, ob das Helpdesk -Gebietsschema vorhanden ist [ user , plugin ]: Referenz

CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)

Siehe Beispiel

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

var locale = "en" ;

CrispClient . website . checkHelpdeskLocaleExists ( websiteID , locale ) ;

Helpdesk Locale auflösen [ user , plugin ]: Referenz

CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

Siehe Beispiel

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

var locale = "en" ;

CrispClient . website . resolveHelpdeskLocale ( websiteID , locale ) ;

Löschen Sie Helpdesk Locale [ user , plugin ]: Referenz

CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

Siehe Beispiel

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

var locale = "en" ;

CrispClient . website . deleteHelpdeskLocale ( websiteID , locale ) ;

Listen Sie Helpdesk -Gebietsschalenartikel auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Fügen Sie einen neuen Helpdesk -Gebietsschema -Artikel hinzu [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Überprüfen Sie, ob Helpdesk -Gebietsschale Artikel vorhanden ist [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Helpdesk Locale -Artikel auflösen [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Speichern Sie Helpdesk Locale -Artikel [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie Helpdesk Locale -Artikel [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Löschen Sie Helpdesk Lokale Artikel [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Helpdesk Lokale Artikelseite auflösen [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Helpdesk Locale Article Article Category [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Aktualisieren Sie die Kategorie "Helpdesk Locale Artikel" [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Listen Sie Helpdesk Lokale Artikel Alternativen [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Überprüfen Sie, ob Helpdesk Locale -Artikel Alternative vorhanden ist [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 Lokale Artikel Alternative [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Speichern Sie Helpdesk Lokale Artikel Alternative [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Löschen Sie Helpdesk Lokale Artikel Alternative [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Veröffentlichen Sie Helpdesk Locale -Artikel [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Unpublish Helpdesk Lokale Artikel [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Listen Sie Helpdesk -Gebietskategorien auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Fügen Sie Helpdesk Localen -Kategorie hinzu [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Überprüfen Sie, ob die Kategorie der Helpdesk -Gebietsschale vorhanden ist [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Helpdesk Localen -Kategorie auflösen [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Speichern Sie die Kategorie der Helpdesk -Gebietsschale [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie die Kategorie der Helpdesk -Gebietsschale [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Löschen user plugin

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

Siehe Beispiel

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

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

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

Listen Sie Helpdesk -Gebietsschalenabschnitte auf [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Fügen Sie den Abschnitt Helpdesk Locale hinzu [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Überprüfen Sie, ob der Abschnitt Helpdesk -Gebietsschale vorhanden ist [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Helpdesk Locale Abschnitt [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Speichern Sie den Abschnitt "Helpdesk Locale" [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie den Abschnitt Helpdesk Locale [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Löschen Sie den Abschnitt Helpdesk Locale [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 Feedback -Bewertungen [ user , plugin ]: Referenz

CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)

Siehe Beispiel

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

var locale = "en" ;

CrispClient . website . mapHelpdeskLocaleFeedbackRatings ( websiteID , locale ) ;

Listen Sie Helpdesk Lokale -Feedbacks auf [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Importieren Sie externe Helpdesk in das Gebietsschema [ user ]: Referenz

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

Siehe Beispiel

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

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

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

Exportieren Sie Helpdesk Localen -Artikel [ user ]: Referenz

CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)

Siehe Beispiel

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

var locale = "en" ;

CrispClient . website . exportHelpdeskLocaleArticles ( websiteID , locale ) ;

Listen Sie Helpdesk -Umleitungen auf [ user , plugin ]: Referenz

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

Fügen Sie Helpdesk -Umleitung hinzu [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Überprüfen Sie, ob Helpdesk -Umleitung vorhanden ist [ user , plugin ]: Referenz

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

Siehe Beispiel

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

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

Helpdesk -Umleitung auflösen [ user , plugin ]: Referenz

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

Siehe Beispiel

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

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

Helpdesk -Umleitung löschen [ user , plugin ]: Referenz

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

Siehe Beispiel

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

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

Helpdesk -Einstellungen auflösen [ user , plugin ]: Referenz

CrispClient.website.resolveHelpdeskSettings(websiteID)

Siehe Beispiel

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

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;

Speichern Sie Helpdesk -Einstellungen [ user , plugin ]: Referenz

CrispClient.website.saveHelpdeskSettings(websiteID, settings)

Siehe Beispiel

 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 Domain [ user ] auflösen: Referenz

CrispClient.website.resolveHelpdeskDomain(websiteID)

Siehe Beispiel

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

CrispClient . website . resolveHelpdeskDomain ( websiteID ) ;

Request Helpdesk Domänenänderung [ user ]: Referenz

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

Siehe Beispiel

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

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

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

Generieren Sie Helpdesk Domain Setup Flow [ user ]: Referenz

CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

Siehe Beispiel

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

var custom = "help.valeriansaliou.name" ;

CrispClient . website . generateHelpdeskDomainSetupFlow ( websiteID , custom ) ;

Website -Basis

Überprüfen Sie, ob die Website vorhanden ist [ user , plugin ]: Referenz
- CrispClient.website.checkWebsiteExists(domain)
- Siehe Beispiel
```
 CrispClient . website . checkWebsiteExists ( domain ) ;
```
Website erstellen [ user ]: Referenz
- CrispClient.website.createWebsite(websiteData)
- Siehe Beispiel
```
 CrispClient . website . createWebsite ( websiteData ) ;
```

Holen Sie sich eine Website [ user , plugin ]: Referenz

CrispClient.website.getWebsite(websiteID)

Siehe Beispiel

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

CrispClient . website . getWebsite ( websiteID ) ;

Löschen Sie eine Website [ user ]: Referenz

CrispClient.website.deleteWebsite(websiteID, verify)

Siehe Beispiel

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

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

CrispClient . website . deleteWebsite ( websiteID , verify ) ;

Löschung der Website ( user ]: Referenz: Referenz

CrispClient.website.abortWebsiteDeletion(websiteID)

Siehe Beispiel

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

CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

Website -Einstellungen

Holen Sie sich Website -Einstellungen [ user , plugin ]: Referenz: Referenz
- CrispClient.website.getWebsiteSettings(websiteID)
- Siehe Beispiel
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

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

Aktualisieren Sie die Website -Einstellungen [ user , plugin ]: Referenz

CrispClient.website.updateWebsiteSettings(websiteID, settings)

Siehe Beispiel

 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 ) ;

Website -Betreiber

Listen Sie Website -Betreiber [ user , plugin ]: Referenz

CrispClient.website.listWebsiteOperators(websiteID)

Siehe Beispiel

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

CrispClient . website . listWebsiteOperators ( websiteID ) ;

LISTE LETZTE Active -Website -Betreiber [ user , plugin ]: Referenz

CrispClient.website.listLastActiveWebsiteOperators(websiteID)

Siehe Beispiel

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

CrispClient . website . listLastActiveWebsiteOperators ( websiteID ) ;

Flush Last Active Website -Betreiber [ user ]: Referenz

CrispClient.website.flushLastActiveWebsiteOperators(websiteID)

Siehe Beispiel

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

CrispClient . website . flushLastActiveWebsiteOperators ( websiteID ) ;

Senden Sie E -Mail an Website -Betreiber [ user , plugin ]: Referenz

CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

Siehe Beispiel

 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 ) ;

Holen Sie sich einen Website -Operator [ user , plugin ]: Referenz

CrispClient.website.getWebsiteOperator(websiteID, userID)

Siehe Beispiel

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

CrispClient . website . getWebsiteOperator ( websiteID , userID ) ;

Laden Sie einen Website -Betreiber [ user ] ein: Referenz

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

Siehe Beispiel

 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 ) ;

Änderung der Bedienermitgliedschaft [ user ]: Referenz

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

Siehe Beispiel

 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 ) ;

UNTERLINK -Operator von der Website [ user ]: Referenz: Referenz

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

Siehe Beispiel

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

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

Website -Besucher

Besucher zählen [ user , plugin ]: Referenz

CrispClient.website.countVisitors(websiteID)

Siehe Beispiel

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

CrispClient . website . countVisitors ( websiteID ) ;

Listen Sie Besucher auf [ user , plugin ]: Referenz

CrispClient.website.listVisitors(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listVisitors ( websiteID , pageNumber ) ;

Bestimmen Sie Besucher auf einer Karte [ user , plugin ]: Referenz

CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)

Siehe Beispiel

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

CrispClient . website . pinpointVisitorsOnMap ( websiteID , centerLongitude , centerLatitude , centerRadius ) ;

Holen Sie sich die Sitzungskennung von Token [ user , plugin ]: Referenz

CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)

Siehe Beispiel

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904" ;

CrispClient . website . getSessionIdentifierFromToken ( websiteID , tokenID ) ;

Blockierte Besucher [ user ]: Referenz: Referenz
- CrispClient.website.countBlockedVisitors(websiteID)

Blockierte blockierte Besucher in Regel [ user ]: Referenz

CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)

Siehe Beispiel

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

CrispClient . website . countBlockedVisitorsInRule ( websiteID , rule ) ;

Löschen blockierter Besucher in Regel [ user ]: Referenz

CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)

Siehe Beispiel

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

CrispClient . website . clearBlockedVisitorsInRule ( websiteID , rule ) ;

Verfügbarkeit von Website
- Holen Sie sich den Status der Website -Verfügbarkeit [ user , plugin ]: Referenz: Referenz
  - CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
  - Siehe Beispiel
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;
- Listen Sie die Verfügbarkeit von Website -Betreibern auf [ user , plugin ]: Referenz
  - CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
  - Siehe Beispiel
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;

Website -Analyse

Generieren Sie Analytics [ user ]: Referenz

CrispClient.website.generateAnalytics(websiteID, query)

Siehe Beispiel

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

CrispClient . website . generateAnalytics ( websiteID , query ) ;

Website -Stapel

Batch -Resolve -Konversationen [ user ]: Referenz

CrispClient.website.batchResolveConversations(websiteID, operation)

Siehe Beispiel

 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 ) ;

Batch -Lesen Konversationen [ user ]: Referenz

CrispClient.website.batchReadConversations(websiteID, operation)

Siehe Beispiel

 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 ) ;

Batch entfernen Konversationen [ user ]: Referenz

CrispClient.website.batchRemoveConversations(websiteID, operation)

Siehe Beispiel

 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 ) ;

Batch -Personen entfernen [ user ]: Referenz

CrispClient.website.batchRemovePeople(websiteID, people)

Siehe Beispiel

 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 ) ;

Website überprüfen

Einstellungen abrufen [ user , plugin ]: Referenz

CrispClient.website.getVerifySettings(websiteID)

Siehe Beispiel

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

CrispClient . website . getVerifySettings ( websiteID ) ;

Aktualisieren Sie Einstellungen [ user , plugin ]: Referenz

CrispClient.website.updateVerifySettings(websiteID, settings)

Siehe Beispiel

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

var settings = {
  "enabled" : true
} ;

CrispClient . website . updateVerifySettings ( websiteID , settings ) ;

Teilen Sie den Schlüssel verifizieren [ user , plugin ]: Referenz

CrispClient.website.getVerifyKey(websiteID)

Siehe Beispiel

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

CrispClient . website . getVerifyKey ( websiteID ) ;

Roll -Überprüfung der Taste [ user , plugin ]: Referenz

CrispClient.website.rollVerifyKey(websiteID)

Siehe Beispiel

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

CrispClient . website . rollVerifyKey ( websiteID ) ;

Website -Kampagnen

Listenkampagnen [ user ]: Referenz

CrispClient.website.listCampaigns(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listCampaigns ( websiteID , pageNumber ) ;

Listenkampagnen -Tags [ user ]: Referenz

CrispClient.website.listCampaignTags(websiteID)

Siehe Beispiel

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

CrispClient . website . listCampaignTags ( websiteID ) ;

Kampagnenvorlagen auflisten [ user , plugin ]: Referenz

CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

Siehe Beispiel

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

CrispClient . website . listCampaignTemplates ( websiteID , pageNumber ) ;

Erstellen Sie eine neue Kampagnenvorlage [ user , plugin ]: Referenz

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

Siehe Beispiel

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

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

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

Überprüfen Sie, ob die Kampagnenvorlage vorhanden ist [ user , plugin ]: Referenz

CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

Siehe Beispiel

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

CrispClient . website . checkCampaignTemplateExists ( websiteID , templateID ) ;

Holen Sie sich eine Kampagnenvorlage [ user , plugin ]: Referenz

CrispClient.website.getCampaignTemplate(websiteID, templateID)

Siehe Beispiel

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

CrispClient . website . getCampaignTemplate ( websiteID , templateID ) ;

Speichern Sie eine Kampagnenvorlage [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie eine Kampagnenvorlage [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Entfernen Sie eine Kampagnenvorlage [ user , plugin ]: Referenz

CrispClient.website.removeCampaignTemplate(websiteID, templateID)

Siehe Beispiel

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

CrispClient . website . removeCampaignTemplate ( websiteID , templateID ) ;

Website -Kampagne

Erstellen Sie eine neue Kampagne [ user ]: Referenz

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

Siehe Beispiel

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

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

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

Überprüfen Sie, ob die Kampagne vorliegt [ user ]: Referenz

CrispClient.website.checkCampaignExists(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . checkCampaignExists ( websiteID , campaignID ) ;

Holen Sie sich eine Kampagne [ user ]: Referenz

CrispClient.website.getCampaign(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . getCampaign ( websiteID , campaignID ) ;

Speichern Sie eine Kampagne [ user ]: Referenz

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

Siehe Beispiel

 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 ) ;

Aktualisieren Sie eine Kampagne [ user ]: Referenz

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

Siehe Beispiel

 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 ) ;

Entfernen Sie eine Kampagne [ user ]: Referenz

CrispClient.website.removeCampaign(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . removeCampaign ( websiteID , campaignID ) ;

Entsenden Sie eine Kampagne [ user ]: Referenz

CrispClient.website.dispatchCampaign(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . dispatchCampaign ( websiteID , campaignID ) ;

Nehmen Sie eine Kampagne [ user ] wieder auf: Referenz

CrispClient.website.resumeCampaign(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . resumeCampaign ( websiteID , campaignID ) ;

Pause eine Kampagne [ user ]: Referenz

CrispClient.website.pauseCampaign(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . pauseCampaign ( websiteID , campaignID ) ;

Testen Sie eine Kampagne [ user ]: Referenz

CrispClient.website.testCampaign(websiteID, campaignID)

Siehe Beispiel

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

CrispClient . website . testCampaign ( websiteID , campaignID ) ;

Kampagnenempfänger [ user ]: Referenz

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

Siehe Beispiel

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

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

Listenkampagnenstatistiken [ user ]: Referenz

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

Siehe Beispiel

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

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

Plugin

Plugin Connect
- Abrufen von Connect -Konto [ plugin ]: Referenz
  - CrispClient.plugin.getConnectAccount()
  - Siehe Beispiel
    CrispClient . plugin . getConnectAccount ( ) ;
- Überprüfen Sie die Gültigkeit der Sitzung ( plugin ]: Referenz: Referenz
  - CrispClient.plugin.checkConnectSessionValidity()
  - Siehe Beispiel
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- Listen Sie alle Verbindungswebsites [ plugin ] auf: Referenz
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - Siehe Beispiel
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- Listen Sie Websites an, die Websites verbinden, da [ plugin ]: Referenz
  - CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
  - Siehe Beispiel
    var dateSince = "2023-08-16T09:00:00Z" ; CrispClient . plugin . listConnectWebsitesSince ( dateSince , filterConfigured ) ;
- Nutzen Sie die Endpunkte von Connect -Endpunkten [ plugin ]: Referenz
  - CrispClient.plugin.getConnectEndpoints()
  - Siehe Beispiel
    CrispClient . plugin . getConnectEndpoints ( ) ;

Plugin -Abonnement

Listen Sie alle aktiven Abonnements [ user ] auf: Referenz
- CrispClient.plugin.listAllActiveSubscriptions()
- Siehe Beispiel
```
 CrispClient . plugin . listAllActiveSubscriptions ( ) ;
```

Listen Sie Abonnements für eine Website [ user ] auf: Referenz

CrispClient.plugin.listSubscriptionsForWebsite(websiteID)

Siehe Beispiel

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

CrispClient . plugin . listSubscriptionsForWebsite ( websiteID ) ;

Abonnementdetails erhalten [ user , plugin ]: Referenz

CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

Siehe Beispiel

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

CrispClient . plugin . getSubscriptionDetails ( websiteID , pluginID ) ;

Abonnieren Sie die Website mit Plugin [ user ]: Referenz

CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

Siehe Beispiel

 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 ) ;

Abmelden -Plugin von der Website [ user ]: Referenz: Referenz

CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

Siehe Beispiel

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

CrispClient . plugin . unsubscribePluginFromWebsite ( websiteID , pluginID ) ;

Abonnementeinstellungen erhalten [ user , plugin ]: Referenz

CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

Siehe Beispiel

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

CrispClient . plugin . getSubscriptionSettings ( websiteID , pluginID ) ;

Speichern Sie Abonnementeinstellungen [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Abonnementeinstellungen aktualisieren [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Holen Sie sich Plugin -Verwendungsrechnungen [ user , plugin ]: Referenz

CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

Siehe Beispiel

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

CrispClient . plugin . getPluginUsageBills ( websiteID , pluginID ) ;

Melden Sie Plugin -Nutzung für Bill [ plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Weiterleiten Plugin -Nutzlast in Channel [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Versand -Plugin -Ereignis [ user , plugin ]: Referenz

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

Siehe Beispiel

 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 ) ;

Medien

Medienanimation

Listen Sie Animationsmedien auf [ user ]: Referenz

CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)

Siehe Beispiel

 var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3" ;
var pageNumber = 1 ;

CrispClient . media . listAnimationMedias ( pageNumber , listID , searchQuery ) ;

Eimer

Eimer -URL
- Generieren Sie die URL von Bucket [ user , plugin ]: Referenz
  - CrispClient.bucket.generateBucketURL(data)
  - Siehe Beispiel
    CrispClient . bucket . generateBucketURL ( data ) ;

Echtzeitveranstaltungen

Sie können von CRISP an Echtzeit -Ereignisse binden, um über eingehende Nachrichten und Updates auf Websites informiert zu werden.

Sie werden keine Veranstaltung erhalten, wenn Sie keine Echtzeitveranstaltungen explizit abonnieren, da die Bibliothek nicht automatisch mit dem Echtzeit -Backend verbunden ist.

Es gibt zwei Möglichkeiten, Echtzeitveranstaltungen zu erhalten:

Verwenden von Webhaken ( empfohlen )
Verwenden von Websockets mit der RTM -API

Bevor Sie mit RTM -Ereignissen beginnen, sollten Sie Folgendes in Betracht ziehen:

Sie werden keine Veranstaltung erhalten, wenn Sie mit CrispClient.on() keine explizit Echtzeitveranstaltungen abonnieren, da die Bibliothek nicht automatisch mit dem Echtzeit -Backend verbunden ist. Diese Methode gibt ein Promise zurück.
Immer wenn die Liste der Websites, die Ihr Authentifizierungs -Token hat, berechtigt ist, Ereignisse für Änderungen zu erhalten, müssen Sie CrispClient.rebindSocket() nennen. Diese Methode gibt auch ein Promise zurück. Dies gilt nur für Websockets mit der RTM -API .

Erhalten Sie Echtzeitveranstaltungen

Erhalten Sie Veranstaltungen über Webhaken

Um nach Ereignissen zu hören und einen Handler zu binden, lesen Sie die Ereignisse über Web Hooks -Beispiele.

Sie müssen Ihren Code so anpassen, dass:

Der RTM -Ereignismodus ist auf Web Hooks eingestellt: CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
Ihr HTTP -Endpunkt montiert eine Route, die nach Postanfragen und nach Empfang von Anfragen:
1. Es überprüft die Anfragen mit: CrispClient.verifyHook(secret, body, timestamp, signature)
2. Es empfängt den Webhaken mit: CrispClient.receiveHook(body)

Plugin -Webhaken müssen zuerst konfiguriert werden, damit dies funktioniert. Schauen Sie sich unseren Web Hooks QuickStart Guide und unsere Web Hooks Referenz an, um loszulegen.

Erhalten Sie Ereignisse über Websockets (RTM -API)

Um nach Ereignissen zu hören und einen Handler zu binden, lesen Sie die Ereignisse über WebSockets -Beispiel.

Sie müssen Ihren Code so anpassen, dass:

Der RTM -Ereignismodus ist auf WebSockets gesetzt: CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

Verfügbare Echtzeitveranstaltungen

Verfügbare Ereignisse sind unten aufgeführt:

Sitzungsereignisse : Referenz
- Verfügbarkeit von Sitzungen Update [ user , plugin ]:
  - session:update_availability
- Session -Update verifizieren [ user , plugin ]:
  - session:update_verify
- Sitzungsanforderung initiiert [ user , plugin ]:
  - session:request:initiated
- Sitzungssatz -E -Mail [ user , plugin ]:
  - session:set_email
- Sitzungssatz Telefon [ user , plugin ]:
  - session:set_phone
- Sitzungssatzadresse [ user , plugin ]:
  - session:set_address
- SESTSET -Betreff [ user , plugin ]:
  - session:set_subject
- Sitzungssatz Avatar [ user , plugin ]:
  - session:set_avatar
- Sitzungssatz -Spitzname [ user , plugin ]:
  - session:set_nickname
- Sitzungsdaten [ user , plugin ]:
  - session:set_data
- Sitzungssynchronisierungsseiten [ user , plugin ]:
  - session:sync:pages
- Sitzungssynchronisierungsereignisse [ user , plugin ]:
  - session:sync:events
- Sitzungssynchronisierungsfunktionen [ user , plugin ]:
  - session:sync:capabilities
- Sitzungssynchronisationssynchronisation [ user , plugin ]:
  - session:sync:geolocation
- Sitzungssynchronisierungssystem [ user , plugin ]:
  - session:sync:system
- Sitzungssynchronisierungsnetzwerk [ user , plugin ]:
  - session:sync:network
- Sitzungssynchronisierungssynchronisierungs -Timezone [ user , plugin ]:
  - session:sync:timezone
- Sitzungs -Synchronisierungs Orte [ user , plugin ]:
  - session:sync:locales
- Sitzungssynchronisierungsbewertung [ user , plugin ]:
  - session:sync:rating
- Sitzungssynchronisationsthema [ user , plugin ]:
  - session:sync:topic
- Sitzungsstaat [ user , plugin ]:
  - session:set_state
- Sitzungsset -Block [ user , plugin ]:
  - session:set_block
- Sitzungssetsegmente [ user , plugin ]:
  - session:set_segments
- Sitzungssatz geöffnet [ user , plugin ]:
  - session:set_opened
- Sitzungsset geschlossen [ user , plugin ]:
  - session:set_closed
- Sitzungsset -Teilnehmer [ user , plugin ]:
  - session:set_participants
- Sitzungsset -Erwähnungen [ user , plugin ]:
  - session:set_mentions
- Sitzungsset -Routing [ user , plugin ]:
  - session:set_routing
- Session Set -Posteingang [ user , plugin ]:
  - session:set_inbox
- Sitzung entfernt [ user , plugin ]:
  - session:removed
Nachrichtenereignisse : Referenz
- Nachricht aktualisiert [ user , plugin ]:
  - message:updated
- Nachricht senden [ user , plugin ]:
  - message:send
- Message empfangen [ user , plugin ]:
  - message:received
- Meldung entfernt [ user , plugin ]:
  - message:removed
- Message Compose Senden [ user , plugin ]:
  - message:compose:send
- Message Compose Receme [ user , plugin ]:
  - message:compose:receive
- Message bestätigen lesen Send [ user , plugin ]:
  - message:acknowledge:read:send
- Message Bestätigungen Read empfangen [ user , plugin ]:
  - message:acknowledge:read:received
- Message bestätigen [ user , plugin ]:
  - message:acknowledge:delivered
- Nachricht Benachrichtigen Sie ungelesene Senden [ user , plugin ]:
  - message:notify:unread:send
- Nachricht Benachrichtigung Unread empfangen [ user , plugin ]:
  - message:notify:unread:received
Spam -Ereignisse : Referenz
- Spam -Nachricht [ user ]:
  - spam:message
- Spam -Entscheidung [ user ]:
  - spam:decision
People -Ereignisse : Referenz
- People -Profil erstellt [ user , plugin ]:
  - people:profile:created
- People -Profil aktualisiert [ user , plugin ]:
  - people:profile:updated
- People -Profil entfernt [ user , plugin ]:
  - people:profile:removed
- People Binding Session [ user , plugin ]:
  - people:bind:session
- Personen synchronisieren Profil [ user , plugin ]:
  - people:sync:profile
- Personen importieren den Fortschritt [ user ]:
  - people:import:progress
- Personen importieren [ user ]:
  - people:import:done
Kampagnenereignisse : Referenz
- Kampagnenfortschritt [ user ]:
  - campaign:progress
- Kampagnenversand [ user ]:
  - campaign:dispatched
- Kampagne Ausführen [ user ]:
  - campaign:running
Browsereignisse : Referenz
- Durchbrowseranforderung initiiert [ user , plugin ]:
  - browsing:request:initiated
- Browseranforderung abgelehnt [ user , plugin ]:
  - browsing:request:rejected
Anrufereignisse : Referenz
- Anrufanforderung initiiert [ user , plugin ]:
  - call:request:initiated
- Anrufanforderung abgelehnt [ user , plugin ]:
  - call:request:rejected
Widget -Ereignisse : Referenz
- Widget -Aktion verarbeitet [ user ]:
  - widget:action:processed
Statusereignisse : Referenz
- Status Health geändert [ user ]:
  - status:health:changed
Website -Ereignisse : Referenz
- Website -Update -Besucher zählen [ user , plugin ]:
  - website:update_visitors_count
- Verfügbarkeit von Website -Update -Betreibern [ user , plugin ]:
  - website:update_operators_availability
- Website -Benutzer verfügbar [ user , plugin ]:
  - website:users:available
Eimerereignisse : Referenz
- Bucket URL -Upload generiert [ user , plugin ]:
  - bucket:url:upload:generated
- Eimer URL Avatar generiert [ user , plugin ]:
  - bucket:url:avatar:generated
- Eimer -URL -Website generiert [ user , plugin ]:
  - bucket:url:website:generated
- Erzeugtes Bucket -URL -Kampagne [ user , plugin ]:
  - bucket:url:campaign:generated
- Bucket URL Helpdesk generiert [ user , plugin ]:
  - bucket:url:helpdesk:generated
- Erzeugtes Bucket -URL -Status [ user , plugin ]:
  - bucket:url:status:generated
- Eimer -URL -Verarbeitung generiert [ user , plugin ]:
  - bucket:url:processing:generated
Medienereignisse : Referenz
- Medienanimation aufgelistet [ user ]:
  - media:animation:listed
E -Mail -Ereignisse : Referenz
- E -Mail -Abonnement [ user , plugin ]:
  - email:subscribe
- E -Mail -Track -Ansicht [ user , plugin ]:
  - email:track:view
Plugin -Ereignisse : Referenz
- Plugin -Kanal [ user , plugin ]:
  - plugin:channel
- Plugin -Ereignis [ user , plugin ]:
  - plugin:event
- Gespeicherte Plugin -Einstellungen [ user , plugin ]:
  - plugin:settings:saved

Expandieren

node crisp api

Knusprige API -Wrapper

Installation

Authentifizierung

Überblick

Beispiele

Erstellen Sie Ihren eigenen Bot!

Ressourcenmethoden

Webseite

Website -Gespräche

Website -Konversation

Website-Leute (das sind Ihre Endbenutzer)

Website Helpdesk

Website -Basis

Website -Einstellungen

Website -Betreiber

Website -Besucher

Verfügbarkeit von Website

Website -Analyse

Website -Stapel

Website überprüfen

Website -Kampagnen

Website -Kampagne

Plugin

Plugin Connect

Plugin -Abonnement

Medien

Medienanimation

Eimer

Eimer -URL

Echtzeitveranstaltungen

Erhalten Sie Echtzeitveranstaltungen

Erhalten Sie Veranstaltungen über Webhaken

Erhalten Sie Ereignisse über Websockets (RTM -API)

Verfügbare Echtzeitveranstaltungen

Sitzungsereignisse : Referenz

Nachrichtenereignisse : Referenz

Spam -Ereignisse : Referenz

People -Ereignisse : Referenz

Kampagnenereignisse : Referenz

Browsereignisse : Referenz

Anrufereignisse : Referenz

Widget -Ereignisse : Referenz

Statusereignisse : Referenz

Website -Ereignisse : Referenz

Eimerereignisse : Referenz

Medienereignisse : Referenz

E -Mail -Ereignisse : Referenz

Plugin -Ereignisse : Referenz