node crisp api下载 - node crisp api源代码下载

酥脆的API包装器

酥脆的API节点包装器。从JavaScript代码进行身份验证，发送消息，获取对话，访问您的代理帐户。

版权2024 Crisp Im Sas。复制信息，请参阅许可证。

工具：修订版中的REST API参考（V1）：17/10/2024
？维护者：@baptistejamin， @eliottvincent，@valeriansaliou

安装

npm install --save crisp-api

验证

要针对API进行身份验证，请遵循REST API身份验证指南，获取您的身份验证令牌Keypair。您将获得由2个值制成的令牌键盘。

将您的令牌Keypair值保持私有，并安全存储以供长期使用。

然后，在创建它之后立即将身份验证参数添加到您的client实例：

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

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

// Now, you can use authenticated API sections.

概述

您可以遵循REST API快速启动指南，这将使您在几分钟内使用REST API运行。

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

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

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

例子

创建自己的机器人！

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

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

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

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

资源方法

所有可用的CRISP API资源均已完全实施。编程方法名称在REST API参考中以其标签名称命名。

构建清晰集成时您最可能需要的所有方法都带有星形符号（）。

配x请注意，根据您的身份验证令牌（即user或plugin ，您可能不允许您使用库中的所有方法。如有疑问，请参阅下面的库方法描述。您最有可能使用plugin令牌。

网站

网站对话
网站对话
网站人员
网站Helpdesk
网站操作员
网站可用性
网站分析
网站批次
网站验证
网站广告系列
网站广告系列

插件

插件连接
插件订阅

媒体

媒体动画

桶

水桶URL

RTM事件

会话事件
消息事件
人们活动
竞选活动
浏览事件
呼叫事件
小部件事件
状态事件
网站活动
水桶事件
媒体活动
电子邮件事件
插件事件

网站

网站对话

列表对话[ user ， plugin ]：参考

CrispClient.website.listConversations(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listConversations ( websiteID , pageNumber ) ;

列表建议的对话段[ user ， plugin ]：参考

CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listSuggestedConversationSegments ( websiteID , pageNumber ) ;

删除建议的对话段[ user ， plugin ]：参考

CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)

请参见示例

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

var segment = "bug" ;

CrispClient . website . deleteSuggestedConversationSegment ( websiteID , segment ) ;

列表建议的对话数据键[ user ， plugin ]：参考

CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listSuggestedConversationDataKeys ( websiteID , pageNumber ) ;

删除建议的对话数据密钥[ user ， plugin ]：参考

CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)

请参见示例

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

var key = "price" ;

CrispClient . website . deleteSuggestedConversationDataKey ( websiteID , key ) ;

列出垃圾邮件对话[ user ]：参考

CrispClient.website.listSpamConversations(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listSpamConversations ( websiteID , pageNumber ) ;

解决垃圾邮件对话内容[ user ]：参考

CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

请参见示例

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

CrispClient . website . resolveSpamConversationContent ( websiteID , spamID ) ;

提交垃圾邮件对话决定[ user ]：参考

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

请参见示例

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

var action = "reject" ;

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

网站对话

创建一个新的对话[ user ， plugin ]：参考

CrispClient.website.createNewConversation(websiteID)

请参见示例

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

CrispClient . website . createNewConversation ( websiteID ) ;

检查对话是否存在[ user ， plugin ]：参考

CrispClient.website.checkConversationExists(websiteID, sessionID)

请参见示例

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

CrispClient . website . checkConversationExists ( websiteID , sessionID ) ;

进行对话[ user ， plugin ]：参考

CrispClient.website.getConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . getConversation ( websiteID , sessionID ) ;

删除对话[ user ， plugin ]：参考

CrispClient.website.removeConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . removeConversation ( websiteID , sessionID ) ;

与现有会话[ user ， plugin ]进行对话：参考

CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

请参见示例

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

CrispClient . website . initiateConversationWithExistingSession ( websiteID , sessionID ) ;

在对话中获取消息[ user ， plugin ]：参考

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

请参见示例

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

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

在对话中发送一条消息[ user ， plugin ]：参考

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

请参见示例

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

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

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

在对话中获取一条消息[ user ， plugin ]：参考

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

请参见示例

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

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

在对话中更新消息[ user ， plugin ]：参考

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

请参见示例

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

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

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

在对话中删除消息[ user ， plugin ]：参考

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

请参见示例

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

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

在对话中撰写消息[ user ， plugin ]：参考

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

请参见示例

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

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

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

将消息标记为对话中的消息[ user ， plugin ]：参考

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

请参见示例

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

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

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

标记对话中传递的消息[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新对话打开状态[ user ， plugin ]：参考

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

请参见示例

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

var opened = true ;

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

获取对话路由分配[ user ， plugin ]：参考

CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

请参见示例

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

CrispClient . website . getConversationRoutingAssign ( websiteID , sessionID ) ;

分配对话路由[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新对话收件箱[ user ， plugin ]：参考

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

请参见示例

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

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

获取对话元[ user ， plugin ]：参考

CrispClient.website.getConversationMetas(websiteID, sessionID)

请参见示例

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

CrispClient . website . getConversationMetas ( websiteID , sessionID ) ;

更新对话元[ user ， plugin ]：参考

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

请参见示例

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

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

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

在对话中获取一条原始消息[ user ， plugin ]：参考

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

请参见示例

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

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

列出对话页面[ user ， plugin ]：参考

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

请参见示例

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

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

列出对话事件[ user ， plugin ]：参考

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

请参见示例

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

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

列出对话文件[ user ， plugin ]：参考

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

请参见示例

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

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

获取对话状态[ user ， plugin ]：参考

CrispClient.website.getConversationState(websiteID, sessionID)

请参见示例

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

CrispClient . website . getConversationState ( websiteID , sessionID ) ;

更改对话状态[ user ， plugin ]：参考

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

请参见示例

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

var state = "unresolved" ;

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

获取对话参与者[ user ， plugin ]：参考

CrispClient.website.getConversationParticipants(websiteID, sessionID)

请参见示例

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

CrispClient . website . getConversationParticipants ( websiteID , sessionID ) ;

保存对话参与者[ user ， plugin ]：参考

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

请参见示例

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

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

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

获取对话的块状态[ user ， plugin ]：参考

CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . getBlockStatusForConversation ( websiteID , sessionID ) ;

对话的块传入消息[ user ， plugin ]：参考

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

请参见示例

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

var blocked = true ;

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

获取对话的验证状态[ user ， plugin ]：参考

CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . getVerifyStatusForConversation ( websiteID , sessionID ) ;

更新对话的验证状态[ user ， plugin ]：参考

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

请参见示例

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

var verified = true ;

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

请求对话的电子邮件成绩单[ user ， plugin ]：参考

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

请参见示例

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

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

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

请求聊天框绑定清除对话[ user ， plugin ]：参考

CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . requestChatboxBindingPurgeForConversation ( websiteID , sessionID ) ;

请求对话的用户反馈[ user ， plugin ]：参考

CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . requestUserFeedbackForConversation ( websiteID , sessionID ) ;

列出对话的浏览会话[ user ， plugin ]：参考

CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . listBrowsingSessionsForConversation ( websiteID , sessionID ) ;

启动浏览会话以进行对话[ user ， plugin ]：参考

CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . initiateBrowsingSessionForConversation ( websiteID , sessionID ) ;

将操作发送到现有的浏览会话[ user ， plugin ]：参考

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

请参见示例

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

var action = "start" ;

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

协助现有的浏览会话[ user ， plugin ]：参考

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

请参见示例

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

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

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

启动对话的新呼叫会话[ user ， plugin ]：参考

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

请参见示例

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

var mode = "audio" ;

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

获取对话的持续电话会话[ user ， plugin ]：参考

CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

请参见示例

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

CrispClient . website . getOngoingCallSessionForConversation ( websiteID , sessionID ) ;

中止对话的正在进行的呼叫会话[ user ， plugin ]：参考

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

请参见示例

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

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

在正在进行的呼叫会话上传输信号[ user ， plugin ]：参考

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

请参见示例

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

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

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

提供对话的小部件按钮操作[ user ]：参考

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

请参见示例

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

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

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

交付小部件数据获取对话[ user ]：参考

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

请参见示例

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

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

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

提供对话的小部件数据编辑操作[ user ]：参考

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

请参见示例

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

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

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

安排对话的提醒[ user ， plugin ]：参考

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

请参见示例

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

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

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

网站人员（这些是您的最终用户）

获取人员统计[ user ， plugin ]：参考

CrispClient.website.getPeopleStatistics(websiteID)

请参见示例

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

CrispClient . website . getPeopleStatistics ( websiteID ) ;

列表建议的人段[ user ， plugin ]：参考

CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listSuggestedPeopleSegments ( websiteID , pageNumber ) ;

删除建议的人员细分[ user ， plugin ]：参考

CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

请参见示例

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

var segment = "poweruser" ;

CrispClient . website . deleteSuggestedPeopleSegment ( websiteID , segment ) ;

列表建议的人数据键[ user ， plugin ]：参考

CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listSuggestedPeopleDataKeys ( websiteID , pageNumber ) ;

删除建议的人员数据密钥[ user ， plugin ]：参考

CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)

请参见示例

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

var key = "price" ;

CrispClient . website . deleteSuggestedPeopleDataKey ( websiteID , key ) ;

列表建议的人事件[ user ， plugin ]：参考

CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listSuggestedPeopleEvents ( websiteID , pageNumber ) ;

删除建议的人员活动[ user ， plugin ]：参考

CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

请参见示例

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

var text = "Removed item from basket" ;

CrispClient . website . deleteSuggestedPeopleEvent ( websiteID , text ) ;

列出人们个人资料[ user ， plugin ]：参考

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

请参见示例

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

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

添加新人资料[ user ， plugin ]：参考

CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

请参见示例

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

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

CrispClient . website . addNewPeopleProfile ( websiteID , peopleProfile ) ;

检查人员个人资料是否存在[ user ， plugin ]：参考

CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

请参见示例

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

CrispClient . website . checkPeopleProfileExists ( websiteID , peopleID ) ;

获取人员个人资料[ user ， plugin ]：参考

CrispClient.website.getPeopleProfile(websiteID, peopleID)

请参见示例

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

CrispClient . website . getPeopleProfile ( websiteID , peopleID ) ;

保存人资料[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新人员资料[ user ， plugin ]：参考

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

请参见示例

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

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

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

删除人员资料[ user ， plugin ]：参考

CrispClient.website.removePeopleProfile(websiteID, peopleID)

请参见示例

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

CrispClient . website . removePeopleProfile ( websiteID , peopleID ) ;

列出人们对话[ user ， plugin ]：参考

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

请参见示例

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

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

列出人们广告系列[ user ]：参考

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

请参见示例

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

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

添加一个人事件[ user ， plugin ]：参考

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

请参见示例

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

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

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

列出人们事件[ user ， plugin ]：参考

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

请参见示例

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

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

获取人员数据[ user ， plugin ]：参考

CrispClient.website.getPeopleData(websiteID, peopleID)

请参见示例

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

CrispClient . website . getPeopleData ( websiteID , peopleID ) ;

保存人数据[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新人员数据[ user ， plugin ]：参考

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

请参见示例

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

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

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

获取人员订阅状态[ user ， plugin ]：参考

CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

请参见示例

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

CrispClient . website . getPeopleSubscriptionStatus ( websiteID , peopleID ) ;

更新人员订阅状态[ user ， plugin ]：参考

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

请参见示例

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

var peopleSubscription = {
  "email" : true
} ;

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

导出人员个人资料[ user ]：参考

CrispClient.website.exportPeopleProfiles(websiteID)

请参见示例

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

CrispClient . website . exportPeopleProfiles ( websiteID ) ;

进口人员个人资料[ user ]：参考

CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

请参见示例

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

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

CrispClient . website . importPeopleProfiles ( websiteID , profileImportSetup ) ;

请注意： peopleID论点可以是电子邮件或peopleID 。

网站Helpdesk

检查HelpDesk是否存在[ user ， plugin ]：参考

CrispClient.website.checkHelpdeskExists(websiteID)

请参见示例

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

CrispClient . website . checkHelpdeskExists ( websiteID ) ;

解析HelpDesk [ user ， plugin ]：参考

CrispClient.website.resolveHelpdesk(websiteID)

请参见示例

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

CrispClient . website . resolveHelpdesk ( websiteID ) ;

初始化helpdesk [ user ]：参考

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

请参见示例

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

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

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

删除helpdesk [ user ]：参考

CrispClient.website.deleteHelpdesk(websiteID, verify)

请参见示例

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

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

CrispClient . website . deleteHelpdesk ( websiteID , verify ) ;

列出Helpdesk Locales [ user ， plugin ]：参考

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

请参见示例

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

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

添加Helpdesk Locale [ user ， plugin ]：参考

CrispClient.website.addHelpdeskLocale(websiteID, locale)

请参见示例

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

var locale = "en" ;

CrispClient . website . addHelpdeskLocale ( websiteID , locale ) ;

检查HelpDesk语言环境是否存在[ user ， plugin ]：参考

CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)

请参见示例

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

var locale = "en" ;

CrispClient . website . checkHelpdeskLocaleExists ( websiteID , locale ) ;

解析HelpDesk Locale [ user ， plugin ]：参考

CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

请参见示例

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

var locale = "en" ;

CrispClient . website . resolveHelpdeskLocale ( websiteID , locale ) ;

删除HelpDesk Locale [ user ， plugin ]：参考

CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

请参见示例

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

var locale = "en" ;

CrispClient . website . deleteHelpdeskLocale ( websiteID , locale ) ;

列出HelpDesk语言环境文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

添加新的Helpdesk语言环境文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

检查HelpDesk Locale文章是否存在[ user ， plugin ]：参考

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

请参见示例

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

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

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

解析HelpDesk Locale文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

保存Helpdesk Locale文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

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

更新HelpDesk Locale文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

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

删除HelpDesk Locale文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

解析HelpDesk语言环境文章页面[ user ， plugin ]：参考

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

请参见示例

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

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

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

解析HelpDesk语言环境文章类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新HelpDesk语言环境文章类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

列出HelpDesk Locale文章替代[ user ， plugin ]：参考

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

请参见示例

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

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

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

检查HelpDesk Locale文章是否存在[ user ， plugin ]：参考

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

请参见示例

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

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

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

解析HelpDesk Locale文章备用[ user ， plugin ]：参考

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

请参见示例

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

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

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

保存Helpdesk Locale文章备用[ user ， plugin ]：参考

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

请参见示例

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

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

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

删除HelpDesk Locale文章备用[ user ， plugin ]：参考

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

请参见示例

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

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

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

发布Helpdesk Locale文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

未发布的HelpDesk语言环境文章[ user ， plugin ]：参考

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

请参见示例

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

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

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

列表HelpDesk语言环境类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

添加Helpdesk Locale类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

检查HelpDesk语言环境类别是否存在[ user ， plugin ]：参考

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

请参见示例

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

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

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

解析HelpDesk语言环境类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

保存HelpDesk语言环境类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

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

更新HelpDesk语言环境类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

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

删除HelpDesk语言环境类别[ user ， plugin ]：参考

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

请参见示例

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

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

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

列出HelpDesk语言环境部分[ user ， plugin ]：参考

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

请参见示例

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

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

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

添加Helpdesk语言环境部分[ user ， plugin ]：参考

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

请参见示例

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

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

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

检查HelpDesk语言环境部分是否存在[ user ， plugin ]：参考

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

请参见示例

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

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

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

解析HelpDesk语言环境部分[ user ， plugin ]：参考

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

请参见示例

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

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

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

保存HelpDesk语言环境部分[ user ， plugin ]：参考

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

请参见示例

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

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

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

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

更新HelpDesk语言环境部分[ user ， plugin ]：参考

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

请参见示例

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

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

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

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

删除HelpDesk语言环境部分[ user ， plugin ]：参考

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

请参见示例

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

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

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

地图HelpDesk语言反馈评分[ user ， plugin ]：参考

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

请参见示例

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

var locale = "en" ;

CrispClient . website . mapHelpdeskLocaleFeedbackRatings ( websiteID , locale ) ;

列出HelpDesk语言反馈[ user ， plugin ]：参考

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

请参见示例

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

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

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

导入外部帮助台到语言环境[ user ]：参考

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

请参见示例

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

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

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

导出服务台语言环境文章[ user ]：参考

CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)

请参见示例

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

var locale = "en" ;

CrispClient . website . exportHelpdeskLocaleArticles ( websiteID , locale ) ;

列出帮助台重定向[ user ， plugin ]：参考

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

添加帮助台重定向[ user ， plugin ]：参考

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

请参见示例

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

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

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

检查HelpDesk重定向是否存在[ user ， plugin ]：参考

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

请参见示例

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

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

解析帮助台重定向[ user ， plugin ]：参考

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

请参见示例

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

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

删除帮助台重定向[ user ， plugin ]：参考

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

请参见示例

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

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

解析HelpDesk设置[ user ， plugin ]：参考

CrispClient.website.resolveHelpdeskSettings(websiteID)

请参见示例

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

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;

保存帮助台设置[ user ， plugin ]：参考

CrispClient.website.saveHelpdeskSettings(websiteID, settings)

请参见示例

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

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

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

    "banner" : null
  } ,

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

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

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

CrispClient . website . saveHelpdeskSettings ( websiteID , settings ) ;

解析HelpDesk域[ user ]：参考

CrispClient.website.resolveHelpdeskDomain(websiteID)

请参见示例

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

CrispClient . website . resolveHelpdeskDomain ( websiteID ) ;

请求HelpDesk域更改[ user ]：参考

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

请参见示例

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

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

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

生成HelpDesk域设置流[ user ]：参考

CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

请参见示例

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

var custom = "help.valeriansaliou.name" ;

CrispClient . website . generateHelpdeskDomainSetupFlow ( websiteID , custom ) ;

网站基础

检查网站是否存在[ user ， plugin ]：参考
- CrispClient.website.checkWebsiteExists(domain)
- 请参见示例
```
 CrispClient . website . checkWebsiteExists ( domain ) ;
```
创建网站[ user ]：参考
- CrispClient.website.createWebsite(websiteData)
- 请参见示例
```
 CrispClient . website . createWebsite ( websiteData ) ;
```

获取网站[ user ， plugin ]：参考

CrispClient.website.getWebsite(websiteID)

请参见示例

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

CrispClient . website . getWebsite ( websiteID ) ;

删除网站[ user ]：参考

CrispClient.website.deleteWebsite(websiteID, verify)

请参见示例

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

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

CrispClient . website . deleteWebsite ( websiteID , verify ) ;

中止网站删除[ user ]：参考

CrispClient.website.abortWebsiteDeletion(websiteID)

请参见示例

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

CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

网站设置

获取网站设置[ user ， plugin ]：参考

CrispClient.website.getWebsiteSettings(websiteID)

请参见示例

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

CrispClient . website . getWebsiteSettings ( websiteID ) ;

更新网站设置[ user ， plugin ]：参考

CrispClient.website.updateWebsiteSettings(websiteID, settings)

请参见示例

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

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

CrispClient . website . updateWebsiteSettings ( websiteID , settings ) ;

网站操作员

列出网站操作员[ user ， plugin ]：参考

CrispClient.website.listWebsiteOperators(websiteID)

请参见示例

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

CrispClient . website . listWebsiteOperators ( websiteID ) ;

列出最后一个活动的网站操作员[ user ， plugin ]：参考

CrispClient.website.listLastActiveWebsiteOperators(websiteID)

请参见示例

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

CrispClient . website . listLastActiveWebsiteOperators ( websiteID ) ;

冲洗最后一个活动的网站运营商[ user ]：参考

CrispClient.website.flushLastActiveWebsiteOperators(websiteID)

请参见示例

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

CrispClient . website . flushLastActiveWebsiteOperators ( websiteID ) ;

将电子邮件发送给网站运营商[ user ， plugin ]：参考

CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

请参见示例

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

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

CrispClient . website . sendEmailToWebsiteOperators ( websiteID , emailData ) ;

获取网站操作员[ user ， plugin ]：参考

CrispClient.website.getWebsiteOperator(websiteID, userID)

请参见示例

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

CrispClient . website . getWebsiteOperator ( websiteID , userID ) ;

邀请网站操作员[ user ]：参考

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

请参见示例

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

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

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

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

更改操作员会员资格[ user ]：参考

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

请参见示例

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

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

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

网站[ user ]的Unlin链接运营商：参考

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

请参见示例

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

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

网站访问者

计数访问者[ user ， plugin ]：参考

CrispClient.website.countVisitors(websiteID)

请参见示例

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

CrispClient . website . countVisitors ( websiteID ) ;

列表访问者[ user ， plugin ]：参考

CrispClient.website.listVisitors(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listVisitors ( websiteID , pageNumber ) ;

在地图上查明访问者[ user ， plugin ]：参考

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

请参见示例

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

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

从令牌[ user ， plugin ]获取会话标识符：参考

CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)

请参见示例

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

CrispClient . website . getSessionIdentifierFromToken ( websiteID , tokenID ) ;

计数阻止访问者[ user ]：参考
- CrispClient.website.countBlockedVisitors(websiteID)

计数在规则[ user ]中阻止访问者：参考

CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)

请参见示例

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

CrispClient . website . countBlockedVisitorsInRule ( websiteID , rule ) ;

在规则[ user ]中清除被阻止的访问者：参考

CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)

请参见示例

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

CrispClient . website . clearBlockedVisitorsInRule ( websiteID , rule ) ;

网站可用性

获取网站可用性状态[ user ， plugin ]：参考

CrispClient.website.getWebsiteAvailabilityStatus(websiteID)

请参见示例

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

CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;

列出网站操作员可用性[ user ， plugin ]：参考

CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)

请参见示例

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

CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;

网站分析

生成分析[ user ]：参考

CrispClient.website.generateAnalytics(websiteID, query)

请参见示例

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

CrispClient . website . generateAnalytics ( websiteID , query ) ;

网站批次

批处理解析对话[ user ]：参考

CrispClient.website.batchResolveConversations(websiteID, operation)

请参见示例

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

var operation = {
  "inbox_id" : null ,

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

CrispClient . website . batchResolveConversations ( websiteID , operation ) ;

批次阅读对话[ user ]：参考

CrispClient.website.batchReadConversations(websiteID, operation)

请参见示例

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

var operation = {
  "inbox_id" : null ,

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

CrispClient . website . batchReadConversations ( websiteID , operation ) ;

批次删除对话[ user ]：参考

CrispClient.website.batchRemoveConversations(websiteID, operation)

请参见示例

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

var operation = {
  "inbox_id" : null ,

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

CrispClient . website . batchRemoveConversations ( websiteID , operation ) ;

批次删除人[ user ]：参考

CrispClient.website.batchRemovePeople(websiteID, people)

请参见示例

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

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

CrispClient . website . batchRemoveConversations ( websiteID , sessions ) ;

网站验证

获取验证设置[ user ， plugin ]：参考

CrispClient.website.getVerifySettings(websiteID)

请参见示例

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

CrispClient . website . getVerifySettings ( websiteID ) ;

更新验证设置[ user ， plugin ]：参考

CrispClient.website.updateVerifySettings(websiteID, settings)

请参见示例

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

var settings = {
  "enabled" : true
} ;

CrispClient . website . updateVerifySettings ( websiteID , settings ) ;

获取验证密钥[ user ， plugin ]：参考

CrispClient.website.getVerifyKey(websiteID)

请参见示例

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

CrispClient . website . getVerifyKey ( websiteID ) ;

滚动验证键[ user ， plugin ]：参考

CrispClient.website.rollVerifyKey(websiteID)

请参见示例

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

CrispClient . website . rollVerifyKey ( websiteID ) ;

网站广告系列

列表广告系列[ user ]：参考

CrispClient.website.listCampaigns(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listCampaigns ( websiteID , pageNumber ) ;

列出广告系列标签[ user ]：参考

CrispClient.website.listCampaignTags(websiteID)

请参见示例

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

CrispClient . website . listCampaignTags ( websiteID ) ;

列表广告系列模板[ user ， plugin ]：参考

CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

请参见示例

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

CrispClient . website . listCampaignTemplates ( websiteID , pageNumber ) ;

创建一个新的广告系列模板[ user ， plugin ]：参考

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

请参见示例

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

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

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

检查广告系列模板是否存在[ user ， plugin ]：参考

CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

请参见示例

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

CrispClient . website . checkCampaignTemplateExists ( websiteID , templateID ) ;

获取广告系列模板[ user ， plugin ]：参考

CrispClient.website.getCampaignTemplate(websiteID, templateID)

请参见示例

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

CrispClient . website . getCampaignTemplate ( websiteID , templateID ) ;

保存广告系列模板[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新广告系列模板[ user ， plugin ]：参考

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

请参见示例

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

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

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

删除广告系列模板[ user ， plugin ]：参考

CrispClient.website.removeCampaignTemplate(websiteID, templateID)

请参见示例

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

CrispClient . website . removeCampaignTemplate ( websiteID , templateID ) ;

网站广告系列

创建一个新活动[ user ]：参考

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

请参见示例

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

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

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

检查活动是否存在[ user ]：参考

CrispClient.website.checkCampaignExists(websiteID, campaignID)

请参见示例

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

CrispClient . website . checkCampaignExists ( websiteID , campaignID ) ;

获取广告系列[ user ]：参考

CrispClient.website.getCampaign(websiteID, campaignID)

请参见示例

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

CrispClient . website . getCampaign ( websiteID , campaignID ) ;

保存广告系列[ user ]：参考

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

请参见示例

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

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

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

更新广告系列[ user ]：参考

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

请参见示例

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

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

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

删除广告系列[ user ]：参考

CrispClient.website.removeCampaign(websiteID, campaignID)

请参见示例

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

CrispClient . website . removeCampaign ( websiteID , campaignID ) ;

派遣活动[ user ]：参考

CrispClient.website.dispatchCampaign(websiteID, campaignID)

请参见示例

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

CrispClient . website . dispatchCampaign ( websiteID , campaignID ) ;

恢复广告系列[ user ]：参考

CrispClient.website.resumeCampaign(websiteID, campaignID)

请参见示例

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

CrispClient . website . resumeCampaign ( websiteID , campaignID ) ;

暂停广告系列[ user ]：参考

CrispClient.website.pauseCampaign(websiteID, campaignID)

请参见示例

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

CrispClient . website . pauseCampaign ( websiteID , campaignID ) ;

测试广告系列[ user ]：参考

CrispClient.website.testCampaign(websiteID, campaignID)

请参见示例

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

CrispClient . website . testCampaign ( websiteID , campaignID ) ;

列出广告系列收件人[ user ]：参考

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

请参见示例

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

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

列表广告系列统计[ user ]：参考

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

请参见示例

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

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

插件

插件连接
- 获取连接帐户[ plugin ]：参考
  - CrispClient.plugin.getConnectAccount()
  - 请参见示例
    CrispClient . plugin . getConnectAccount ( ) ;
- 检查连接会话有效性[ plugin ]：参考
  - CrispClient.plugin.checkConnectSessionValidity()
  - 请参见示例
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- 列出所有连接网站[ plugin ]：参考
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - 请参见示例
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- 列出[ plugin ]以来的连接网站：参考
  - CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
  - 请参见示例
    var dateSince = "2023-08-16T09:00:00Z" ; CrispClient . plugin . listConnectWebsitesSince ( dateSince , filterConfigured ) ;
- 获取连接端点[ plugin ]：参考
  - CrispClient.plugin.getConnectEndpoints()
  - 请参见示例
    CrispClient . plugin . getConnectEndpoints ( ) ;

插件订阅

列出所有活动订阅[ user ]：参考
- CrispClient.plugin.listAllActiveSubscriptions()
- 请参见示例
```
 CrispClient . plugin . listAllActiveSubscriptions ( ) ;
```

列出网站的订阅[ user ]：参考

CrispClient.plugin.listSubscriptionsForWebsite(websiteID)

请参见示例

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

CrispClient . plugin . listSubscriptionsForWebsite ( websiteID ) ;

获取订阅详细信息[ user ， plugin ]：参考

CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

请参见示例

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

CrispClient . plugin . getSubscriptionDetails ( websiteID , pluginID ) ;

订阅网站插件[ user ]：参考

CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

请参见示例

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

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

CrispClient . plugin . subscribeWebsiteToPlugin ( websiteID , pluginID ) ;

网站上的退订插件[ user ]：参考

CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

请参见示例

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

CrispClient . plugin . unsubscribePluginFromWebsite ( websiteID , pluginID ) ;

获取订阅设置[ user ， plugin ]：参考

CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

请参见示例

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

CrispClient . plugin . getSubscriptionSettings ( websiteID , pluginID ) ;

保存订阅设置[ user ， plugin ]：参考

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

请参见示例

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

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

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

更新订阅设置[ user ， plugin ]：参考

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

请参见示例

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

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

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

获取插件使用费[ user ， plugin ]：参考

CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

请参见示例

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

CrispClient . plugin . getPluginUsageBills ( websiteID , pluginID ) ;

报告插件对比尔[ plugin ]：参考

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

请参见示例

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

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

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

向前插件有效载荷到频道[ user ， plugin ]：参考

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

请参见示例

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

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

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

调度插件事件[ user ， plugin ]：参考

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

请参见示例

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

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

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

媒体

媒体动画

列出动画媒体[ user ]：参考

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

请参见示例

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

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

桶

水桶URL
- 生成存储桶URL [ user ， plugin ]：参考
  - CrispClient.bucket.generateBucketURL(data)
  - 请参见示例
    CrispClient . bucket . generateBucketURL ( data ) ;

实时事件

您可以绑定到Crisp的实时事件，以便通知网站中传入的消息和更新。

如果您不明确订阅实时事件，则不会收到任何事件，因为库不会自动连接到实时后端。

有两种接收实时事件的方法：

使用Web钩（推荐）
将WebSocket与RTM API一起使用

在开始进行RTM事件之前，请考虑以下内容：

如果您不使用CrispClient.on()明确订阅实时事件，则不会收到任何事件，因为库不会自动连接到实时后端。此方法返回Promise对象。
每当您的身份验证令牌有权接收更改活动的网站列表时，您都需要致电CrispClient.rebindSocket() 。此方法还返回一个Promise对象。这仅适用于使用RTM API的Websocket 。

接收实时事件

通过网络挂钩接收活动

要开始聆听事件并绑定处理程序，请通过Web Hooks示例查看事件。

您需要调整代码，以便：

RTM事件模式设置为Web挂钩： CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
您的HTTP端点安装了一条路由，以收听发布请求，并在收到请求时：
1. 它通过以下方式验证请求： CrispClient.verifyHook(secret, body, timestamp, signature)
2. 它带有以下网络挂钩： CrispClient.receiveHook(body)

插件Web挂钩将需要首先配置才能正常工作。查看我们的Web挂钩QuickStart Guide和我们的Web挂钩引用以开始。

通过Websockets（RTM API）接收活动

要开始聆听事件并绑定处理程序，请查看WebSockets示例中的事件。

您需要调整代码，以便：

RTM事件模式设置为Websocket： CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

可用的实时事件

可用事件如下列出：

会话事件：参考
- 会话更新可用性[ user ， plugin ]：
  - session:update_availability
- 会话更新验证[ user ， plugin ]：
  - session:update_verify
- 会话请求启动[ user ， plugin ]：
  - session:request:initiated
- 会话设置电子邮件[ user ， plugin ]：
  - session:set_email
- 会话设置电话[ user ， plugin ]：
  - session:set_phone
- 会话设置地址[ user ， plugin ]：
  - session:set_address
- 会话设置主题[ user ， plugin ]：
  - session:set_subject
- 会话设置AVATAR [ user ， plugin ]：
  - session:set_avatar
- 会话设置昵称[ user ， plugin ]：
  - session:set_nickname
- 会话设置数据[ user ， plugin ]：
  - session:set_data
- 会话同步页面[ user ， plugin ]：
  - session:sync:pages
- 会话同步事件[ user ， plugin ]：
  - session:sync:events
- 会话同步功能[ user ， plugin ]：
  - session:sync:capabilities
- 会话同步地理位置[ user ， plugin ]：
  - session:sync:geolocation
- 会话同步系统[ user ， plugin ]：
  - session:sync:system
- 会话同步网络[ user ， plugin ]：
  - session:sync:network
- 会话同步时区[ user ， plugin ]：
  - session:sync:timezone
- 会话同步语言位置[ user ， plugin ]：
  - session:sync:locales
- 会话同步评级[ user ， plugin ]：
  - session:sync:rating
- 会话同步主题[ user ， plugin ]：
  - session:sync:topic
- 会话设置状态[ user ， plugin ]：
  - session:set_state
- 会话设置块[ user ， plugin ]：
  - session:set_block
- 会话集段[ user ， plugin ]：
  - session:set_segments
- 会话集打开[ user ， plugin ]：
  - session:set_opened
- 会话集已关闭[ user ， plugin ]：
  - session:set_closed
- 会话设置参与者[ user ， plugin ]：
  - session:set_participants
- 会话集提及[ user ， plugin ]：
  - session:set_mentions
- 会话设置路由[ user ， plugin ]：
  - session:set_routing
- 会话设置收件箱[ user ， plugin ]：
  - session:set_inbox
- 会话删除[ user ， plugin ]：
  - session:removed
消息事件：参考
- 消息更新[ user ， plugin ]：
  - message:updated
- 消息发送[ user ， plugin ]：
  - message:send
- 接收到的消息[ user ， plugin ]：
  - message:received
- 删除消息[ user ， plugin ]：
  - message:removed
- 消息组合发送[ user ， plugin ]：
  - message:compose:send
- 消息构成接收[ user ， plugin ]：
  - message:compose:receive
- 消息确认阅读发送[ user ， plugin ]：
  - message:acknowledge:read:send
- 消息确认已接收到的读取[ user ， plugin ]：
  - message:acknowledge:read:received
- 消息确认已交付的[ user ， plugin ]：
  - message:acknowledge:delivered
- 消息通知未读发送[ user ， plugin ]：
  - message:notify:unread:send
- 消息通知未收到的未读[ user ， plugin ]：
  - message:notify:unread:received
垃圾邮件事件：参考
- 垃圾邮件消息[ user ]：
  - spam:message
- 垃圾邮件决定[ user ]：
  - spam:decision
人们活动：参考
- 人资料创建[ user ， plugin ]：
  - people:profile:created
- 人资料更新[ user ， plugin ]：
  - people:profile:updated
- 删除了人资料[ user ， plugin ]：
  - people:profile:removed
- 人们绑定会话[ user ， plugin ]：
  - people:bind:session
- 人们同步个人资料[ user ， plugin ]：
  - people:sync:profile
- 人们导入进度[ user ]：
  - people:import:progress
- 人员导入[ user ]：
  - people:import:done
竞选活动：参考
- 广告系列进度[ user ]：
  - campaign:progress
- 广告系列派遣[ user ]：
  - campaign:dispatched
- 活动运行[ user ]：
  - campaign:running
浏览事件：参考
- 浏览请求启动[ user ， plugin ]：
  - browsing:request:initiated
- 浏览请求被拒绝[ user ， plugin ]：
  - browsing:request:rejected
呼叫事件：参考
- 启动请求[ user ， plugin ]：
  - call:request:initiated
- 致电请求被拒绝[ user ， plugin ]：
  - call:request:rejected
小部件事件：参考
- 小部件操作处理[ user ]：
  - widget:action:processed
状态事件：参考
- 状态健康变化[ user ]：
  - status:health:changed
网站活动：参考
- 网站更新访问者计数[ user ， plugin ]：
  - website:update_visitors_count
- 网站更新操作员的可用性[ user ， plugin ]：
  - website:update_operators_availability
- 网站用户可用[ user ， plugin ]：
  - website:users:available
水桶事件：参考
- 存储桶URL上传生成[ user ， plugin ]：
  - bucket:url:upload:generated
- 桶URL头像生成[ user ， plugin ]：
  - bucket:url:avatar:generated
- 生成的存储量URL网站[ user ， plugin ]：
  - bucket:url:website:generated
- 生成的水桶URL广告系列[ user ， plugin ]：
  - bucket:url:campaign:generated
- 桶URL HelpDesk生成[ user ， plugin ]：
  - bucket:url:helpdesk:generated
- 生成的存储网址[ user ， plugin ]：
  - bucket:url:status:generated
- 生成的水桶URL处理[ user ， plugin ]：
  - bucket:url:processing:generated
媒体事件：参考
- 列出了媒体动画[ user ]：
  - media:animation:listed
电子邮件事件：参考
- 电子邮件订阅[ user ， plugin ]：
  - email:subscribe
- 电子邮件跟踪视图[ user ， plugin ]：
  - email:track:view
插件事件：参考
- 插件通道[ user ， plugin ]：
  - plugin:channel
- 插件事件[ user ， plugin ]：
  - plugin:event
- 插件设置已保存[ user ， plugin ]：
  - plugin:settings:saved

展开

node crisp api

酥脆的API包装器

安装

验证

概述

例子

创建自己的机器人！

资源方法

网站

网站对话

网站对话

网站人员（这些是您的最终用户）

网站Helpdesk

网站基础

网站设置

网站操作员

网站访问者

网站可用性

网站分析

网站批次

网站验证

网站广告系列

网站广告系列

插件

插件连接

插件订阅

媒体

媒体动画

桶

水桶URL

实时事件

接收实时事件

通过网络挂钩接收活动

通过Websockets（RTM API）接收活动

可用的实时事件

会话事件：参考

消息事件：参考

垃圾邮件事件：参考

人们活动：参考

竞选活动：参考

浏览事件：参考

呼叫事件：参考

小部件事件：参考

状态事件：参考

网站活动：参考

水桶事件：参考

媒体事件：参考

电子邮件事件：参考

插件事件：参考