デジタルチャットウェブSDK

SDK：GitHub

APIリファレンス：GitHubページ

サンプルアプリ：GitHub

NPMパッケージ:npmjs.com

chat web SDKでは、独自のデジタルチャットアプリケーションを作成したり、既存のweb アプリにデジタルチャットを追加したりすることができます。これにより、CXoneデジタル インフラストラクチャーを好みのUIで使用できます。これは、LiveChatとチャットメッセージング—同期および非同期のメッセージングの両方をサポートするJavaScriptベースのSDKです。また、シングル閉じた シングルスレッドのアプリでは、それぞれの連絡先ごとに1つのチャットスレッドしか持つことができません。お客様の組織とのすべてのインタラクションは、その1つのチャットスレッドで行われます。またはマルチスレッド閉じた マルチスレッドのアプリでは、連絡先は新しいトピックについて議論するために希望する数だけスレッドを作成することができます。これらのスレッドは同時にアクティブにすることができます。のメッセージングを設定することもできます。このSDKを使用すると、ウェブサイト上のCXoneをより詳細に制御することができます。一部のウェブサイトが持つ技術的な制限を回避することができます。たとえば、お客様のサイトが外部コードを許可していない場合、ネイティブのCXoneデジタルチャットの実行を妨げる可能性があります。

SDKは、以下の機能に対応しています。

  • デジタルチャットメッセージング
  • 認証用OAuth2.0
  • コンタクトの識別とカスタムフィールド
  • スレッドのリストとスレッドリカバリー
  • 添付ファイル
  • リッチメッセージ
  • タイピング、見られたメッセージ、届いたメッセージのインジケーター
  • ケースステータスイベントや割り当てイベントなどのシステムメッセージ
  • キューポジションイベント

このSDKはTypeScript 4.9+で記述されています。カスタムアプリケーションbundler like webpack or Create React Appも使用する必要があります。

SDKリソース

このページの上部または下のドロップダウンから、さまざまなSDKリソースにリンクしています。

開発者はGitHubからSDKを取得できます。リポジトリには、開発者が使い始めるのに役立つREADMEがあります。イベントおよびAPIリファレンス用のドキュメントも含まれています。より使いやすいAPIリファレンスは、github.ioを通じて別途ホストされています。

サンプルアプリケーションもご覧ください。これにより、チャットを試し、関連するソースコードを見ることができます。

開発者はSDKをNPMパッケージとしてインポートしmす。npmjs.comのパッケージエントリーには、SDKの設定とビルドに関する同じ内容と指示がすべて含まれています。

SDK：GitHub

APIリファレンス：GitHubページ

サンプルアプリ：GitHub

NPMパッケージ:npmjs.com

主要用語

  • スレッド：チャットアプリ内の会話。エージェントまたはコンタクトのいずれかによって送信された最初のメッセージが、スレッドを開始します。会話中の連続したメッセージはスレッドに追加されます。スレッドは各メッセージを含むオブジェクトです。メッセージはメッセージの作者によって構成されます。threadIdは会話全体を識別し、会話内のすべてのメッセージはメッセージIDを持ちます。会話が終わるとスレッドは終了します。

  • シングルスレッド：コンタクトが1回に一つの会話しかできないようなアプリデザイン。

  • マルチスレッド：コンタクトが1回に複数の会話ができるようなアプリデザイン。

  • チャネル：Digital Experienceのコンテキストで、チャネルは、メッセージングのタイプ、または通信に使用されるプラットフォームを参照します。たとえば、WhatsAppリアルタイムのメッセージングチャネルを持つことができます。Mobile SDKは、モバイルアプリにチャットメッセージングチャネルを追加することができます。CXoneプラットフォームにチャンネルが作成されます。これは、チャンネルIDと一緒にチャネルの設定を決定します。アプリユーザーがチャットを開いたときに、このIDを使用してチャットチャネルを開始します。

  • ChannelId：CXoneのデジタルセクションで作成されたデジタルチャットチャネルのID。これは、CXone(ACD> デジタル> ポイントオブコンタクト(PoC)デジタル> チャット> 初期化とテスト)のチャットチャンネルの設定にあります。

  • BrandId：これはDigital Experience用のテナント閉じた テクニカルサポート、請求、およびCXone環境のグローバル設定の管理に使用される高レベルの組織グループIDのようなものです。これはチャットの初期化に使われます。これは、CXone(ACD> デジタル> ポイントオブコンタクト(PoC)デジタル> チャット> 初期化とテスト)のチャットチャンネルの設定にあります。

  • CustomerId：チャットエンドユーザーの固有ID。SDKはチャットの初期化時にこのIDを作成します。OAuthを設定した場合、このIDはすべてのデバイスにわたり各コンタクトについて同じままです。OAuthを設定していない場合、このIDは各デバイスごとに異なります。IDはゲストログインのようになります。

  • リージョンまたは環境：CXone展開がホストされている場合の世界でのロケーションです。これは次のいずれかになります：オーストラリア(AU1)、カナダ(CA1)、欧州(EU1)、日本(JP1)、北米(NA1)、英国(UK1)。開発者は、CXoneシステムがホストされている場合と同じリージョンを使用する必要があります。そうでない場合、チャット接続は拒否されます。

  • コンタクト、顧客、ユーザー：これらの用語はすべて、モバイルのエンドユーザーを参照しますアプリ。オンラインヘルプでは通常、コンタクトという用語を使用しています。SDKのドキュメンテーションやコードコメントでは、顧客やユーザーを目にする可能性が高いです。

  • CXone：NICE CXoneが提供するすべてのカスタマーエクスペリエンスツールを管理し、アクセスする場合のコアプラットフォーム。モバイルアプリで提供したいチャット機能に応じて、必要なユーザーアカウント権限を持つ管理者がCXoneでいくつかの設定タスクを完了する必要があります。

  • Digital Experience：デジタルチャンネルに関するすべてを管理できる場合のCXoneのセクション。

開発を始める前に

モバイルSDKで構築する前に、以下のアイテムを検討してください:

  • CXoneの管理者アカウントとエージェントアカウントの両方を持っていますか？CXoneプラットフォームで必要な機能を設定する際、管理者がサポートできますか？
  • 既存のチャットチャンネルがありますか、それとも新しいチャンネルを作りたいですか？
  • シングルスレッドとマルチスレッドのどちらの会話を提供したいですか？
  • どのタイプのリッチメッセージを設定しますか？このようなインタラクティブメッセージを活用できるユースケースにはどのようなものがあるのだろうか？
  • ポップアップのようなプロアクティブ・アクションやウェルカムメッセージを使用しますか？