ナレッジベース

Back to support overview

このユースケースでは、チャット (オプションで共同ブラウジング) 機能をサードパーティ システムに統合するために必要な構成および API の使用の手順例について説明します。

用語集

  • Customerチャットでメッセージを書くユーザーです。
  • User/Agent チャットに応答するユーザー/エージェントです。

1. セットアップとスクリプトの実装

プラグイン構成

WebChat プラグインを有効化して構成します。

  • Color
  • Texts
  • Appearence
  • ...

https://docs.chatvisor.com/docs/config05_css_live-chat/　(英文のご案内となります。)

JavaScript 統合

JavaScript は、共同ブラウズする各 Web ページに統合する必要があります。

https://docs.chatvisor.com/docs/setup20_implementation-javascript/　(英文のご案内となります。)

2. チャットの可視性を制御する

📌注意: 何も構成されていない場合、チャットはデフォルトで表示されます。

個々のアクション ルールを設定して、チャットの可視性を制御できます。

  • Any agent is online
  • Any agent is available
  • Opening hours
  • Visitor is on page for x seconds
  • Visitor visits page for second time

または、REST API を介して制御できます。

https://developers.chatvisor.com/#operation/isVisibleUsingGET　(英文のご案内となります。)

📌注意: REST API と Actions ルールも組み合わせ可能

3. エージェントを同期する

サードパーティの環境を使用してエージェントを管理している場合は、REST API を介してエージェント アカウントを Chatvisor と簡単に同期できます。

https://developers.chatvisor.com/#tag/User(英文のご案内となります。)

4. 顧客にタグを付けて、内部 ID と一致させる

場合によっては、顧客を再識別して、追加情報で顧客を拡張したい場合があります。

https://developers.chatvisor.com/#operation/tagUserUsingPOST(英文のご案内となります。)

{
  "email": "[email protected]",
  "firstname": "John",
  "id": 123,
  "labels": [
    "foo",
    "bar"
  ],
  "lastname": "Doe"
}

5. 新しい会話/メッセージを受け取る

ウェブフック

WebHooks は、設定 - API - WebHooks で構成できます。新しい会話が開始されるか、新しいメッセージが受信されると、Webhook を受け取ります。 Chatvisor で自動ルーティング ルールが構成されていない場合は、会話をエージェントの 1 つに手動でルーティングし、会話に参加するためのパブリック URL を生成できます。

https://developers.chatvisor.com/#section/WebHooks(英文のご案内となります。)

REST API

REST API を介して会話をポーリングすることもできます。

https://developers.chatvisor.com/#operation/getConversationsUsingGET(英文のご案内となります。)

6. エージェントの公開チャット URL を生成する

会話/顧客が正常に作成された後、会話に参加するための公開 URL を生成することができます。これには、WebHook または Conversation API から受け取った customerIdが必要です。

📌注意: API トークンを認証して生成する: https://developers.chatvisor.com/#section/Authentication

https://developers.chatvisor.com/#operation/getUrlOfChatByCustomerIdUsingGET (英文のご案内となります。)

📌注意: これは、エージェントが自動的にログインして特定のチャットにリダイレクトされる一意の URL です。

7. オプションで追加の共同ブラウジングを統合する

共同ブラウジング プラグインを有効にして設定するだけです。その後、ライブ チャット内に自動的に統合されます。

https://docs.chatvisor.com/docs/config04_css_live-view (英文のご案内となります。)