Download node crisp api - node crisp api Código fonte download

Wrapper Crisp API

O invólucro nó de API Crisp. Autentique, envie mensagens, busque conversas, acesse as contas do agente do seu código JavaScript.

IMPLEMENTOS : Referência da API REST (v1) na revisão: 17/10/2024
? Manters : @Baptistejamin, @Eliottvincent, @valeriansaliou

Instalação

npm install --save crisp-api

Autenticação

Para se autenticar contra a API, obtenha o seu token Keyyair de autenticação seguindo o REST API Authentication Guide. Você receberá um token teclado feito de 2 valores.

Mantenha seus valores de parada de token em particular e armazene-os com segurança para uso a longo prazo.

Em seguida, adicione parâmetros de autenticação à instância do seu client logo após a criação:

 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.

Visão geral

Você pode seguir o REST API Quickstart Guide, que o fará com que você execute a API REST em minutos.

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

Exemplos

Crie seu próprio 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étodos de recursos

Todos os recursos da API CRISP disponíveis estão totalmente implementados. Os nomes dos métodos programáticos têm o nome do nome do rótulo na referência da API REST .

Todos os métodos que você provavelmente precisará ao criar uma integração nítida são prefixados com um símbolo de estrela ().

️ Observe que, dependendo do seu token de autenticação, que é user ou plugin , talvez você não possa usar todos os métodos da biblioteca. Em caso de dúvida, consulte as descrições do método da biblioteca abaixo. Muito provavelmente, você está usando um token plugin .

Site

Conversas no site
Conversação do site
Pessoas do site
Helpdesk do site
Operador de site
Disponibilidade do site
Análise de sites
Lote de sites
Site verifique
Campanhas do site
Campanha do site

Plugin

Connect Plugin Connect
Assinatura do plug -in

Mídia

Animação da mídia

Balde

URL do balde

Eventos RTM

Eventos de sessão
Eventos de mensagem
Eventos de pessoas
Eventos de campanha
Eventos de navegação
Ligue para eventos
Eventos de widget
Eventos de status
Eventos do site
Eventos de balde
Eventos de mídia
Eventos de e -mail
Eventos de plug -in

Site

Conversas no site

Listar conversas [ user , plugin ]: Referência

CrispClient.website.listConversations(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listConversations ( websiteID , pageNumber ) ;

Lista segmentos de conversa sugeridos [ user , plugin ]: Referência

CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listSuggestedConversationSegments ( websiteID , pageNumber ) ;

Excluir segmento de conversa sugerida [ user , plugin ]: Referência

CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)

Veja o exemplo

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

var segment = "bug" ;

CrispClient . website . deleteSuggestedConversationSegment ( websiteID , segment ) ;

Lista Chaves de dados de conversa sugeridos [ user , plugin ]: Referência

CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listSuggestedConversationDataKeys ( websiteID , pageNumber ) ;

Excluir chave de dados de conversa sugerida [ user , plugin ]: referência

CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)

Veja o exemplo

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

var key = "price" ;

CrispClient . website . deleteSuggestedConversationDataKey ( websiteID , key ) ;

Listar conversas de spam [ user ]: referência

CrispClient.website.listSpamConversations(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listSpamConversations ( websiteID , pageNumber ) ;

Resolva Conteúdo da Conversação de Spam [ user ]: Referência

CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

Veja o exemplo

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

CrispClient . website . resolveSpamConversationContent ( websiteID , spamID ) ;

Enviar Decisão de Conversação de Spam [ user ]: Referência

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

Veja o exemplo

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

var action = "reject" ;

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

Conversação do site

Crie uma nova conversa [ user , plugin ]: referência

CrispClient.website.createNewConversation(websiteID)

Veja o exemplo

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

CrispClient . website . createNewConversation ( websiteID ) ;

Verifique se a conversa existe [ user , plugin ]: referência

CrispClient.website.checkConversationExists(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . checkConversationExists ( websiteID , sessionID ) ;

Obtenha uma conversa [ user , plugin ]: referência

CrispClient.website.getConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getConversation ( websiteID , sessionID ) ;

Remova uma conversa [ user , plugin ]: referência

CrispClient.website.removeConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . removeConversation ( websiteID , sessionID ) ;

Inicie uma conversa com sessão existente [ user , plugin ]: Referência

CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . initiateConversationWithExistingSession ( websiteID , sessionID ) ;

Obtenha mensagens na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

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

Envie uma mensagem na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Receba uma mensagem na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

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

Atualize uma mensagem na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Remova uma mensagem na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

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

Componha uma mensagem na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Marque as mensagens conforme lido na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Marque as mensagens entregues em conversas [ user , plugin ]: referência

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

Veja o exemplo

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

Atualizar conversação Open State [ user , plugin ]: Referência

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

Veja o exemplo

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

var opened = true ;

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

Obtenha o roteamento de conversas Atribuir [ user , plugin ]: Referência

CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getConversationRoutingAssign ( websiteID , sessionID ) ;

Atribuir roteamento de conversação [ user , plugin ]: referência

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

Veja o exemplo

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

Atualize a caixa de entrada de conversação [ user , plugin ]: referência

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

Veja o exemplo

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

Obtenha metas de conversa [ user , plugin ]: referência

CrispClient.website.getConversationMetas(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getConversationMetas ( websiteID , sessionID ) ;

Atualize as metas da conversa [ user , plugin ]: Referência

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

Veja o exemplo

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

Obtenha uma mensagem original na conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Listar páginas de conversa [ user , plugin ]: Referência

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

Veja o exemplo

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

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

Listar eventos de conversa [ user , plugin ]: Referência

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

Veja o exemplo

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

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

Listar arquivos de conversa [ user , plugin ]: referência

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

Veja o exemplo

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

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

Obtenha estado de conversa [ user , plugin ]: referência

CrispClient.website.getConversationState(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getConversationState ( websiteID , sessionID ) ;

Alterar estado de conversa [ user , plugin ]: referência

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

Veja o exemplo

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

var state = "unresolved" ;

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

Obtenha participantes da conversa [ user , plugin ]: referência

CrispClient.website.getConversationParticipants(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getConversationParticipants ( websiteID , sessionID ) ;

Salvar os participantes da conversa [ user , plugin ]: Referência

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

Veja o exemplo

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

Obtenha status de bloco para conversa [ user , plugin ]: referência

CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getBlockStatusForConversation ( websiteID , sessionID ) ;

Bloquear mensagens recebidas para conversa [ user , plugin ]: referência

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

Veja o exemplo

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

var blocked = true ;

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

Obtenha o status de verificação da conversa [ user , plugin ]: referência

CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getVerifyStatusForConversation ( websiteID , sessionID ) ;

Atualizar o status da verificação da conversa [ user , plugin ]: referência

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

Veja o exemplo

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

var verified = true ;

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

Solicite transcrição de email para conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Solicite ChatBox Binding Purge for Conversation [ user , plugin ]: Referência

CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . requestChatboxBindingPurgeForConversation ( websiteID , sessionID ) ;

Solicite feedback do usuário para conversa [ user , plugin ]: referência

CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . requestUserFeedbackForConversation ( websiteID , sessionID ) ;

Lista de sessões de navegação para conversas [ user , plugin ]: referência

CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . listBrowsingSessionsForConversation ( websiteID , sessionID ) ;

Iniciar sessão de navegação para conversas [ user , plugin ]: referência

CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . initiateBrowsingSessionForConversation ( websiteID , sessionID ) ;

Envie ação para uma sessão de navegação existente [ user , plugin ]: Referência

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

Veja o exemplo

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

Auxiliar a sessão de navegação existente [ user , plugin ]: Referência

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

Veja o exemplo

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

Inicie a nova sessão de chamada para conversa [ user , plugin ]: referência

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

Veja o exemplo

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

var mode = "audio" ;

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

Obtenha sessão de chamada em andamento para conversa [ user , plugin ]: referência

CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

Veja o exemplo

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

CrispClient . website . getOngoingCallSessionForConversation ( websiteID , sessionID ) ;

Aborte a sessão de chamada em andamento para conversa [ user , plugin ]: referência

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

Veja o exemplo

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

Transmitir sinalização na sessão de chamada em andamento [ user , plugin ]: Referência

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

Veja o exemplo

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

Entregue a ação do botão do widget para conversa [ user ]: referência

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

Veja o exemplo

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

Entregue a ação de busca de dados do widget para conversa [ user ]: referência

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

Veja o exemplo

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

Entregue a ação de edição de dados do widget para conversa [ user ]: referência

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

Veja o exemplo

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

Programe um lembrete para conversa [ user , plugin ]: referência

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

Veja o exemplo

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

O pessoal do site (esses são seus usuários finais)

Obtenha estatísticas de pessoas [ user , plugin ]: referência

CrispClient.website.getPeopleStatistics(websiteID)

Veja o exemplo

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

CrispClient . website . getPeopleStatistics ( websiteID ) ;

Lista segmentos de pessoas sugeridas [ user , plugin ]: Referência

CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listSuggestedPeopleSegments ( websiteID , pageNumber ) ;

Excluir segmento de pessoas sugeridas [ user , plugin ]: referência

CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

Veja o exemplo

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

var segment = "poweruser" ;

CrispClient . website . deleteSuggestedPeopleSegment ( websiteID , segment ) ;

Lista Chaves de dados sugeridas para pessoas [ user , plugin ]: Referência

CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listSuggestedPeopleDataKeys ( websiteID , pageNumber ) ;

Delete Chave de dados sugeridos de pessoas [ user , plugin ]: Referência

CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)

Veja o exemplo

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

var key = "price" ;

CrispClient . website . deleteSuggestedPeopleDataKey ( websiteID , key ) ;

Lista de eventos sugeridos para pessoas [ user , plugin ]: referência

CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listSuggestedPeopleEvents ( websiteID , pageNumber ) ;

Delete Evento de People sugerido [ user , plugin ]: Referência

CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

Veja o exemplo

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

var text = "Removed item from basket" ;

CrispClient . website . deleteSuggestedPeopleEvent ( websiteID , text ) ;

Listar perfis de pessoas [ user , plugin ]: Referência

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

Veja o exemplo

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

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

Adicionar novo perfil de pessoas [ user , plugin ]: referência

CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

Veja o exemplo

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

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

CrispClient . website . addNewPeopleProfile ( websiteID , peopleProfile ) ;

Verifique se o perfil das pessoas existe [ user , plugin ]: referência

CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

Veja o exemplo

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

CrispClient . website . checkPeopleProfileExists ( websiteID , peopleID ) ;

Obtenha o perfil de pessoas [ user , plugin ]: referência

CrispClient.website.getPeopleProfile(websiteID, peopleID)

Veja o exemplo

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

CrispClient . website . getPeopleProfile ( websiteID , peopleID ) ;

Salvar Perfil de Pessoas [ user , plugin ]: Referência

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

Veja o exemplo

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

Atualize o perfil de pessoas [ user , plugin ]: referência

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

Veja o exemplo

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

Remova o perfil de pessoas [ user , plugin ]: referência

CrispClient.website.removePeopleProfile(websiteID, peopleID)

Veja o exemplo

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

CrispClient . website . removePeopleProfile ( websiteID , peopleID ) ;

Liste conversas sobre pessoas [ user , plugin ]: Referência

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

Veja o exemplo

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

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

Listar campanhas de pessoas [ user ]: referência

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

Veja o exemplo

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

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

Adicione um evento de pessoas [ user , plugin ]: referência

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

Veja o exemplo

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

Listar eventos de pessoas [ user , plugin ]: Referência

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

Veja o exemplo

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

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

Obtenha dados de pessoas [ user , plugin ]: referência

CrispClient.website.getPeopleData(websiteID, peopleID)

Veja o exemplo

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

CrispClient . website . getPeopleData ( websiteID , peopleID ) ;

Salvar dados de pessoas [ user , plugin ]: referência

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

Veja o exemplo

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

Atualizar dados de pessoas [ user , plugin ]: Referência

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

Veja o exemplo

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

Obtenha o status de assinatura de pessoas [ user , plugin ]: referência

CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

Veja o exemplo

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

CrispClient . website . getPeopleSubscriptionStatus ( websiteID , peopleID ) ;

Atualize o status de assinatura de pessoas [ user , plugin ]: Referência

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

Veja o exemplo

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

var peopleSubscription = {
  "email" : true
} ;

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

Exportar Perfis de Pessoas [ user ]: Referência

CrispClient.website.exportPeopleProfiles(websiteID)

Veja o exemplo

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

CrispClient . website . exportPeopleProfiles ( websiteID ) ;

Profis de importação de pessoas [ user ]: referência

CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

Veja o exemplo

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

Aviso: O argumento peopleID pode ser um email ou o peopleID .

Helpdesk do site

Verifique se o helpdesk existe [ user , plugin ]: referência

CrispClient.website.checkHelpdeskExists(websiteID)

Veja o exemplo

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

CrispClient . website . checkHelpdeskExists ( websiteID ) ;

Resolva HelpDesk [ user , plugin ]: Referência

CrispClient.website.resolveHelpdesk(websiteID)

Veja o exemplo

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

CrispClient . website . resolveHelpdesk ( websiteID ) ;

Inicialize HelpDesk [ user ]: Referência

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

Veja o exemplo

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

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

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

Excluir helpdesk [ user ]: referência

CrispClient.website.deleteHelpdesk(websiteID, verify)

Veja o exemplo

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

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

CrispClient . website . deleteHelpdesk ( websiteID , verify ) ;

Listar Locais de Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

Adicionar Local de Helpdesk [ user , plugin ]: Referência

CrispClient.website.addHelpdeskLocale(websiteID, locale)

Veja o exemplo

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

var locale = "en" ;

CrispClient . website . addHelpdeskLocale ( websiteID , locale ) ;

Verifique se a Locale helpdesk existe [ user , plugin ]: Referência

CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)

Veja o exemplo

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

var locale = "en" ;

CrispClient . website . checkHelpdeskLocaleExists ( websiteID , locale ) ;

Resolva HelpDesk Locale [ user , plugin ]: Referência

CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

Veja o exemplo

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

var locale = "en" ;

CrispClient . website . resolveHelpdeskLocale ( websiteID , locale ) ;

Exclua Locale Helpdesk [ user , plugin ]: Referência

CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

Veja o exemplo

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

var locale = "en" ;

CrispClient . website . deleteHelpdeskLocale ( websiteID , locale ) ;

Listar artigos de localidade helpdesk [ user , plugin ]: referência

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

Veja o exemplo

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

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

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

Adicione um novo artigo do HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Verifique se existe um artigo do HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Resolva o artigo do Locale do Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Salvar artigo do Locale Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Atualize o artigo do Locale Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Excluir artigo do Locale Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Resolva a página do artigo do Locale Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Resolva a categoria Artigo do Local de Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Atualize a categoria de artigo do HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

Listar o artigo do Locale Helpdesk alternantes [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Verifique se o artigo do HelpDesk Locale Alternate existe [ user , plugin ]: Referência

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

Veja o exemplo

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

Resolva o artigo do Locale Helpdesk Alternate [ user , plugin ]: Referência

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

Veja o exemplo

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

Salvar o artigo do HelpDesk Locale Alternate [ user , plugin ]: Referência

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

Veja o exemplo

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

Excluir Artigo do Locale Helpdesk Alternativo [ user , plugin ]: Referência

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

Veja o exemplo

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

Publique o artigo do HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Artigo não publicado do Locale Helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Listar categorias de localidade helpdesk [ user , plugin ]: referência

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

Veja o exemplo

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

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

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

Adicione a categoria HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Verifique se a categoria HelpDesk Locale existe [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Resolva a categoria HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Salvar a categoria Helpdesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

Atualize a categoria HelpDesk Locale [ user , plugin ]: Referência

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

Veja o exemplo

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

Excluir categoria de localidade helpdesk [ user , plugin ]: referência

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

Veja o exemplo

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

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

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

Listar seções de localidade helpdesk [ user , plugin ]: referência

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

Veja o exemplo

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

Adicionar seção de localidade helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Verifique se existe seção de localidade helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Resolva seção de localidade helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Salvar seção de localidade helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Atualize a seção de localidade helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Excluir seção de localidade helpdesk [ user , plugin ]: referência

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

Veja o exemplo

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

Mapa Classificações de feedback do Locale Helpdesk [ user , plugin ]: Referência
- CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)
- Veja o exemplo
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

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

Listar feedbacks do local do helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Importar helpdesk externo para a localidade [ user ]: referência

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

Veja o exemplo

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

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

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

Exportar Helpdesk Locale Artigos [ user ]: Referência

CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)

Veja o exemplo

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

var locale = "en" ;

CrispClient . website . exportHelpdeskLocaleArticles ( websiteID , locale ) ;

Listar redirecionamentos helpdesk [ user , plugin ]: referência

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

Adicionar redirecionamento helpdesk [ user , plugin ]: Referência

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

Veja o exemplo

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

Verifique se existe redirecionamento de helpdesk [ user , plugin ]: referência

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

Veja o exemplo

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

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

Resolva o redirecionamento do helpdesk [ user , plugin ]: referência

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

Veja o exemplo

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

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

Excluir redirecionamento do helpdesk [ user , plugin ]: Referência

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

Veja o exemplo

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

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

Resolva Configurações do HelpDesk [ user , plugin ]: Referência

CrispClient.website.resolveHelpdeskSettings(websiteID)

Veja o exemplo

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

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;

Salvar Configurações do Helpdesk [ user , plugin ]: Referência

CrispClient.website.saveHelpdeskSettings(websiteID, settings)

Veja o exemplo

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

Resolva o domínio helpdesk [ user ]: referência

CrispClient.website.resolveHelpdeskDomain(websiteID)

Veja o exemplo

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

CrispClient . website . resolveHelpdeskDomain ( websiteID ) ;

Solicite HelpDesk Domínio Alterar [ user ]: Referência

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

Veja o exemplo

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

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

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

Gere fluxo de configuração do domínio helpdesk [ user ]: referência

CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

Veja o exemplo

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

var custom = "help.valeriansaliou.name" ;

CrispClient . website . generateHelpdeskDomainSetupFlow ( websiteID , custom ) ;

Base do site

Verifique se o site existe [ user , plugin ]: referência
- CrispClient.website.checkWebsiteExists(domain)
- Veja o exemplo
```
 CrispClient . website . checkWebsiteExists ( domain ) ;
```
Criar site [ user ]: Referência
- CrispClient.website.createWebsite(websiteData)
- Veja o exemplo
```
 CrispClient . website . createWebsite ( websiteData ) ;
```

Obtenha um site [ user , plugin ]: referência

CrispClient.website.getWebsite(websiteID)

Veja o exemplo

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

CrispClient . website . getWebsite ( websiteID ) ;

Exclua um site [ user ]: referência

CrispClient.website.deleteWebsite(websiteID, verify)

Veja o exemplo

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

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

CrispClient . website . deleteWebsite ( websiteID , verify ) ;

Aparar a exclusão do site [ user ]: Referência

CrispClient.website.abortWebsiteDeletion(websiteID)

Veja o exemplo

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

CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

Configurações do site

Obtenha configurações do site [ user , plugin ]: Referência

CrispClient.website.getWebsiteSettings(websiteID)

Veja o exemplo

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

CrispClient . website . getWebsiteSettings ( websiteID ) ;

Atualize as configurações do site [ user , plugin ]: Referência

CrispClient.website.updateWebsiteSettings(websiteID, settings)

Veja o exemplo

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

Operador de site

List Operadores do site [ user , plugin ]: Referência

CrispClient.website.listWebsiteOperators(websiteID)

Veja o exemplo

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

CrispClient . website . listWebsiteOperators ( websiteID ) ;

Liste os últimos operadores de sites ativos [ user , plugin ]: Referência
- CrispClient.website.listLastActiveWebsiteOperators(websiteID)
- Veja o exemplo
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

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

Last Last Active Site Operams [ user ]: Referência

CrispClient.website.flushLastActiveWebsiteOperators(websiteID)

Veja o exemplo

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

CrispClient . website . flushLastActiveWebsiteOperators ( websiteID ) ;

Envie email para operadores de sites [ user , plugin ]: Referência

CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

Veja o exemplo

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

Obtenha um operador de site [ user , plugin ]: Referência

CrispClient.website.getWebsiteOperator(websiteID, userID)

Veja o exemplo

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

CrispClient . website . getWebsiteOperator ( websiteID , userID ) ;

Convide um operador de site [ user ]: Referência

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

Veja o exemplo

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

Alterar a associação ao operador [ user ]: referência

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

Veja o exemplo

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

Operador desvinculado do site [ user ]: Referência

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

Veja o exemplo

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

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

Visitantes do site

Conte visitantes [ user , plugin ]: Referência

CrispClient.website.countVisitors(websiteID)

Veja o exemplo

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

CrispClient . website . countVisitors ( websiteID ) ;

Listar visitantes [ user , plugin ]: Referência

CrispClient.website.listVisitors(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listVisitors ( websiteID , pageNumber ) ;

Identificar visitantes em um mapa [ user , plugin ]: referência

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

Veja o exemplo

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

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

Obtenha o identificador de sessão do token [ user , plugin ]: referência

CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)

Veja o exemplo

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

CrispClient . website . getSessionIdentifierFromToken ( websiteID , tokenID ) ;

Visitantes bloqueados da contagem [ user ]: referência
- CrispClient.website.countBlockedVisitors(websiteID)

Count Bloqueou visitantes na regra [ user ]: Referência

CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)

Veja o exemplo

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

CrispClient . website . countBlockedVisitorsInRule ( websiteID , rule ) ;

Visitantes claros bloqueados na regra [ user ]: referência

CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)

Veja o exemplo

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

CrispClient . website . clearBlockedVisitorsInRule ( websiteID , rule ) ;

Disponibilidade do site
- Obtenha status de disponibilidade do site [ user , plugin ]: Referência
  - CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
  - Veja o exemplo
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;
- LISTA OPERADOR DE SITE OPERADORES DA OPERADORES [ user , plugin ]: Referência
  - CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
  - Veja o exemplo
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;

Análise de sites

GERERATE ANÁLISICA [ user ]: Referência

CrispClient.website.generateAnalytics(websiteID, query)

Veja o exemplo

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

CrispClient . website . generateAnalytics ( websiteID , query ) ;

Lote de sites

Conversas de resolução em lote [ user ]: referência

CrispClient.website.batchResolveConversations(websiteID, operation)

Veja o exemplo

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

Conversas de leitura em lote [ user ]: Referência

CrispClient.website.batchReadConversations(websiteID, operation)

Veja o exemplo

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

Lotes Remover conversas [ user ]: Referência

CrispClient.website.batchRemoveConversations(websiteID, operation)

Veja o exemplo

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

Lote Remover pessoas [ user ]: referência

CrispClient.website.batchRemovePeople(websiteID, people)

Veja o exemplo

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

Site verifique

Obtenha configurações de verificação [ user , plugin ]: Referência

CrispClient.website.getVerifySettings(websiteID)

Veja o exemplo

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

CrispClient . website . getVerifySettings ( websiteID ) ;

Atualizar configurações de verificação [ user , plugin ]: Referência

CrispClient.website.updateVerifySettings(websiteID, settings)

Veja o exemplo

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

var settings = {
  "enabled" : true
} ;

CrispClient . website . updateVerifySettings ( websiteID , settings ) ;

Obtenha a chave verificada [ user , plugin ]: referência

CrispClient.website.getVerifyKey(websiteID)

Veja o exemplo

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

CrispClient . website . getVerifyKey ( websiteID ) ;

Chave de verificação do rolo [ user , plugin ]: Referência

CrispClient.website.rollVerifyKey(websiteID)

Veja o exemplo

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

CrispClient . website . rollVerifyKey ( websiteID ) ;

Campanhas do site

Campanhas de lista [ user ]: referência

CrispClient.website.listCampaigns(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listCampaigns ( websiteID , pageNumber ) ;

Listar tags de campanha [ user ]: referência

CrispClient.website.listCampaignTags(websiteID)

Veja o exemplo

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

CrispClient . website . listCampaignTags ( websiteID ) ;

Listar modelos de campanha [ user , plugin ]: Referência

CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

Veja o exemplo

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

CrispClient . website . listCampaignTemplates ( websiteID , pageNumber ) ;

Crie um novo modelo de campanha [ user , plugin ]: Referência

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

Veja o exemplo

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

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

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

Verifique se o modelo de campanha existe [ user , plugin ]: referência

CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

Veja o exemplo

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

CrispClient . website . checkCampaignTemplateExists ( websiteID , templateID ) ;

Obtenha um modelo de campanha [ user , plugin ]: referência

CrispClient.website.getCampaignTemplate(websiteID, templateID)

Veja o exemplo

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

CrispClient . website . getCampaignTemplate ( websiteID , templateID ) ;

Salve um modelo de campanha [ user , plugin ]: Referência

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

Veja o exemplo

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

Atualize um modelo de campanha [ user , plugin ]: Referência

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

Veja o exemplo

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

Remova um modelo de campanha [ user , plugin ]: Referência

CrispClient.website.removeCampaignTemplate(websiteID, templateID)

Veja o exemplo

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

CrispClient . website . removeCampaignTemplate ( websiteID , templateID ) ;

Campanha do site

Crie uma nova campanha [ user ]: referência

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

Veja o exemplo

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

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

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

Verifique se a campanha existe [ user ]: referência

CrispClient.website.checkCampaignExists(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . checkCampaignExists ( websiteID , campaignID ) ;

Obtenha uma campanha [ user ]: referência

CrispClient.website.getCampaign(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . getCampaign ( websiteID , campaignID ) ;

Salvar uma campanha [ user ]: referência

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

Veja o exemplo

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

Atualize uma campanha [ user ]: referência

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

Veja o exemplo

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

Remova uma campanha [ user ]: referência

CrispClient.website.removeCampaign(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . removeCampaign ( websiteID , campaignID ) ;

Despacha uma campanha [ user ]: referência

CrispClient.website.dispatchCampaign(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . dispatchCampaign ( websiteID , campaignID ) ;

Retomar uma campanha [ user ]: referência

CrispClient.website.resumeCampaign(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . resumeCampaign ( websiteID , campaignID ) ;

Pause uma campanha [ user ]: referência

CrispClient.website.pauseCampaign(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . pauseCampaign ( websiteID , campaignID ) ;

Teste uma campanha [ user ]: referência

CrispClient.website.testCampaign(websiteID, campaignID)

Veja o exemplo

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

CrispClient . website . testCampaign ( websiteID , campaignID ) ;

Recebedores de campanha de lista [ user ]: Referência

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

Veja o exemplo

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

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

Lista de estatísticas da campanha [ user ]: referência

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

Veja o exemplo

 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

Connect Plugin Connect
- Get Connect Conta [ plugin ]: Referência
  - CrispClient.plugin.getConnectAccount()
  - Veja o exemplo
    CrispClient . plugin . getConnectAccount ( ) ;
- Verifique a validade da sessão de conexão [ plugin ]: referência
  - CrispClient.plugin.checkConnectSessionValidity()
  - Veja o exemplo
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- Liste todos os sites de conexão [ plugin ]: referência
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - Veja o exemplo
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- Lista Connecte sites desde o [ plugin ]: referência
  - CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
  - Veja o exemplo
    var dateSince = "2023-08-16T09:00:00Z" ; CrispClient . plugin . listConnectWebsitesSince ( dateSince , filterConfigured ) ;
- Obtenha pontos de extremidade de conexão [ plugin ]: referência
  - CrispClient.plugin.getConnectEndpoints()
  - Veja o exemplo
    CrispClient . plugin . getConnectEndpoints ( ) ;

Assinatura do plug -in

Liste todas as assinaturas ativas [ user ]: referência
- CrispClient.plugin.listAllActiveSubscriptions()
- Veja o exemplo
```
 CrispClient . plugin . listAllActiveSubscriptions ( ) ;
```

Liste assinaturas para um site [ user ]: referência

CrispClient.plugin.listSubscriptionsForWebsite(websiteID)

Veja o exemplo

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

CrispClient . plugin . listSubscriptionsForWebsite ( websiteID ) ;

Obtenha detalhes de assinatura [ user , plugin ]: Referência

CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

Veja o exemplo

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

CrispClient . plugin . getSubscriptionDetails ( websiteID , pluginID ) ;

Inscreva -se site para plugin [ user ]: Referência

CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

Veja o exemplo

 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 cancelamento de inscrição do site [ user ]: Referência

CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

Veja o exemplo

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

CrispClient . plugin . unsubscribePluginFromWebsite ( websiteID , pluginID ) ;

Obtenha configurações de assinatura [ user , plugin ]: Referência

CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

Veja o exemplo

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

CrispClient . plugin . getSubscriptionSettings ( websiteID , pluginID ) ;

Salvar configurações de assinatura [ user , plugin ]: Referência

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

Veja o exemplo

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

Atualize Configurações de assinatura [ user , plugin ]: Referência

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

Veja o exemplo

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

Obtenha contas de uso do plug -in [ user , plugin ]: Referência

CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

Veja o exemplo

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

CrispClient . plugin . getPluginUsageBills ( websiteID , pluginID ) ;

Relatório Uso do plug -in para Bill [ plugin ]: Referência

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

Veja o exemplo

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

Carga útil do plug -in encaminhante para canal [ user , plugin ]: referência

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

Veja o exemplo

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

Evento de plug -in de expedição [ user , plugin ]: Referência

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

Veja o exemplo

 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ídia

Animação da mídia

Mídias de animação da lista [ user ]: referência

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

Veja o exemplo

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

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

Balde

URL do balde
- Gere URL do balde [ user , plugin ]: Referência
  - CrispClient.bucket.generateBucketURL(data)
  - Veja o exemplo
    CrispClient . bucket . generateBucketURL ( data ) ;

Eventos em tempo real

Você pode vincular a eventos em tempo real da CRISP, a fim de ser notificado sobre mensagens e atualizações recebidas em sites.

Você não receberá nenhum evento se não se inscrever explicitamente nos eventos em tempo real, pois a biblioteca não se conecta ao back -end em tempo real automaticamente.

Existem duas maneiras de receber eventos em tempo real:

Usando ganchos da web ( recomendado )
Usando websockets com a API RTM

Antes de começar com os eventos da RTM, considere o seguinte:

Você não receberá nenhum evento se não se inscrever explicitamente nos eventos em tempo real usando CrispClient.on() , pois a biblioteca não se conecta ao back -end em tempo real automaticamente. Este método retorna um objeto Promise .
Sempre que a lista de sites que seu token de autenticação tem o direito de receber eventos para alterações, você precisará chamar CrispClient.rebindSocket() . Este método também retorna um objeto Promise . Isso se aplica apenas ao WebSockets com a API RTM .

Receba eventos em tempo real

Receba eventos por ganchos da web

Para começar a ouvir eventos e vincular um manipulador, confira os eventos sobre o exemplo dos ganchos da web.

Você precisará ajustar seu código para que:

O modo de eventos RTM está definido como ganchos da web: CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
Seu endpoint HTTP monta uma rota ouvindo solicitações de postagem e, ao receber solicitações:
1. Ele verifica as solicitações com: CrispClient.verifyHook(secret, body, timestamp, signature)
2. Recebe o gancho da web com: CrispClient.receiveHook(body)

Os ganchos da web do plug -in precisarão ser configurados primeiro para que isso funcione. Confira nosso guia Quickstart do Web Hooks e nossa referência de ganchos da web para começar.

Receba eventos sobre o WebSockets (RTM API)

Para começar a ouvir eventos e vincular um manipulador, confira os eventos no exemplo do WebSockets.

Você precisará ajustar seu código para que:

O modo de eventos RTM é definido como websockets: CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

Eventos em tempo real disponíveis

Os eventos disponíveis estão listados abaixo:

Eventos de sessão : referência
- Atualização da sessão Disponibilidade [ user , plugin ]:
  - session:update_availability
- Atualização da sessão Verifique [ user , plugin ]:
  - session:update_verify
- Solicitação de sessão iniciada [ user , plugin ]:
  - session:request:initiated
- Conjunto de sessões email [ user , plugin ]:
  - session:set_email
- Set Set Set Phone [ user , plugin ]:
  - session:set_phone
- Endereço do conjunto de sessões [ user , plugin ]:
  - session:set_address
- Conjunto de sessões Assunto [ user , plugin ]:
  - session:set_subject
- Conjunto de sessões Avatar [ user , plugin ]:
  - session:set_avatar
- Conjunto de sessões apelido [ user , plugin ]:
  - session:set_nickname
- Dados do conjunto de sessões [ user , plugin ]:
  - session:set_data
- Páginas de sincronização de sessão [ user , plugin ]:
  - session:sync:pages
- Eventos de sincronização de sessão [ user , plugin ]:
  - session:sync:events
- Recursos de sincronização de sessão [ user , plugin ]:
  - session:sync:capabilities
- Geolocation de sincronização de sessão [ user , plugin ]:
  - session:sync:geolocation
- Sistema de sincronização de sessão [ user , plugin ]:
  - session:sync:system
- Rede de sincronização de sessão [ user , plugin ]:
  - session:sync:network
- Fuzão horário de sincronização da sessão [ user , plugin ]:
  - session:sync:timezone
- Locais de sincronização da sessão [ user , plugin ]:
  - session:sync:locales
- Classificação de sincronização da sessão [ user , plugin ]:
  - session:sync:rating
- Tópico de sincronização da sessão [ user , plugin ]:
  - session:sync:topic
- Estado do conjunto de sessões [ user , plugin ]:
  - session:set_state
- Conjunto de sessões Block [ user , plugin ]:
  - session:set_block
- Segmentos de conjunto de sessões [ user , plugin ]:
  - session:set_segments
- Conjunto de sessões aberto [ user , plugin ]:
  - session:set_opened
- Conjunto de sessões fechado [ user , plugin ]:
  - session:set_closed
- Conjunto de sessões Participantes [ user , plugin ]:
  - session:set_participants
- Conjunto de sessões menciona [ user , plugin ]:
  - session:set_mentions
- Conjunto de sessões Routing [ user , plugin ]:
  - session:set_routing
- Sessão Definir caixa de entrada [ user , plugin ]:
  - session:set_inbox
- Sessão removida [ user , plugin ]:
  - session:removed
Eventos de mensagem : referência
- Mensagem atualizada [ user , plugin ]:
  - message:updated
- Mensagem Enviar [ user , plugin ]:
  - message:send
- Mensagem recebida [ user , plugin ]:
  - message:received
- Mensagem removida [ user , plugin ]:
  - message:removed
- Mensagem compor Enviar [ user , plugin ]:
  - message:compose:send
- Mensagem Componha receber [ user , plugin ]:
  - message:compose:receive
- Mensagem Reconheça Leia Send [ user , plugin ]:
  - message:acknowledge:read:send
- Mensagem Reconheça Leia Recebida [ user , plugin ]:
  - message:acknowledge:read:received
- Mensagem Reconheça entregue [ user , plugin ]:
  - message:acknowledge:delivered
- Mensagem Notify UNHEREN Send [ user , plugin ]:
  - message:notify:unread:send
- Mensagem notifique não lido recebido [ user , plugin ]:
  - message:notify:unread:received
Eventos de spam : referência
- Mensagem de spam [ user ]:
  - spam:message
- Decisão de spam [ user ]:
  - spam:decision
Eventos de pessoas : referência
- Perfil das pessoas criado [ user , plugin ]:
  - people:profile:created
- Perfil de pessoas atualizado [ user , plugin ]:
  - people:profile:updated
- Perfil das pessoas removido [ user , plugin ]:
  - people:profile:removed
- As pessoas vinculam sessão [ user , plugin ]:
  - people:bind:session
- Perfil de sincronização de pessoas [ user , plugin ]:
  - people:sync:profile
- As pessoas importam progresso [ user ]:
  - people:import:progress
- As pessoas importam [ user ]:
  - people:import:done
Eventos de campanha : referência
- Progresso da campanha [ user ]:
  - campaign:progress
- Campanha despachada [ user ]:
  - campaign:dispatched
- Campanha em execução [ user ]:
  - campaign:running
Eventos de navegação : referência
- Solicitação de navegação iniciada [ user , plugin ]:
  - browsing:request:initiated
- Solicitação de navegação rejeitada [ user , plugin ]:
  - browsing:request:rejected
Chamada Eventos : Referência
- Solicitação de chamada iniciada [ user , plugin ]:
  - call:request:initiated
- Solicitação de chamada rejeitada [ user , plugin ]:
  - call:request:rejected
Eventos de widget : referência
- Ação do widget Processada [ user ]:
  - widget:action:processed
Eventos de status : referência
- Saúde do status alterou [ user ]:
  - status:health:changed
Eventos do site : referência
- Atualização do site Visitantes Count [ user , plugin ]:
  - website:update_visitors_count
- Disponibilidade dos operadores de atualização do site [ user , plugin ]:
  - website:update_operators_availability
- Usuários do site disponíveis [ user , plugin ]:
  - website:users:available
Eventos de balde : referência
- URL do bucket upload gerado [ user , plugin ]:
  - bucket:url:upload:generated
- Avatar de URL do balde gerado [ user , plugin ]:
  - bucket:url:avatar:generated
- Site de URL do balde gerado [ user , plugin ]:
  - bucket:url:website:generated
- Campanha Bucket URL gerada [ user , plugin ]:
  - bucket:url:campaign:generated
- Bucket URL Helpdesk gerado [ user , plugin ]:
  - bucket:url:helpdesk:generated
- Status do URL do balde gerado [ user , plugin ]:
  - bucket:url:status:generated
- Processamento de URL do balde gerado [ user , plugin ]:
  - bucket:url:processing:generated
Eventos de mídia : referência
- Animação de mídia listada [ user ]:
  - media:animation:listed
Eventos de e -mail : referência
- E -mail assinando [ user , plugin ]:
  - email:subscribe
- Visualização de faixa de e -mail [ user , plugin ]:
  - email:track:view
Eventos de plug -in : referência
- Canal do plug -in [ user , plugin ]:
  - plugin:channel
- Evento de plug -in [ user , plugin ]:
  - plugin:event
- Configurações do plug -in salva [ user , plugin ]:
  - plugin:settings:saved

Expandir

node crisp api

Wrapper Crisp API

Instalação

Autenticação

Visão geral

Exemplos

Crie seu próprio bot!

Métodos de recursos

Site

Conversas no site

Conversação do site

O pessoal do site (esses são seus usuários finais)

Helpdesk do site

Base do site

Configurações do site

Operador de site

Visitantes do site

Disponibilidade do site

Análise de sites

Lote de sites

Site verifique

Campanhas do site

Campanha do site

Plugin

Connect Plugin Connect

Assinatura do plug -in

Mídia

Animação da mídia

Balde

URL do balde

Eventos em tempo real

Receba eventos em tempo real

Receba eventos por ganchos da web

Receba eventos sobre o WebSockets (RTM API)

Eventos em tempo real disponíveis

Eventos de sessão : referência

Eventos de mensagem : referência

Eventos de spam : referência

Eventos de pessoas : referência

Eventos de campanha : referência

Eventos de navegação : referência

Chamada Eventos : Referência

Eventos de widget : referência

Eventos de status : referência

Eventos do site : referência

Eventos de balde : referência

Eventos de mídia : referência

Eventos de e -mail : referência

Eventos de plug -in : referência