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

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

サンプルアプリ：GitHub

NPMパッケージ:npmjs.com

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

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の設定とビルドに関する同じ内容と指示がすべて含まれています。

主要用語

用語	詳細
スレッド	チャットアプリ内の会話。エージェントまたはコンタクトコンタクトセンターでエージェント、IVR、またはボットとやり取りする人。のいずれかによって送信された最初のメッセージが、スレッドを開始します。会話中の連続したメッセージはスレッドに追加されます。スレッドは各メッセージを含むオブジェクトです。メッセージはメッセージの作者によって構成されます。 threadIdは会話全体を識別し、会話内のすべてのメッセージはメッセージIDを持ちます。会話が終わるとスレッドは終了します。
シングルスレッド	コンタクトが一度に1つの会話しかできないアプリ設計。
マルチスレッド	コンタクトが一度に複数の会話を行えるアプリ設計。
チャネル	Digital Experienceのコンテキストでは、チャネルは、メッセージングのタイプまたは通信に使用されるプラットフォームを指します。たとえば、WhatsAppリアルタイムのメッセージングチャネルを持つことができます。 Mobile SDKは、モバイルアプリにチャットメッセージングチャネルを追加することができます。 CXone Mpowerプラットフォームにチャンネルが作成されます。これは、チャンネルIDと一緒にチャネルの設定を決定します。アプリユーザーがチャットを開いたときに、このIDを使用してチャットチャネルを開始します。
チャネルID	DigitalのCXone Mpowerセクションで作成されたデジタルチャットチャネルのID。これは、CXone Mpower(ACD> Digital> ポイントオブコンタクト(PoC)デジタル> チャット> 初期化とテスト)のチャットチャンネルの設定にあります。
ブランドID	これは、の CXone Mpowerシステムにおけるテクニカルサポート、請求、およびグローバル設定を管理するために使用される上位レベルの組織グループ。テナントDigital ExperienceIDのようなものです。これはチャットの初期化に使われます。これは、CXone Mpower(ACD> Digital> ポイントオブコンタクト(PoC)デジタル> チャット> 初期化とテスト)のチャットチャンネルの設定にあります。
カスタマー ID	チャットエンドユーザーの一意のID。 SDKはチャットの初期化時にこのIDを作成します。 OAuthを設定した場合、このIDはすべてのデバイスにわたり各コンタクトについて同じままです。 OAuthを設定していない場合、このIDは各デバイスごとに異なります。IDはゲストログインのようになります。
地域または環境	CXone Mpower環境がホストされている世界のロケーション。これは次のいずれかになります：オーストラリア(AU1)、カナダ(CA1)、欧州(EU1)、日本(JP1)、北米(NA1)、英国(UK1)。開発者は、CXone Mpowerシステムがホストされている場合と同じリージョンを使用する必要があります。そうでない場合、チャット接続は拒否されます。
連絡先、顧客、およびユーザー	これらの用語はすべて、モバイルアプリのエンドユーザーを指します。オンラインヘルプでは通常、コンタクトという用語を使用しています。 SDKのドキュメンテーションやコードコメントでは、顧客やユーザーを目にする可能性が高いです。
CXone Mpower	プラットフォームが提供するすべてのカスタマーエクスペリエンスツールを管理し、アクセスするコアCXone Mpower。モバイルアプリで提供したいチャット機能に応じて、必要なユーザーアカウント権限を持つ管理者がCXone Mpowerでいくつかの設定タスクを完了する必要があります。
Digital Experience	CXone Mpowerのセクションで、デジタルチャネルに関するすべてを管理できます。

開発を始める前に

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

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

チャットを正しく初期化する

開発者は、アプリをCXone Mpowerに接続して、やり取りを開始する必要があります。これにより、WebSocket接続が作成されます。開発者、await sdk.connect()を呼び出すことでこれを行うことができます。必ず開発者にそうするように指示してくださいアクティブなチャット会話の場合のみ。これにより、WebSocketが必要な場合にのみ実行されるようになります。