node crisp api Télécharger - node crisp api Code source Télécharger

Emballage de l'API croustillant

L'emballage croustillant du nœud API. Authentifiez, envoyez des messages, récupérez les conversations, accédez à vos comptes d'agent à partir de votre code JavaScript.

Implementations : Référence de l'API REST (V1) à révision: 17/10/2024
? RETENUSERS : @baptistejamin, @eliottvincent, @valeriansaliou

Installation

npm install --save crisp-api

Authentification

Pour vous authentifier contre l'API, obtenez votre clés de jeton d'authentification en suivant le reste du guide d'authentification de l'API. Vous obtiendrez une cave de jeton en 2 valeurs.

Gardez vos valeurs de clés de jey-ci-joint privées et stockez-les en toute sécurité pour une utilisation à long terme.

Ensuite, ajoutez des paramètres d'authentification à l'instance de votre client juste après l'avoir créé:

 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.

Aperçu

Vous pouvez suivre le reste de l'API QuickStart Guide, qui vous amènera à courir avec l'API REST en quelques minutes.

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

Exemples

Créez votre propre 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 ) ;
  } ) ;

Méthodes de ressources

Toutes les ressources API croquantes disponibles sont entièrement mises en œuvre. Les noms de méthodes programmatiques sont nommés d'après leur nom d'étiquette dans la référence API REST .

Toutes les méthodes dont vous aurez probablement besoin lors de la création d'une intégration nette sont préfixées avec un symbole étoile ().

️ Notez que, en fonction de votre niveau de jeton d'authentification, qui est soit user ou plugin , vous ne pouvez pas utiliser toutes les méthodes de la bibliothèque. En cas de doute, reportez-vous aux descriptions de la méthode de la bibliothèque ci-dessous. Très probablement, vous utilisez un jeton plugin .

Site web

Conversations de site Web
Conversation de site Web
Site Web de site Web
Site Web Helpdesk
Opérateur de site Web
Disponibilité du site Web
Analytique du site Web
Batch du site Web
Vérifier le site Web
Campagnes de site Web
Campagne de site Web

Plugin

Plugin Connect
Abonnement au plugin

Médias

Animation médiatique

Seau

URL du seau

Événements RTM

Événements de session
Événements de message
Événements de personnes
Événements de campagne
Événements de navigation
Appeler des événements
Événements de widget
Événements de statut
Événements de site Web
Événements de seau
Événements médiatiques
EMAILS EMALES
Événements de plugin

Site web

Conversations de site Web

Liste des conversations [ user , plugin ]: référence

CrispClient.website.listConversations(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listConversations ( websiteID , pageNumber ) ;

Liste des segments de conversation suggérés [ user , plugin ]: référence

CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listSuggestedConversationSegments ( websiteID , pageNumber ) ;

Supprimer le segment de conversation suggéré [ user , plugin ]: référence

CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)

Voir l'exemple

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

var segment = "bug" ;

CrispClient . website . deleteSuggestedConversationSegment ( websiteID , segment ) ;

Liste des touches de données de conversation suggérées [ user , plugin ]: référence

CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listSuggestedConversationDataKeys ( websiteID , pageNumber ) ;

Supprimer la clé de données de conversation suggérée [ user , plugin ]: référence

CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)

Voir l'exemple

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

var key = "price" ;

CrispClient . website . deleteSuggestedConversationDataKey ( websiteID , key ) ;

Liste des conversations de spam [ user ]: référence

CrispClient.website.listSpamConversations(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listSpamConversations ( websiteID , pageNumber ) ;

Résoudre le contenu de la conversation de spam [ user ]: référence

CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

Voir l'exemple

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

CrispClient . website . resolveSpamConversationContent ( websiteID , spamID ) ;

Soumettre la décision de conversation de spam [ user ]: référence

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

Voir l'exemple

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

var action = "reject" ;

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

Conversation de site Web

Créer une nouvelle conversation [ user , plugin ]: référence

CrispClient.website.createNewConversation(websiteID)

Voir l'exemple

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

CrispClient . website . createNewConversation ( websiteID ) ;

Vérifiez si la conversation existe [ user , plugin ]: référence

CrispClient.website.checkConversationExists(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . checkConversationExists ( websiteID , sessionID ) ;

Obtenez une conversation [ user , plugin ]: référence

CrispClient.website.getConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getConversation ( websiteID , sessionID ) ;

Supprimer une conversation [ user , plugin ]: référence

CrispClient.website.removeConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . removeConversation ( websiteID , sessionID ) ;

Lancer une conversation avec la session existante [ user , plugin ]: référence

CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . initiateConversationWithExistingSession ( websiteID , sessionID ) ;

Obtenir des messages dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

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

Envoyer un message dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Obtenez un message dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

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

Mettre à jour un message dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Supprimer un message dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

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

Composez un message dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Marquez les messages comme lus dans Conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Marquez les messages livrés dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour la conversation à l'état ouvert [ user , plugin ]: référence

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

Voir l'exemple

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

var opened = true ;

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

Obtenir le routage de conversation Assignez [ user , plugin ]: référence

CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getConversationRoutingAssign ( websiteID , sessionID ) ;

Attribuer un routage de conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour la boîte de réception de la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Obtenir des métas de conversation [ user , plugin ]: référence

CrispClient.website.getConversationMetas(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getConversationMetas ( websiteID , sessionID ) ;

Mettre à jour les métas de conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Obtenez un message original dans la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Liste des pages de conversation [ user , plugin ]: référence

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

Voir l'exemple

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

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

Liste des événements de conversation [ user , plugin ]: référence

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

Voir l'exemple

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

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

Liste des fichiers de conversation [ user , plugin ]: référence

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

Voir l'exemple

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

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

Obtenir l'état de conversation [ user , plugin ]: référence

CrispClient.website.getConversationState(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getConversationState ( websiteID , sessionID ) ;

Modifier l'état de conversation [ user , plugin ]: référence

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

Voir l'exemple

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

var state = "unresolved" ;

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

Obtenir les participants à la conversation [ user , plugin ]: référence

CrispClient.website.getConversationParticipants(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getConversationParticipants ( websiteID , sessionID ) ;

Enregistrer les participants à la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Obtenez l'état du bloc pour la conversation [ user , plugin ]: référence

CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getBlockStatusForConversation ( websiteID , sessionID ) ;

Bloquer les messages entrants pour la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

var blocked = true ;

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

Obtenez l'état de vérification de la conversation [ user , plugin ]: référence

CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getVerifyStatusForConversation ( websiteID , sessionID ) ;

Mettre à jour la vérification de l'état de la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

var verified = true ;

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

Demandez la transcription par e-mail pour la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Demandez la purge de liaison de chat pour conversation [ user , plugin ]: référence

CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . requestChatboxBindingPurgeForConversation ( websiteID , sessionID ) ;

Demandez les commentaires de l'utilisateur pour la conversation [ user , plugin ]: référence

CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . requestUserFeedbackForConversation ( websiteID , sessionID ) ;

Liste des séances de navigation pour la conversation [ user , plugin ]: référence

CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . listBrowsingSessionsForConversation ( websiteID , sessionID ) ;

Initier la session de navigation pour la conversation [ user , plugin ]: référence

CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . initiateBrowsingSessionForConversation ( websiteID , sessionID ) ;

Envoyer une action à une session de navigation existante [ user , plugin ]: référence

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

Voir l'exemple

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

Aider la session de navigation existante [ user , plugin ]: référence

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

Voir l'exemple

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

Initier une nouvelle session d'appel pour la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

var mode = "audio" ;

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

Obtenez la session d'appel en cours pour la conversation [ user , plugin ]: référence

CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

Voir l'exemple

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

CrispClient . website . getOngoingCallSessionForConversation ( websiteID , sessionID ) ;

Aborter la session d'appel en cours pour la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Transmettre la signalisation sur la session d'appel en cours [ user , plugin ]: référence

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

Voir l'exemple

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

Fournir une action du bouton du widget pour la conversation [ user ]: référence

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

Voir l'exemple

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

Fournir une action de récupération de données pour la conversation [ user ]: référence

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

Voir l'exemple

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

Fournir une action de modification des données de widget pour la conversation [ user ]: référence

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

Voir l'exemple

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

Planifiez un rappel pour la conversation [ user , plugin ]: référence

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

Voir l'exemple

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

Les gens du site Web (ce sont vos utilisateurs finaux)

Get People Statistics [ user , plugin ]: référence

CrispClient.website.getPeopleStatistics(websiteID)

Voir l'exemple

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

CrispClient . website . getPeopleStatistics ( websiteID ) ;

Liste des segments de personnes suggérées [ user , plugin ]: référence

CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listSuggestedPeopleSegments ( websiteID , pageNumber ) ;

Supprimer le segment des personnes suggérées [ user , plugin ]: référence

CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

Voir l'exemple

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

var segment = "poweruser" ;

CrispClient . website . deleteSuggestedPeopleSegment ( websiteID , segment ) ;

Liste des clés de données des personnes suggérées [ user , plugin ]: référence

CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listSuggestedPeopleDataKeys ( websiteID , pageNumber ) ;

Supprimer la clé de données des personnes suggérées [ user , plugin ]: référence

CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)

Voir l'exemple

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

var key = "price" ;

CrispClient . website . deleteSuggestedPeopleDataKey ( websiteID , key ) ;

Liste des événements de personnes suggérées [ user , plugin ]: référence

CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listSuggestedPeopleEvents ( websiteID , pageNumber ) ;

Supprimer l'événement des personnes suggérées [ user , plugin ]: référence

CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

Voir l'exemple

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

var text = "Removed item from basket" ;

CrispClient . website . deleteSuggestedPeopleEvent ( websiteID , text ) ;

Listez des profils de personnes [ user , plugin ]: référence

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

Voir l'exemple

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

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

Ajouter un profil de nouvelles personnes [ user , plugin ]: référence

CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

Voir l'exemple

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

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

CrispClient . website . addNewPeopleProfile ( websiteID , peopleProfile ) ;

Vérifiez si le profil des gens existe [ user , plugin ]: référence

CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

Voir l'exemple

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

CrispClient . website . checkPeopleProfileExists ( websiteID , peopleID ) ;

Get People Profice [ user , plugin ]: Référence

CrispClient.website.getPeopleProfile(websiteID, peopleID)

Voir l'exemple

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

CrispClient . website . getPeopleProfile ( websiteID , peopleID ) ;

Enregistrer le profil des gens [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour le profil des personnes [ user , plugin ]: référence

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

Voir l'exemple

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

Supprimer le profil des personnes [ user , plugin ]: référence

CrispClient.website.removePeopleProfile(websiteID, peopleID)

Voir l'exemple

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

CrispClient . website . removePeopleProfile ( websiteID , peopleID ) ;

Listez les conversations des gens [ user , plugin ]: référence

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

Voir l'exemple

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

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

Listez des campagnes de personnes [ user ]: référence

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

Voir l'exemple

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

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

Ajouter un événement de personnes [ user , plugin ]: référence

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

Voir l'exemple

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

Listez les événements des personnes [ user , plugin ]: référence

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

Voir l'exemple

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

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

Obtenir les données des gens [ user , plugin ]: référence

CrispClient.website.getPeopleData(websiteID, peopleID)

Voir l'exemple

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

CrispClient . website . getPeopleData ( websiteID , peopleID ) ;

Enregistrer les données des gens [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour les données des personnes [ user , plugin ]: référence

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

Voir l'exemple

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

Obtenir l'état d'abonnement des personnes [ user , plugin ]: référence

CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

Voir l'exemple

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

CrispClient . website . getPeopleSubscriptionStatus ( websiteID , peopleID ) ;

Mettre à jour les personnes Statut d'abonnement [ user , plugin ]: référence

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

Voir l'exemple

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

var peopleSubscription = {
  "email" : true
} ;

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

Exporter les profils des personnes [ user ]: référence

CrispClient.website.exportPeopleProfiles(websiteID)

Voir l'exemple

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

CrispClient . website . exportPeopleProfiles ( websiteID ) ;

Importer des profils de personnes [ user ]: référence

CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

Voir l'exemple

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

AVIS: L'argument peopleID peut être un e-mail ou le peopleID .

Site Web Helpdesk

Vérifiez si Helpdesk existe [ user , plugin ]: référence

CrispClient.website.checkHelpdeskExists(websiteID)

Voir l'exemple

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

CrispClient . website . checkHelpdeskExists ( websiteID ) ;

Résolver helpdesk [ user , plugin ]: référence

CrispClient.website.resolveHelpdesk(websiteID)

Voir l'exemple

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

CrispClient . website . resolveHelpdesk ( websiteID ) ;

Initialiser HelpDesk [ user ]: référence

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

Voir l'exemple

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

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

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

Supprimer helpdesk [ user ]: référence

CrispClient.website.deleteHelpdesk(websiteID, verify)

Voir l'exemple

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

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

CrispClient . website . deleteHelpdesk ( websiteID , verify ) ;

Liste des locaux d'assistance pour aider [ user , plugin ]: référence

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

Voir l'exemple

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

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

Ajouter un paramètre local d'Helpdesk [ user , plugin ]: référence

CrispClient.website.addHelpdeskLocale(websiteID, locale)

Voir l'exemple

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

var locale = "en" ;

CrispClient . website . addHelpdeskLocale ( websiteID , locale ) ;

Vérifiez s'il existe des paramètres locaux d'assistance [ user , plugin ]: référence

CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)

Voir l'exemple

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

var locale = "en" ;

CrispClient . website . checkHelpdeskLocaleExists ( websiteID , locale ) ;

Résolve Helpdesk Locale [ user , plugin ]: référence

CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

Voir l'exemple

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

var locale = "en" ;

CrispClient . website . resolveHelpdeskLocale ( websiteID , locale ) ;

Supprimer les paramètres régionaux d'assistance [ user , plugin ]: référence

CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

Voir l'exemple

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

var locale = "en" ;

CrispClient . website . deleteHelpdeskLocale ( websiteID , locale ) ;

Liste des articles sur les paramètres régionaux de l'aide de l'aide [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Ajouter un nouvel article sur les paramètres régionaux de Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Vérifiez si l'article des paramètres régionaux d'assistance existe [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Résolve Helpdesk Locale Article [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Enregistrer l'article des paramètres régionaux de l'aide de l'aide [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour l'article des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Supprimer l'article des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Résoudre la page de l'article des paramètres régionaux Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Résoudre la catégorie Article des paramètres régionaux Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Mettre à jour la catégorie des articles de paramètres régionaux Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

Liste plugin l'article de paramètres régionaux de l'aide d'assistance user

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

Voir l'exemple

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

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

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

Vérifiez plugin l'article des paramètres régionaux de l' user

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

Voir l'exemple

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

Résolve Helpdesk Locale Article alternative [ user , plugin ]: référence

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

Voir l'exemple

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

Enregistrer l'article des paramètres régionaux de plugin user

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

Voir l'exemple

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

Supprimer l'article des paramètres locaux de user plugin

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

Voir l'exemple

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

Publier l'article des paramètres régionaux de l'aide de l'aide [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Article des paramètres régionaux de Helpdesk non publiés [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Liste des catégories de paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Ajouter la catégorie des paramètres régionaux d'Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Vérifiez si la catégorie des paramètres régionaux d'assistance existe [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Résoudre la catégorie des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Enregistrer la catégorie des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour la catégorie des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Supprimer la catégorie des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Liste des sections de paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Ajouter la section des paramètres régionaux d'Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

Vérifiez si la section Locale Helpdesk existe [ user , plugin ]: référence

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

Voir l'exemple

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

Résoudre la section Locale Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

Enregistrer la section Locale Helpdesk [ user , plugin ]: référence

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

Voir l'exemple

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

Mettez à jour la section des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Supprimer la section des paramètres régionaux d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Carte Helpdesk Ratings de rétroaction des paramètres locaux [ user , plugin ]: référence
- CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)
- Voir l'exemple
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . mapHelpdeskLocaleFeedbackRatings ( websiteID , locale ) ;
```
Liste des commentaires sur les paramètres régionaux de l'aide de l'aide [ user , plugin ]: référence
- CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber, filterDateStart, filterDateEnd)
- Voir l'exemple
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

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

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

Importer une aide externe vers le paramètre [ user ]: référence

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

Voir l'exemple

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

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

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

Exportation des articles de paramètres locaux de l'aide de l'aide [ user ]: référence

CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)

Voir l'exemple

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

var locale = "en" ;

CrispClient . website . exportHelpdeskLocaleArticles ( websiteID , locale ) ;

Liste des redirections d'assistance par aide [ user , plugin ]: référence

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

Ajouter une redirection d'assistance [ user , plugin ]: référence

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

Voir l'exemple

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

Vérifiez s'il existe une redirection d'assistance [ user , plugin ]: référence

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

Voir l'exemple

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

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

Résoudre la redirection d'assistance [ user , plugin ]: référence

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

Voir l'exemple

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

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

Supprimer la redirection d'assistance [ user , plugin ]: référence

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

Voir l'exemple

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

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

Résoudre les paramètres d'assistance [ user , plugin ]: référence

CrispClient.website.resolveHelpdeskSettings(websiteID)

Voir l'exemple

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

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;

Enregistrer les paramètres d'assistance [ user , plugin ]: référence

CrispClient.website.saveHelpdeskSettings(websiteID, settings)

Voir l'exemple

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

Résoudre le domaine d'assistance [ user ]: référence

CrispClient.website.resolveHelpdeskDomain(websiteID)

Voir l'exemple

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

CrispClient . website . resolveHelpdeskDomain ( websiteID ) ;

Demandez le changement de domaine Helpdesk [ user ]: référence

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

Voir l'exemple

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

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

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

Générer le flux de configuration du domaine Helpdesk [ user ]: référence

CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

Voir l'exemple

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

var custom = "help.valeriansaliou.name" ;

CrispClient . website . generateHelpdeskDomainSetupFlow ( websiteID , custom ) ;

Base de site Web

Vérifiez si le site Web existe [ user , plugin ]: référence
- CrispClient.website.checkWebsiteExists(domain)
- Voir l'exemple
```
 CrispClient . website . checkWebsiteExists ( domain ) ;
```
Créer un site Web [ user ]: référence
- CrispClient.website.createWebsite(websiteData)
- Voir l'exemple
```
 CrispClient . website . createWebsite ( websiteData ) ;
```

Obtenez un site Web [ user , plugin ]: référence

CrispClient.website.getWebsite(websiteID)

Voir l'exemple

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

CrispClient . website . getWebsite ( websiteID ) ;

Supprimer un site Web [ user ]: référence

CrispClient.website.deleteWebsite(websiteID, verify)

Voir l'exemple

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

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

CrispClient . website . deleteWebsite ( websiteID , verify ) ;

Aborter la suppression du site Web [ user ]: référence

CrispClient.website.abortWebsiteDeletion(websiteID)

Voir l'exemple

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

CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

Paramètres du site Web

Obtenir les paramètres du site Web [ user , plugin ]: référence

CrispClient.website.getWebsiteSettings(websiteID)

Voir l'exemple

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

CrispClient . website . getWebsiteSettings ( websiteID ) ;

Mettre à jour les paramètres du site Web [ user , plugin ]: référence

CrispClient.website.updateWebsiteSettings(websiteID, settings)

Voir l'exemple

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

Opérateur de site Web

Liste des opérateurs de site Web [ user , plugin ]: référence

CrispClient.website.listWebsiteOperators(websiteID)

Voir l'exemple

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

CrispClient . website . listWebsiteOperators ( websiteID ) ;

Liste des derniers opérateurs de sites Web actifs [ user , plugin ]: référence
- CrispClient.website.listLastActiveWebsiteOperators(websiteID)
- Voir l'exemple
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

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

Flush Last Active Site Web Opérateurs [ user ]: Référence

CrispClient.website.flushLastActiveWebsiteOperators(websiteID)

Voir l'exemple

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

CrispClient . website . flushLastActiveWebsiteOperators ( websiteID ) ;

Envoyer un e-mail aux opérateurs de sites Web [ user , plugin ]: référence

CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

Voir l'exemple

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

Obtenez un opérateur de site Web [ user , plugin ]: référence

CrispClient.website.getWebsiteOperator(websiteID, userID)

Voir l'exemple

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

CrispClient . website . getWebsiteOperator ( websiteID , userID ) ;

Inviter un opérateur de site Web [ user ]: référence

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

Voir l'exemple

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

Changer l'adhésion à l'opérateur [ user ]: référence

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

Voir l'exemple

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

Opérateur de linge à partir du site Web [ user ]: référence

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

Voir l'exemple

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

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

Visiteurs du site Web

Compter les visiteurs [ user , plugin ]: référence

CrispClient.website.countVisitors(websiteID)

Voir l'exemple

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

CrispClient . website . countVisitors ( websiteID ) ;

Liste des visiteurs [ user , plugin ]: référence

CrispClient.website.listVisitors(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listVisitors ( websiteID , pageNumber ) ;

Pinpoint visiteurs sur une carte [ user , plugin ]: référence

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

Voir l'exemple

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

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

Obtenez l'identificateur de session à partir de jeton [ user , plugin ]: référence

CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)

Voir l'exemple

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

CrispClient . website . getSessionIdentifierFromToken ( websiteID , tokenID ) ;

Compter les visiteurs bloqués [ user ]: référence
- CrispClient.website.countBlockedVisitors(websiteID)

Compter les visiteurs bloqués en règle [ user ]: référence

CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)

Voir l'exemple

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

CrispClient . website . countBlockedVisitorsInRule ( websiteID , rule ) ;

Effacer les visiteurs bloqués en règle [ user ]: référence

CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)

Voir l'exemple

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

CrispClient . website . clearBlockedVisitorsInRule ( websiteID , rule ) ;

Disponibilité du site Web
- Obtenir l'état de disponibilité du site Web [ user , plugin ]: référence
  - CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
  - Voir l'exemple
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;
- Liste des disponibilités de l'opérateur du site Web [ user , plugin ]: référence
  - CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
  - Voir l'exemple
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;

Analytique du site Web

Générer des analyses [ user ]: référence

CrispClient.website.generateAnalytics(websiteID, query)

Voir l'exemple

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

CrispClient . website . generateAnalytics ( websiteID , query ) ;

Batch du site Web

Conversations de résolution par lots [ user ]: référence

CrispClient.website.batchResolveConversations(websiteID, operation)

Voir l'exemple

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

Conversations de lecture par lots [ user ]: référence

CrispClient.website.batchReadConversations(websiteID, operation)

Voir l'exemple

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

Lot Supprimer les conversations [ user ]: référence

CrispClient.website.batchRemoveConversations(websiteID, operation)

Voir l'exemple

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

Lot de suppression des personnes [ user ]: référence

CrispClient.website.batchRemovePeople(websiteID, people)

Voir l'exemple

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

Vérifier le site Web

Obtenez des paramètres de vérification [ user , plugin ]: référence

CrispClient.website.getVerifySettings(websiteID)

Voir l'exemple

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

CrispClient . website . getVerifySettings ( websiteID ) ;

Mettre à jour les paramètres de vérification [ user , plugin ]: référence

CrispClient.website.updateVerifySettings(websiteID, settings)

Voir l'exemple

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

var settings = {
  "enabled" : true
} ;

CrispClient . website . updateVerifySettings ( websiteID , settings ) ;

Obtenez la clé de vérification [ user , plugin ]: référence

CrispClient.website.getVerifyKey(websiteID)

Voir l'exemple

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

CrispClient . website . getVerifyKey ( websiteID ) ;

Roll Verify Key [ user , plugin ]: référence

CrispClient.website.rollVerifyKey(websiteID)

Voir l'exemple

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

CrispClient . website . rollVerifyKey ( websiteID ) ;

Campagnes de site Web

Liste des campagnes [ user ]: référence

CrispClient.website.listCampaigns(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listCampaigns ( websiteID , pageNumber ) ;

Liste des balises de campagne [ user ]: référence

CrispClient.website.listCampaignTags(websiteID)

Voir l'exemple

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

CrispClient . website . listCampaignTags ( websiteID ) ;

Liste des modèles de campagne [ user , plugin ]: référence

CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

Voir l'exemple

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

CrispClient . website . listCampaignTemplates ( websiteID , pageNumber ) ;

Créer un nouveau modèle de campagne [ user , plugin ]: référence

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

Voir l'exemple

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

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

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

Vérifiez si le modèle de campagne existe [ user , plugin ]: référence

CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

Voir l'exemple

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

CrispClient . website . checkCampaignTemplateExists ( websiteID , templateID ) ;

Obtenez un modèle de campagne [ user , plugin ]: référence

CrispClient.website.getCampaignTemplate(websiteID, templateID)

Voir l'exemple

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

CrispClient . website . getCampaignTemplate ( websiteID , templateID ) ;

Enregistrer un modèle de campagne [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour un modèle de campagne [ user , plugin ]: référence

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

Voir l'exemple

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

Supprimer un modèle de campagne [ user , plugin ]: référence

CrispClient.website.removeCampaignTemplate(websiteID, templateID)

Voir l'exemple

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

CrispClient . website . removeCampaignTemplate ( websiteID , templateID ) ;

Campagne de site Web

Créer une nouvelle campagne [ user ]: référence

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

Voir l'exemple

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

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

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

Vérifiez si la campagne existe [ user ]: référence

CrispClient.website.checkCampaignExists(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . checkCampaignExists ( websiteID , campaignID ) ;

Obtenez une campagne [ user ]: référence

CrispClient.website.getCampaign(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . getCampaign ( websiteID , campaignID ) ;

Enregistrer une campagne [ user ]: référence

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

Voir l'exemple

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

Mettre à jour une campagne [ user ]: référence

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

Voir l'exemple

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

Supprimer une campagne [ user ]: référence

CrispClient.website.removeCampaign(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . removeCampaign ( websiteID , campaignID ) ;

Envoiant une campagne [ user ]: référence

CrispClient.website.dispatchCampaign(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . dispatchCampaign ( websiteID , campaignID ) ;

Reprendre une campagne [ user ]: référence

CrispClient.website.resumeCampaign(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . resumeCampaign ( websiteID , campaignID ) ;

Pause une campagne [ user ]: référence

CrispClient.website.pauseCampaign(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . pauseCampaign ( websiteID , campaignID ) ;

Tester une campagne [ user ]: référence

CrispClient.website.testCampaign(websiteID, campaignID)

Voir l'exemple

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

CrispClient . website . testCampaign ( websiteID , campaignID ) ;

Liste des destinataires de la campagne [ user ]: référence

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

Voir l'exemple

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

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

Liste des statistiques de campagne [ user ]: référence

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

Voir l'exemple

 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
- Obtenir le compte Connect [ plugin ]: référence
  - CrispClient.plugin.getConnectAccount()
  - Voir l'exemple
    CrispClient . plugin . getConnectAccount ( ) ;
- Vérifier la validité de la session de connexion [ plugin ]: référence
  - CrispClient.plugin.checkConnectSessionValidity()
  - Voir l'exemple
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- Liste tous les sites Web Connect [ plugin ]: référence
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - Voir l'exemple
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- Lister les sites Web de connexion depuis [ plugin ]: référence
  - CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
  - Voir l'exemple
    var dateSince = "2023-08-16T09:00:00Z" ; CrispClient . plugin . listConnectWebsitesSince ( dateSince , filterConfigured ) ;
- Obtenir des points de terminaison Connect [ plugin ]: référence
  - CrispClient.plugin.getConnectEndpoints()
  - Voir l'exemple
    CrispClient . plugin . getConnectEndpoints ( ) ;

Abonnement au plugin

Liste tous les abonnements actifs [ user ]: référence
- CrispClient.plugin.listAllActiveSubscriptions()
- Voir l'exemple
```
 CrispClient . plugin . listAllActiveSubscriptions ( ) ;
```

Liste des abonnements pour un site Web [ user ]: référence

CrispClient.plugin.listSubscriptionsForWebsite(websiteID)

Voir l'exemple

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

CrispClient . plugin . listSubscriptionsForWebsite ( websiteID ) ;

Obtenir les détails de l'abonnement [ user , plugin ]: référence

CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

Voir l'exemple

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

CrispClient . plugin . getSubscriptionDetails ( websiteID , pluginID ) ;

Abonnez-vous le site Web à Plugin [ user ]: référence

CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

Voir l'exemple

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

Plugin de désabonnement du site Web [ user ]: référence

CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

Voir l'exemple

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

CrispClient . plugin . unsubscribePluginFromWebsite ( websiteID , pluginID ) ;

Obtenir les paramètres d'abonnement [ user , plugin ]: référence

CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

Voir l'exemple

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

CrispClient . plugin . getSubscriptionSettings ( websiteID , pluginID ) ;

Enregistrer les paramètres d'abonnement [ user , plugin ]: référence

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

Voir l'exemple

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

Mettre à jour les paramètres d'abonnement [ user , plugin ]: référence

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

Voir l'exemple

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

Obtenir les factures d'utilisation du plugin [ user , plugin ]: référence

CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

Voir l'exemple

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

CrispClient . plugin . getPluginUsageBills ( websiteID , pluginID ) ;

Rapport Utilisation du plugin à Bill [ plugin ]: référence

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

Voir l'exemple

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

Plugin vers le plugin vers la charge utile à canal [ user , plugin ]: référence

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

Voir l'exemple

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

Événement de plugin d'expédition [ user , plugin ]: référence

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

Voir l'exemple

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

Médias

Animation médiatique

Lister les médias d'animation [ user ]: référence

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

Voir l'exemple

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

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

Seau

URL du seau
- Générer URL du seau [ user , plugin ]: référence
  - CrispClient.bucket.generateBucketURL(data)
  - Voir l'exemple
    CrispClient . bucket . generateBucketURL ( data ) ;

Événements en temps réel

Vous pouvez vous lier aux événements en temps réel de Crisp, afin de vous informer des messages et des mises à jour entrants dans les sites Web.

Vous ne recevrez aucun événement si vous ne vous abonnez pas explicitement aux événements en temps réel, car la bibliothèque ne se connecte pas automatiquement au backend en temps réel.

Il existe deux façons de recevoir des événements en temps réel:

Utilisation de crochets Web ( recommandé )
Utilisation de WebSockets avec l'API RTM

Avant de commencer par les événements RTM, veuillez considérer ce qui suit:

Vous ne recevrez aucun événement si vous ne vous abonnez pas explicitement à des événements en temps réel à l'aide de CrispClient.on() , car la bibliothèque ne se connecte pas automatiquement au backend en temps réel. Cette méthode renvoie un objet Promise .
Chaque fois que la liste des sites Web que votre jeton d'authentification a le droit de recevoir des événements pour des modifications, vous devrez appeler CrispClient.rebindSocket() . Cette méthode renvoie également un objet Promise . Cela ne s'applique qu'aux WebSockets avec l'API RTM .

Recevoir des événements en temps réel

Recevoir des événements sur les crochets Web

Pour commencer à écouter les événements et lier un gestionnaire, consultez l'exemple des événements sur les crochets Web.

Vous devrez ajuster votre code afin que:

Le mode RTM Events est défini sur les crochets Web: CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
Votre point de terminaison HTTP monte un itinéraire écoutant pour les demandes de poste et lors des demandes de réception:
1. Il vérifie les demandes avec: CrispClient.verifyHook(secret, body, timestamp, signature)
2. Il reçoit le web hook avec: CrispClient.receiveHook(body)

Les crochets Web de plugin devront être configurés en premier pour que cela fonctionne. Consultez notre Guide QuickStart Web Hooks et notre référence sur les crochets Web pour démarrer.

Recevoir des événements sur WebSockets (API RTM)

Pour commencer à écouter les événements et lier un gestionnaire, consultez l'exemple d'événements sur WebSockets.

Vous devrez ajuster votre code afin que:

Le mode RTM Events est défini sur WebSockets: CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

Événements disponibles en temps réel

Les événements disponibles sont répertoriés ci-dessous:

Événements de session : référence
- Disponibilité de mise à jour de session [ user , plugin ]:
  - session:update_availability
- Mise à jour de la session Vérifier [ user , plugin ]:
  - session:update_verify
- Demande de session initiée [ user , plugin ]:
  - session:request:initiated
- Session Set Email [ user , plugin ]:
  - session:set_email
- Téléphone de set de session [ user , plugin ]:
  - session:set_phone
- Adresse de définition de session [ user , plugin ]:
  - session:set_address
- Ensemble de session Sujet [ user , plugin ]:
  - session:set_subject
- Session Set Avatar [ user , plugin ]:
  - session:set_avatar
- Surnom de section de session [ user , plugin ]:
  - session:set_nickname
- Données de définition de session [ user , plugin ]:
  - session:set_data
- Pages de synchronisation de session [ user , plugin ]:
  - session:sync:pages
- Événements de synchronisation de session [ user , plugin ]:
  - session:sync:events
- Capacités de synchronisation de session [ user , plugin ]:
  - session:sync:capabilities
- Session Sync Geolocation [ user , plugin ]:
  - session:sync:geolocation
- Session Sync System [ user , plugin ]:
  - session:sync:system
- Session Sync Network [ user , plugin ]:
  - session:sync:network
- Session Sync Timezone [ user , plugin ]:
  - session:sync:timezone
- Session Sync Locals [ user , plugin ]:
  - session:sync:locales
- Évaluation de synchronisation de session [ user , plugin ]:
  - session:sync:rating
- Sujet de synchronisation de session [ user , plugin ]:
  - session:sync:topic
- État de set de session [ user , plugin ]:
  - session:set_state
- Bloc de set de session [ user , plugin ]:
  - session:set_block
- Segments de définition de session [ user , plugin ]:
  - session:set_segments
- Session Set ouverte [ user , plugin ]:
  - session:set_opened
- Session Set Ferm [ user , plugin ]:
  - session:set_closed
- Définir les participants [ user , plugin ]:
  - session:set_participants
- Session Set Mentions [ user , plugin ]:
  - session:set_mentions
- Session Set Routing [ user , plugin ]:
  - session:set_routing
- Session Set Inbox [ user , plugin ]:
  - session:set_inbox
- Session supprimée [ user , plugin ]:
  - session:removed
Événements de message : référence
- Message mis à jour [ user , plugin ]:
  - message:updated
- Message Envoyer [ user , plugin ]:
  - message:send
- Message reçu [ user , plugin ]:
  - message:received
- Message supprimé [ user , plugin ]:
  - message:removed
- Message Compose Send [ user , plugin ]:
  - message:compose:send
- Message Compose Receive [ user , plugin ]:
  - message:compose:receive
- Message Remerced Lire Send [ user , plugin ]:
  - message:acknowledge:read:send
- Message reconnaissant la lecture reçue [ user , plugin ]:
  - message:acknowledge:read:received
- Message Remerciements livrés [ user , plugin ]:
  - message:acknowledge:delivered
- Message Notify non lu Send [ user , plugin ]:
  - message:notify:unread:send
- Message Notify non lu reçu [ user , plugin ]:
  - message:notify:unread:received
Événements de spam : référence
- Message de spam [ user ]:
  - spam:message
- Décision de spam [ user ]:
  - spam:decision
Événements des personnes : référence
- Profil des gens créé [ user , plugin ]:
  - people:profile:created
- Profil des gens mis à jour [ user , plugin ]:
  - people:profile:updated
- Profil des personnes supprimé [ user , plugin ]:
  - people:profile:removed
- Les gens lient la session [ user , plugin ]:
  - people:bind:session
- Les gens synchronisent le profil [ user , plugin ]:
  - people:sync:profile
- Les gens importent des progrès [ user ]:
  - people:import:progress
- Les gens importent [ user ]:
  - people:import:done
Événements de campagne : référence
- Progrès de la campagne [ user ]:
  - campaign:progress
- Campagne envoyée [ user ]:
  - campaign:dispatched
- Campagne en cours d'exécution [ user ]:
  - campaign:running
Événements de navigation : référence
- Demande de navigation initiée [ user , plugin ]:
  - browsing:request:initiated
- Demande de navigation rejetée [ user , plugin ]:
  - browsing:request:rejected
Événements d'appel : référence
- Demande d'appel initiée [ user , plugin ]:
  - call:request:initiated
- Demande d'appel rejetée [ user , plugin ]:
  - call:request:rejected
Événements de widget : référence
- Action du widget traité [ user ]:
  - widget:action:processed
Événements de statut : référence
- La santé du statut a changé [ user ]:
  - status:health:changed
Événements du site Web : référence
- Les visiteurs de mise à jour du site Web comptent [ user , plugin ]:
  - website:update_visitors_count
- Disponibilité des opérateurs de mise à jour du site Web [ user , plugin ]:
  - website:update_operators_availability
- Utilisateurs de site Web disponibles [ user , plugin ]:
  - website:users:available
Événements de godet : référence
- Téléchargement URL du seau généré [ user , plugin ]:
  - bucket:url:upload:generated
- Avatar URL de godet généré [ user , plugin ]:
  - bucket:url:avatar:generated
- Site Web d'URL de godet généré [ user , plugin ]:
  - bucket:url:website:generated
- Campagne d'URL de godet générée [ user , plugin ]:
  - bucket:url:campaign:generated
- URL Backet URL Généré [ user , plugin ]:
  - bucket:url:helpdesk:generated
- État de l'URL du seau généré [ user , plugin ]:
  - bucket:url:status:generated
- Traitement d'URL du godet généré [ user , plugin ]:
  - bucket:url:processing:generated
Événements médiatiques : référence
- Animation médiatique répertoriée [ user ]:
  - media:animation:listed
Événements par e-mail : référence
- Email Abonnez-vous [ user , plugin ]:
  - email:subscribe
- Affichage de la piste par e-mail [ user , plugin ]:
  - email:track:view
Événements du plugin : référence
- Channel de plugin [ user , plugin ]:
  - plugin:channel
- Événement de plugin [ user , plugin ]:
  - plugin:event
- Paramètres du plugin enregistrés [ user , plugin ]:
  - plugin:settings:saved

Développer

node crisp api

Emballage de l'API croustillant

Installation

Authentification

Aperçu

Exemples

Créez votre propre bot!

Méthodes de ressources

Site web

Conversations de site Web

Conversation de site Web

Les gens du site Web (ce sont vos utilisateurs finaux)

Site Web Helpdesk

Base de site Web

Paramètres du site Web

Opérateur de site Web

Visiteurs du site Web

Disponibilité du site Web

Analytique du site Web

Batch du site Web

Vérifier le site Web

Campagnes de site Web

Campagne de site Web

Plugin

Plugin Connect

Abonnement au plugin

Médias

Animation médiatique

Seau

URL du seau

Événements en temps réel

Recevoir des événements en temps réel

Recevoir des événements sur les crochets Web

Recevoir des événements sur WebSockets (API RTM)

Événements disponibles en temps réel

Événements de session : référence

Événements de message : référence

Événements de spam : référence

Événements des personnes : référence

Événements de campagne : référence

Événements de navigation : référence

Événements d'appel : référence

Événements de widget : référence

Événements de statut : référence

Événements du site Web : référence

Événements de godet : référence

Événements médiatiques : référence

Événements par e-mail : référence

Événements du plugin : référence