node crisp apiダウンロード-Node node crisp apiソースコードダウンロード

鮮明なAPIラッパー

サクサクしたAPIノードラッパー。認証、メッセージの送信、会話の取得、JavaScriptコードからエージェントアカウントにアクセスします。

実装：REST API Reference（V1）Revision：17/10/2024
？メンテナー：@baptistejamin、 @eliottvincent、@valeriansaliou

インストール

npm install --save crisp-api

認証

APIに対して認証するには、REST API認証ガイドに従って認証トークンキーペイアを取得します。 2つの値で作られたトークンキーペアが得られます。

トークンのキーペアの値をプライベートに保ち、長期使用のために安全に保管してください。

次に、認証パラメーターを作成した直後にclientインスタンスに追加します。

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

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

// Now, you can use authenticated API sections.

概要

REST API QuickStartガイドに従うことができます。これにより、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 ) ;
  } ) ;

リソースメソッド

利用可能なすべての鮮明なAPIリソースが完全に実装されています。プログラマティックメソッド名は、REST APIリファレンスのラベル名にちなんで命名されています。

サクサクした統合を構築するときに必要なすべての方法には、スターシンボル（）が付いています。

ショ和userまたはpluginいずれかである認証トークンティアに応じて、ライブラリからすべてのメソッドを使用することは許可されない場合があることに注意してください。疑わしい場合は、以下のライブラリメソッドの説明を参照してください。ほとんどの場合、 pluginトークンを使用しています。

Webサイト

ウェブサイトの会話
ウェブサイトの会話
ウェブサイトの人々
ウェブサイトhelpdesk
ウェブサイトオペレーター
ウェブサイトの可用性
ウェブサイト分析
ウェブサイトバッチ
ウェブサイト検証
ウェブサイトキャンペーン
ウェブサイトキャンペーン

プラグイン

プラグイン接続
プラグインサブスクリプション

メディア

メディアアニメーション

バケツ

バケットURL

RTMイベント

セッションイベント
メッセージイベント
人々のイベント
キャンペーンイベント
ブラウジングイベント
イベントを呼び出します
ウィジェットイベント
ステータスイベント
ウェブサイトイベント
バケットイベント
メディアイベント
電子メールイベント
プラグインイベント

Webサイト

ウェブサイトの会話

リスト会話[ 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 ) ;

Spam Conversation Decision [ 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 ) ;

Conversation Inbox [ 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 ) ;

conversationの確認[ 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 ) ;

Widgetデータの配信会話のためのアクションフェッチ[ 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 ) ;

ウェブサイトの人々（これらはあなたのエンドユーザーです）

People Statistics [ 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 ) ;

提案されたPeopleイベント[ 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 ) ;

Peopleプロファイルを保存[ 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 ) ;

People Profileを更新します[ 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 ) ;

Peopleイベントを追加[ 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 ) ;

People Data [ 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 ) ;

People Profiles [ user ]をエクスポート：参照

CrispClient.website.exportPeopleProfiles(websiteID)

例を参照してください

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

CrispClient . website . exportPeopleProfiles ( websiteID ) ;

インポートPeopleプロファイル[ 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 ) ;

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

List HelpDesk Loceles [ 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 ) ;

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

新しいヘルプデスクロケール記事[ user 、 plugin ]を追加：リファレンス

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

例を参照してください

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

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

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

helpdeskロケール記事が存在するかどうかを確認します[ user 、 plugin ]：リファレンス

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

例を参照してください

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

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

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

helpdeskロケール記事[ 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ロケール記事[ 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ロケール記事[ 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ロケール記事[ 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 ) ;

List HelpDesk Locale Article Alternates [ user 、 plugin ]：リファレンス

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

例を参照してください

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

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

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

helpdeskロケール記事の代替存在するかどうかを確認します[ user 、 plugin ]：リファレンス

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

例を参照してください

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

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

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

helpdeskロケール記事を解決する代替[ user 、 plugin ]：リファレンス

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

例を参照してください

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

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

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

ヘルプデスクロケール記事を保存する代替[ 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 artures alternate [ 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ロケール記事[ 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 ) ;

Unpublish HelpDesk Locale Article [ 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 localeカテゴリを保存[ 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 localeカテゴリを更新[ user 、 plugin ]：リファレンス

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

例を参照してください

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

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

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

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

helpdesk localeカテゴリを削除[ user 、 plugin ]：リファレンス

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

例を参照してください

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

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

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

List HelpDesk Localeセクション[ 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 Localeセクションを保存[ 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 ) ;
```

外部ヘルプデスクをLocale [ 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 ) ;

List HelpDesk Redirections [ user 、 plugin ]：リファレンス

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

例を参照してください

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

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

HelpDesk Redirection [ user 、 plugin ]を追加：参照

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

例を参照してください

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

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

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

helpdeskリダイレクトが存在するかどうかを確認します[ user 、 plugin ]：リファレンス

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

例を参照してください

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

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

helpdeskリダイレクトを解決[ user 、 plugin ]：参照

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

例を参照してください

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

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

helpdeskリダイレクトを削除[ user 、 plugin ]：参照

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

例を参照してください

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

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

helpdesk設定を解決[ user 、 plugin ]：参照

CrispClient.website.resolveHelpdeskSettings(websiteID)

例を参照してください

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

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;

HELPDESK SETTINGS [ 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 ) ;

ウェブサイトベース
- Webサイトが存在するかどうかを確認します[ user 、 plugin ]：リファレンス
  - CrispClient.website.checkWebsiteExists(domain)
  - 例を参照してください
    CrispClient . website . checkWebsiteExists ( domain ) ;
- Webサイトの作成[ user ]：リファレンス
  - CrispClient.website.createWebsite(websiteData)
  - 例を参照してください
    CrispClient . website . createWebsite ( websiteData ) ;
- Webサイト[ user 、 plugin ]を取得：リファレンス
  - CrispClient.website.getWebsite(websiteID)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsite ( websiteID ) ;
- Webサイト[ user ]を削除：参照
  - CrispClient.website.deleteWebsite(websiteID, verify)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var verify = { "method" : "password" , "secret" : "MySuperSecurePassword" ; } ; CrispClient . website . deleteWebsite ( websiteID , verify ) ;
- Webサイトの削除を中止[ user ]：参照
  - CrispClient.website.abortWebsiteDeletion(websiteID)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

ウェブサイトの設定

Webサイト設定を取得[ user 、 plugin ]：参照

CrispClient.website.getWebsiteSettings(websiteID)

例を参照してください

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

CrispClient . website . getWebsiteSettings ( websiteID ) ;

Webサイト設定を更新[ 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 ) ;

ウェブサイトオペレーター

リストWebサイトオペレーター[ user 、 plugin ]：リファレンス
- CrispClient.website.listWebsiteOperators(websiteID)
- 例を参照してください
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listWebsiteOperators ( websiteID ) ;
```
最後のアクティブなWebサイトオペレーターをリスト[ user 、 plugin ]：リファレンス
- CrispClient.website.listLastActiveWebsiteOperators(websiteID)
- 例を参照してください
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listLastActiveWebsiteOperators ( websiteID ) ;
```
Flush Last Active Webサイトオペレーター[ 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 ) ;

Webサイトオペレーターを取得[ 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 ) ;

Webサイトオペレーターを招待します[ 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 ) ;

Webサイト[ user ]からのオペレーターをリンクしてください：リファレンス

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

例を参照してください

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

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

ウェブサイトの訪問者
- 訪問者をカウント[ user 、 plugin ]：リファレンス
  - CrispClient.website.countVisitors(websiteID)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . countVisitors ( websiteID ) ;
- 訪問者をリスト[ user 、 plugin ]：リファレンス
  - CrispClient.website.listVisitors(websiteID, pageNumber)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var pageNumber = 1 ; CrispClient . website . listVisitors ( websiteID , pageNumber ) ;
- 地図上の訪問者を特定する[ user 、 plugin ]：リファレンス
  - CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . pinpointVisitorsOnMap ( websiteID , centerLongitude , centerLatitude , centerRadius ) ;
- token [ 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 ) ;
ウェブサイトの可用性
- Webサイトの可用性ステータス[ user 、 plugin ]を取得：リファレンス
  - CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;
- リストWebサイトオペレーターの可用性[ user 、 plugin ]：リファレンス
  - CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
  - 例を参照してください
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;

ウェブサイト分析

Analytics [ user ]を生成：参照

CrispClient.website.generateAnalytics(websiteID, query)

例を参照してください

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

CrispClient . website . generateAnalytics ( websiteID , query ) ;

ウェブサイトバッチ

Batch Resolve Conversations [ 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 ) ;

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

プラグイン

プラグイン接続
- Connect Account [ plugin ]を取得：参照
  - CrispClient.plugin.getConnectAccount()
  - 例を参照してください
    CrispClient . plugin . getConnectAccount ( ) ;
- CONNECTセッションの有効性[ plugin ]：参照を確認してください
  - CrispClient.plugin.checkConnectSessionValidity()
  - 例を参照してください
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- すべての接続Webサイト[ plugin ]：参照
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - 例を参照してください
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- [ plugin ]以降のWebサイトを接続するリスト：参照
  - 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 ( ) ;
```
Webサイトのサブスクリプションをリスト[ 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 ) ;

Webサイトをプラグインに購読する[ 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 ) ;

Webサイト[ 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
- Bucket URL [ user 、 plugin ]を生成：参照
  - CrispClient.bucket.generateBucketURL(data)
  - 例を参照してください
    CrispClient . bucket . generateBucketURL ( data ) ;

リアルタイムイベント

Webサイトでの受信メッセージと更新の通知を取得するために、Crispのリアルタイムイベントにバインドできます。

ライブラリが自動的にリアルタイムバックエンドに接続していないため、明示的にリアルタイムイベントをサブスクライブしない場合、イベントを受け取りません。

リアルタイムイベントを受信するには2つの方法があります。

Webフックの使用（推奨）
RTM APIでWebSocketを使用します

RTMイベントを開始する前に、以下を検討してください。

ライブラリが自動的にリアルタイムバックエンドに接続しないため、 CrispClient.on()を使用してリアルタイムイベントを明示的に購読しない場合、イベントを受け取りません。このメソッドはPromiseオブジェクトを返します。
認証トークンが変更のイベントを受信する権利があるWebサイトのリストがいつでも、 CrispClient.rebindSocket()を呼び出す必要があります。この方法は、 Promiseオブジェクトも返します。これは、RTM APIのWebSocketにのみ適用されます。

リアルタイムイベントを受け取ります

ウェブフックを介してイベントを受け取ります

イベントのリスニングを開始し、ハンドラーをバインドするには、Webフックの例を介してイベントをご覧ください。

次のようにコードを調整する必要があります。

RTMイベントモードはWebフックに設定されています： CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
HTTPエンドポイントは、投稿リクエストをリスニングするルートをマウントします。
1. リクエストを次のように検証します： CrispClient.verifyHook(secret, body, timestamp, signature)
2. CrispClient.receiveHook(body)でウェブフックを受け取ります

プラグインWebフックは、これを機能させるために最初に構成する必要があります。 Web Hooks QuickStartガイドとWebフックの参照をチェックして、開始してください。

WebSockets（RTM API）を介してイベントを受信する

イベントのリスニングを開始し、ハンドラーをバインドするには、WebSocketsの例を介したイベントをご覧ください。

次のようにコードを調整する必要があります。

RTMイベントモードはWebSocketsに設定されています： CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

利用可能なリアルタイムイベント

利用可能なイベントを以下にリストします。

セッションイベント：リファレンス
- セッション更新の可用性[ user 、 plugin ]：
  - session:update_availability
- セッションの更新[ user 、 plugin ]を検証します：
  - session:update_verify
- セッションリクエストが開始された[ user 、 plugin ]：
  - session:request:initiated
- セッションセットメール[ user 、 plugin ]：
  - session:set_email
- セッションセット電話[ user 、 plugin ]：
  - session:set_phone
- セッションセットアドレス[ user 、 plugin ]：
  - session:set_address
- セッションセットサブジェクト[ user 、 plugin ]：
  - session:set_subject
- セッションセットアバター[ user 、 plugin ]：
  - session:set_avatar
- セッションセットニックネーム[ user 、 plugin ]：
  - session:set_nickname
- セッションセットデータ[ user 、 plugin ]：
  - session:set_data
- セッション同期ページ[ user 、 plugin ]：
  - session:sync:pages
- セッション同期イベント[ user 、 plugin ]：
  - session:sync:events
- セッション同期機能[ user 、 plugin ]：
  - session:sync:capabilities
- セッション同期Geolocation [ user 、 plugin ]：
  - session:sync:geolocation
- セッション同期システム[ user 、 plugin ]：
  - session:sync:system
- セッション同期ネットワーク[ user 、 plugin ]：
  - session:sync:network
- セッション同期TimeZone [ 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
- セッションセットInbox [ 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
- メッセージCompose送信[ user 、 plugin ]：
  - message:compose:send
- メッセージCompose受信[ user 、 plugin ]：
  - message:compose:receive
- メッセージ確認send [ user 、 plugin ]を読みます：
  - message:acknowledge:read:send
- メッセージ確認済み[ user 、 plugin ]：
  - message:acknowledge:read:received
- メッセージが表示された[ user 、 plugin ]：
  - message:acknowledge:delivered
- メッセージunread send [ user 、 plugin ]を通知します：
  - message:notify:unread:send
- メッセージunread unread受信[ 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
- Webサイトユーザーが利用可能[ user 、 plugin ]：
  - website:users:available
バケットイベント：リファレンス
- Bucket URLアップロード生成[ user 、 plugin ]：
  - bucket:url:upload:generated
- Bucket URLアバター生成[ user 、 plugin ]：
  - bucket:url:avatar:generated
- [ user 、 plugin ]を生成したBucket URL Webサイトを生成します。
  - bucket:url:website:generated
- [ user 、 plugin ]を生成したバケットURLキャンペーン：
  - bucket:url:campaign:generated
- Bucket URL helpdesk生成[ user 、 plugin ]：
  - bucket:url:helpdesk:generated
- 生成されたバケットURLステータス[ user 、 plugin ]：
  - bucket:url:status:generated
- 生成されたバケットURL処理[ user 、 plugin ]：
  - bucket:url:processing:generated
メディアイベント：リファレンス
- リストされているメディアアニメーション[ user ]：
  - media:animation:listed
電子メールイベント：リファレンス
- 電子メール購読[ user 、 plugin ]：
  - email:subscribe
- 電子メールトラックビュー[ user 、 plugin ]：
  - email:track:view
プラグインイベント：リファレンス
- プラグインチャネル[ user 、 plugin ]：
  - plugin:channel
- プラグインイベント[ user 、 plugin ]：
  - plugin:event
- 保存されたプラグイン設定[ user 、 plugin ]：
  - plugin:settings:saved

拡大する

node crisp api

鮮明なAPIラッパー

インストール

認証

概要

例

独自のボットを作成してください！

リソースメソッド

Webサイト

ウェブサイトの会話

ウェブサイトの会話

ウェブサイトの人々 （これらはあなたのエンドユーザーです）

ウェブサイトhelpdesk

ウェブサイトベース

ウェブサイトの設定

ウェブサイトオペレーター

ウェブサイトの訪問者

ウェブサイトの可用性

ウェブサイト分析

ウェブサイトバッチ

ウェブサイト検証

ウェブサイトキャンペーン

ウェブサイトキャンペーン

プラグイン

プラグイン接続

プラグインサブスクリプション

メディア

メディアアニメーション

バケツ

バケットURL

リアルタイムイベント

リアルタイムイベントを受け取ります

ウェブフックを介してイベントを受け取ります

WebSockets（RTM API）を介してイベントを受信する

利用可能なリアルタイムイベント

セッションイベント：リファレンス

メッセージイベント：参照

スパムイベント：リファレンス

人々のイベント：リファレンス

キャンペーンイベント：リファレンス

ブラウジングイベント：リファレンス

コールイベント：リファレンス

ウィジェットイベント：リファレンス

ステータスイベント：リファレンス

ウェブサイトイベント：リファレンス

バケットイベント：リファレンス

メディアイベント：リファレンス

電子メールイベント：リファレンス

プラグインイベント：リファレンス

ウェブサイトの人々（これらはあなたのエンドユーザーです）