デジタルスクリプトのリッチメッセージング

デジタル Digital Experienceに関連するあらゆるチャネル、コンタクト、スキル。スクリプトはリッチメッセージングをサポートしています。リッチメッセージングは、画像、ボタン、リストピッカー、クイック返信、リッチリンクなどのメディアを含むテキストベースのメッセージングです。多くのデジタルチャネルでリッチメッセージングの使用が可能ですが、サポートされるリッチメディアのオプションはチャネルによって異なります。

リッチコンテンツは、コンタクトに直接送信したり、エージェントがインタラクトできるようにエージェントアプリケーションに表示したりできます。たとえば、エージェントがコンタクトに送信できるクイック返信メッセージを作成することができます。これは、ライブの人間のエージェント、またはバーチャルエージェントやボットにルーティングされたインタラクションに対応するスクリプトで使用することができます。

リッチメディアコンテンツのオプション

リッチメディアコンテンツはJSONとして送信されます。JSONは、受信側のアプリケーションやシステムがそれを解釈し、コンテンツを正しく表示できるように構造化されていなければなりません。正しい構造は、アプリケーションやシステムによって異なります。CXoneで使用されるスキーマには、以下の表に示すようにいくつかの異なるセットがあります。

スキーマ	詳細
真にオムニチャネル対応のリッチメッセージング（TORM）	TORMは、複数のチャネルコンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。で機能するリッチメディア要素を作成します。以下の要素がサポートされています。リストピッカークイック返信タイムピッカーリッチリンクフォームアダプティブカードほとんどのTORMリッチメディアエレメントはJSONスキーマとして使用でき、メッセージテンプレートを作成するために使用できます。TORMテンプレートは、エージェントアプリケーション、またはコンタクトに送信することができます。TORMスキーマは、デジタルアウトバウンドAPIを使用して、JSONとして直接送信することもできます。詳細は以下を参照してください： TORMの概要 TORMメッセージテンプレート TORMテンプレートをスクリプトで送信する方法 TORMスキーマ
TORM以外のテンプレート	一部のデジタル Digital Experienceに関連するあらゆるチャネル、コンタクト、スキル。チャネルは、TORMの代わりにレガシーJSON構造を使用するリッチメディアオプションをサポートしています。これらのオプションは、CXoneでテンプレートとして作成する必要があり、以下のチャネルにおける人間のエージェントとのインタラクションでのみ利用できます。デジタル Eメール Apple Messages for Business WhatsApp これらのテンプレートとそのスキーマは、スクリプトでは使用できません。
アダプティブカード	アダプティブカードは、Microsoftによって開発された、リッチメッセージングボタン、画像、メニュー、オプションピッカーなどのデジタルメッセージの要素。コンテンツを作成する方法です。これはオープンなカード交換フォーマットで、UIコンテンツを共通の一貫した方法で送信することができます。アダプティブカードを使えば、標準的なリッチメディア要素だけを含むものよりも複雑で役に立つインタラクティブなメッセージを送ることができます。現在のところ、デジタルチャットのみがアダプティブカードをサポートし、Microsoft Teamsチャネルはアダプティブカードをサポートしています。他のチャネルでアダプティブカードのメッセージが送信された場合、指定されたフォールバック宛先がリッチメディアをサポートしない場合に送信される代替のプレーンテキスト。テキストが代わりに使用されます。現在、アダプティブカードは次のように使用できます。デジタルチャットチャネルでコンタクトに送信されるメッセージ内で使用ボットビルダーボットの応答メッセージ内で使用 SmartAssistバーチャルエージェントの応答メッセージ内で使用デジタルチャットウィンドウをカスタマイズするために使用詳細は以下を参照してください： CXoneにおけるアダプティブカードの使用についての概要アダプティブカードのTORMスキーマデジタルチャットチャネルにアダプティブカードを追加するデジタルチャットメッセージでアダプティブカードからポストバックデータを送信する
プラグインのスキーマ(レガシー)	これらのスキーマはサポートされなくなりました。現在スクリプトでこれらを使用している場合は、このページで説明されているサポートされるオプションのいずれかに切り替えることをお勧めします。これらのスキーマは、キーと値のペア"type": "PLUGIN"によって認識できます。

TORM

リッチメッセージングは、チャネルがサードパーティのプラットフォームに接続するオムニチャネル環境における課題となっています。ほとんどのプラットフォームは、リッチメディア用に独自のスキーマを採用しています。したがって、複数のチャネルで機能するリッチメディア要素を設定するには、チャネルごとにその要素のJSONを調べてコーディングする必要があります。プラットフォームが後日スキーマを変更した場合、使っていたコードは壊れてしまいます。

TORM(Truly Omnichannel Rich Media)は、この負担を軽減しようとするものです。これはリッチメッセージングの作業を簡素化するためにNICE CXoneによって開発された、独自の方式です。TORMは、いくつかの一般的なリッチメディア要素に対して、単一のJSONスキーマセットを提供します。CXoneがメッセージを処理する際、TORMスキーマは、適切なプラットフォームによって使用されるスキーマにマッピングされます。これにより、複数のさまざまなスキーマを維持する必要がなくなります。

次の表に、TORMでサポートされているリッチメディア要素を示します。また、各要素がメッセージテンプレート、JSONスキーマ、またはその両方として利用できるかどうかも示しています。

エレメント	テンプレート	JSONスキーマ
リストピッカー
クイック返信
タイムピッカー
リッチリンク
フォーム
アダプティブカード

サポートあり：「サポートされている」ことを示す緑のチェックマークサポートなし：「サポートされていない」ことを示す赤のX

TORMテンプレート

メッセージテンプレートは、以下のリッチメディア要素用にACDアプリケーションで作成できます。

リストピッカー
クイック返信
リッチリンク
フォーム

これらのテンプレートは以下のデジタルチャネルに割り当てることができます。

Apple Messages for Business
Facebookメッセンジャー
WhatsApp
デジタルチャット

チャネルに割り当てられた後、テンプレートは3つの方法で使用できます。

エージェントの場合、ACDで管理者が設定：CXone管理者は、カスタムコンポーネントを作成し、エージェントアプリケーションでテンプレートを利用可能にすることができます。エージェントはコンタクトにメッセージを送信する際、使用しているエージェントアプリケーションで利用可能なテンプレートから選択できます。
コンタクトの場合、スクリプトで送信：TORMテンプレートを、サポートされているチャネルのコンタクトに直接送信されるメッセージに含めることができます。たとえば、IVR 発信者が音声コマンド、キー入力、またはその両方を介して対話し、情報を取得したり、着信音声通話をルーティングしたり、あるいはその両方を行うことができる自動電話メニュー。に相当するチャットとしてリストピッカーを使用して、コンタクトにチャットしたい部署を選択するよう促すことができます。また、フォームを使用して、コンタクトの名前や問い合わせ理由の簡単な説明といった情報を収集することもできます。

アダプティブカード

アダプティブカード中央から右上隅に矢印が向いている正方形のアイコン。は、Microsoftによって開発された、リッチメッセージングボタン、画像、メニュー、オプションピッカーなどのデジタルメッセージの要素。コンテンツを作成する方法です。これはオープンなカード交換フォーマットで、UIコンテンツを共通の一貫した方法で送信することができます。アダプティブカードを使えば、標準的なリッチメディア要素だけを含むものよりも複雑で役に立つインタラクティブなメッセージを送ることができます。

アダプティブカードの利点は、独自のコンテンツをデザインできるために基本的なリッチメディアのオプションに制限されない点です。アダプティブカードは、インタラクティブな要素やマルチメディアのための多くのオプションがあるグリッドの構築ブロックを使用して構築されています。

現在のところ、デジタルチャットのみがし、Microsoft Teamsチャネルはアダプティブカードをサポートしています。他のチャネルでアダプティブカードのメッセージが送信された場合、指定されたフォールバック宛先がリッチメディアをサポートしない場合に送信される代替のプレーンテキスト。テキストが代わりに使用されます。

CXoneでアダプティブカードを使うには、次のような方法があります。

SnippetアクションでJSONを構築して、これをスクリプト経由で送信する。
デジタルチャットチャネルに直接アダプティブカードを追加する。
サポートされているチャネルで送信されたコンタクトへのボットビルダー応答メッセージでアダプティブカードを使用する。
SmartAssistバーチャルエージェントとともに、サポートされているチャネルでアダプティブカードを使用する。

アダプティブカードは、Microsoftアダプティブカードデザイナー中央から右上隅に矢印が向いている正方形のアイコン。を使って作成できます。このツールは誰でも利用することができます。

フォールバックテキスト

フォールバックテキストでは、特定のタイプのリッチメディアコンテンツをサポートしていないチャネルコンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。のコンタクトに送信する代替テキストを指定できます。これは、組織でデジタル Digital Experienceに関連するあらゆるチャネル、コンタクト、スキル。チャネルを複数使用している場合に役立ちます。また、リッチメディアコンテンツのレンダリングに問題が発生した場合のバックアップとしても機能します。

送信するすべてのリッチメディアコンテンツにフォールバックテキストを含めてください。

JSONで構築されたTORMリッチメディアコンテンツの場合、JSONにfallbackText要素を含めることができます。
リッチメッセージングテンプレートの場合、各テンプレートで[フォールバックテキスト]フィールドにテキストが指定されていることを確認する必要があります。
ボットビルダー経由で送信されるメッセージの場合、ボットビルダーアプリケーションのリッチメッセージングフォールバックのオプションを使用します。
バーチャルエージェントハブ経由で送信されるメッセージの場合、サードパーティーのバーチャルエージェントプロバイダーのドキュメントを参照して、フォールバックの処理方法を確認してください。

フォールバックテキストを作成する際、そのコンテンツはリッチメディアコンテンツと同様のメッセージを伝えるものでなければなりません。たとえば、リッチメディアコンテンツに、コンタクトがチョコレート味とバニラ味のどちらかを選択するためにクリックできる2つのボタンがある場合、フォールバックテキストではコンタクトに「チョコレートとバニラのどちらにしますか？」と尋ねます。

バーチャルエージェントとボットによるリッチメディア

バーチャルエージェントやボットに、チャットベースのメッセージでリッチメディアをコンタクトに送信させることができます。バーチャルエージェントやボットは、デジタルチャネルを経由してコンタクトに応答を送信します。リッチメディア要素の使用は、チャネルがサポートしている要素に限定されます。バーチャルエージェントが複数のチャネルでメッセージを送信する場合は、各リッチメディア要素にフォールバックテキストが定義されていることを確認してください。

バーチャルエージェントまたはボットが送信する各応答メッセージは、バーチャルエージェントまたはボットの設定内で個別に指定する必要があります。応答にリッチメディアを含めたい場合は、バーチャルエージェントまたはボットプロバイダーのプラットフォームで、応答の設定にこれを含める必要があります。

ボットビルダー

CXoneボットビルダーを使用して作成したボットでは、ボットがコンタクトに送信する応答にリッチメディアコンテンツを使用できます。ボットビルダーには、組み込みのリッチメディアオプションがいくつかあります。これらのオプションではJSONを構築する必要がありません。これらはボットデザイナーUIのオプションとして、ボットの応答メッセージを作成する際に使用できます。

ボットビルダーにはボタン、リストピッカー、リッチリンクのオプションがあります。さらに、ボットの応答でアダプティブカードをデザインして送信することもできます。ボットビルダーのオプションとしてネイティブに提供されていなくても、使用中のチャネルでサポートされているリッチメディア要素を使用したい場合は、以下の方法があります。

ボットとStudioスクリプトの間に統合を設定します。ボットビルダーで使用したいリッチメディアを使ってスクリプトを設定してください。
ボットビルダーでカスタムボット応答アクションを作成します。このオプションはJavaScriptを使用します。文字列化されたJSONオブジェクトをコンタクトに送信するようにアクションをコーディングすることができます。

バーチャルエージェントハブ

バーチャルエージェントハブで設定されたバーチャルエージェントの場合、応答メッセージは通常、バーチャルエージェントプロバイダーの管理コンソールで設定されます。たとえば、Google Dialogflow CXバーチャルエージェントを使用している場合、Google Cloud ProjectのDialogflowコンソールで応答メッセージを設定します。Dialogflow管理者が管理コンソールで応答を設定する場合、リッチメディア要素用のJSONを含める必要があります。

代替方法として、Studioスクリプトのスニペットにテンプレートを作成することができます。バーチャルエージェントから取得する必要のある値には変数を使用します。適切な値の変数だけをスクリプトに送信するように、バーチャルエージェントの応答メッセージを設定します。スクリプトでは、リッチメディア要素のJSONは、バーチャルエージェントから送信された値を使ってスニペットで構築されます。

TORMテンプレートをスクリプトで送信する

このスクリプトで使用されるGETRICHMESSAGEアクションは、指定されたポイントオブコンタクト(PoC) 着信連絡先が電話番号やEメールアドレスなどの対話を開始するために使用するエントリポイント。で利用可能なすべてのリッチメッセージングテンプレート用のJSONを含む、ダイナミック配列を取得します。resultSet.data[x]のインデックス番号は、jsonY.data[x]変数に保存したい配列要素を特定します。テンプレートのリストを見つけるには、スクリプトのトレースを実行し、トレース出力で変数resultSetの内容を確認できます。

スクリプト例をダウンロードして、スクリプト経由でTORMテンプレートを送信する際に使用することができます。

ACDアプリケーションのポイントオブコンタクト(PoC)デジタルページでテンプレートを作成し、それを適用したいポイントオブコンタクト(PoC)に割り当てます。このステップを完了するには、CXone管理者の協力が必要な場合があります。
デジタルメディアタイプのスクリプトを作成します。
GETRICHMESSAGEアクションと、ASKCALLERアクションかTeXTMSGアクションを追加します。ポイントオブコンタクト(PoC)にテンプレートが複数ある場合、SNIPPETアクションも必要です。
GETRICHMESSAGEのChannelIdプロパティを、テンプレートを割り当てたポイントオブコンタクト(PoC)で設定します。
SNIPPETアクションに適切なコードを追加します。
- テンプレートが1つしかない場合や、このスクリプトで送信したいテンプレートが1つだけの場合は、次のようなコードを使用してください：
```
DYNAMIC json1 
ASSIGN json1.data[1] = resultset.data[1]
```
- 複数のテンプレートがあり、このスクリプトで複数のテンプレートを送信したい場合は、次のようなコードを使用してください：
```
DYNAMIC json1
DYNAMIC json2
DYNAMIC json3
				 
ASSIGN json1.data[1] = resultset.data[1]
ASSIGN json2.data[1] = resultset.data[2]
ASSIGN json3.data[1] = resultset.data[3]
```
送信するテンプレートを識別するインデックス番号を変更します。前のステップのコード例では、変数resultset.data[x]のインデックス番号を変更します。テンプレートを割り当てる変数内のインデックスを変更しないでください。コード例では、変数はjsonY.data[Z]であり、Yは変更できますが、Zは変更できません。jsonY変数ごとに1つのテンプレートを保持します。
必要であれば変数名を変更してください。その場合は、必要に応じてスクリプトの他のアクションでも変数名を変更します。たとえば、resultSetは、GETRICHMESSAGeのresultSetプロパティのデフォルトの変数名です。jsonY変数は、AskCallerとTextmsgのMessageプロパティで使用されます。
AskCallerまたはTextmsgを設定します。
1. MessageFormatプロパティをJSONに設定します。
2. Messageを、送信するテンプレートのJSONを保持する変数の名前で設定します。これはJSON文字列として送信されなければなりません。このフィールドで変数置換を使用できます。その場合は、送信するテンプレートを選択して適切な変数を渡すコードをSnippetに追加します。
3. ブランチの接続など、必要に応じてアクションのその他のプロパティを設定します。ASKCALLERアクションまたはTeXTMSGアクションのオンラインヘルプを参照してください。

SNIPPETアクションでJSONを構築する

スクリプトでSnippetアクションを使ってリッチメディア用にJSONを構築し、これをコンタクトに直接送信できます。このオプションを使用するには：

コンテンツをコンタクトに送信する場合、デジタルチャネルがそのリッチメディアのタイプをサポートしていなければなりません。
チャネルが期待しているスキーマを使用する必要があります。これにより、チャネルはコンテンツを適切に表示することができます。この情報は、作業しているチャネルの開発者向けドキュメントに記載されていることがあります。ただし、TORMスキーマをサポートしているチャネルでこれを使用している場合は例外です。チャネルはTORMスキーマを認識しませんが、CXoneが、送信前に各チャネルが期待しているスキーマに変換します。
コンテンツをエージェントに表示する場合、エージェントアプリケーションがそのリッチメディアのタイプをサポートしていなければなりません。

バーチャルエージェントを経由してリッチメッセージを送信する場合、Studioスクリプトではなく、バーチャルエージェントプロバイダーの管理コンソールでリッチメッセージング用のJSONを構築する必要があるかもしれません。

好みのツールを使用して、適切なスキーマに従ってJSON構造を構築します。
JSONをテストします。これは、JSONの構造が正しいことを確認するのに役立ちます。無効なJSONのために後で必要となるトラブルシューティングをなくすか、減らすことができます。たとえば、JSONミラーツールを使用できます。
正しく機能する構造ができたら、それを1行の文字列に変換します。
Studioで、スクリプトにSnippetアクションを追加します。
Snippetで、JSON文字列をダイナミックオブジェクトに代入します。
スクリプトにAskcallerまたはTextmsgアクションを追加し、MessageプロパティにJSON文字列を保持するオブジェクトの名前を設定します。
JSONを含むオブジェクトをコンタクトまたはエージェントアプリケーションに送信するようにスクリプトを設定します。

リッチメディアをコンタクトに直接送信する

使用しているチャネルが、使用したいリッチメディアをサポートしていることを確認してください。
送信したいリッチメディアをスクリプトに設定します。たとえば、TORMテンプレートや、SNIPPETアクションで構築されたJSONを使用します。
AskcallerまたはTextmsgアクションを追加し、適切に設定します。
スクリプトを完了させます。

API経由でJSONスキーマを送信する

以下は、デジタルアウトバウンドAPI経由でリッチメッセージを送信する例です。エージェントアプリケーションまたはコンタクトにメッセージを送信できます。ただし、この方法で送信されたリッチメッセージは、現在のところエージェントアプリケーションに表示されません。代わりにfallbackTextの値が使用されます。

curl --location --request POST 'https://api-de-na1.dev.niceincontact.com/dfo/3.0/channels/chat_2360f828-e7dd-4e18-925e-48fba98e8349/outbound' \
--header 'Authorization: Bearer <accessToken>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "thread": {
  "idOnExternalPlatform": "4455006164606838"
},
"messageContent": {
    "type": "TIME_PICKER",
    "fallbackText": "Text sent if rich message is not available on external platform",
    "payload": {
   	   "title": {
	       "content": "Check our new gadget!"
        },
        "timeSlots": [
	       {
            "id": "unique-id-1",
	        "duration": 3600,
	        "startTime": "2017-05-26T08:27:55+00:00"
	        }
	     ],
		"location": {
			"title": {
			    "content": "Check our new gadget!"
			},
			"latitude": 44.44,
			"longitude": 55.55,
			"radius": 33.3
		  }
		}
 },
"recipients": [
    {
	  "idOnExternalPlatform": "57a58d5d-6423-4bd1-9282-533b8b095598",
	  "name": "Frankenstein Monster"
	}
  ]
}'

リッチメッセージングの制限事項

CXoneのリッチメッセージングには制限があります。すべてのデジタル Digital Experienceに関連するあらゆるチャネル、コンタクト、スキル。チャネルがすべてのリッチメディア要素をサポートしているわけではありません。CXoneでサポートされているアプリケーションエージェントでも、すべてのリッチメディア要素をサポートしていない場合があります。

コンタクトに送信されるアウトバウンドメッセージでは、メッセージの送信に使用されるデジタルチャネルでサポートされているすべてのリッチメディア要素を使用できます。使用するチャネルコンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。が、CXoneヘルプセンターに文書化されていないリッチメディアオプションをサポートしている場合、それを使用することができます。チャネルプロバイダーのスキーマドキュメントを参照し、スクリプトのSNIPPETアクションでを構築します。たとえば、組織が持ち込みチャネル (BYOC)を使用している場合、使用するチャネルは、このページに掲載されていないリッチメディアオプションをサポートしているかもしれません。

エージェントアプリケーションでエージェントに表示されるリッチメディアコンテンツの場合、コンテンツはアプリケーションによってサポートされているものでなければなりません。コンテンツがエージェントアプリケーションでサポートされていない場合、エージェントにはフォールバックテキストが表示されます。その場合でも、エージェントはそのコンテンツをコンタクトに送信することができます。チャネルがリッチメディア要素をサポートしている限り、意図したとおりのリッチコンテンツがコンタクトに表示されます。

チャネル別のリッチメディアのサポート

各デジタル Digital Experienceに関連するあらゆるチャネル、コンタクト、スキル。チャネルは、特定のリッチメディアをサポートしています。リッチメディアコンテンツをコンタクトに送信するデジタルスクリプトで作業する場合は、スクリプトが動作するチャネルが使用するリッチメディアに対応していることを確認してください。

次の表は、リッチメディアタイプのサポート状況をチャネルコンタクトがエージェントやボットとインタラクトするための方法です。チャネルは、音声、メール、チャット、ソーシャルメディアなどの可能性があります。別に示しています。リストにないチャネルは、現在リッチコンテンツに対応していません。他のチャネルで送信されたリッチコンテンツはすべて、そのチャネルでフォールバックテキストとして配信されます。

このセクションで説明するサポート状況は、リッチメディア要素全般に適用されます。TORMテンプレートやスキーマのチャネルによるサポートは含まれていません。

	アダプティブカードs	HTMLとMarkdownテキスト	リッチリンク	クイック返信	リストピッカー	タイムピッカー	フォームメッセージ
Apple Messages for Business
デジタルチャット
Eメール				フォールバックテキストを使用
Facebook Messenger
WhatsApp
Googleビジネスメッセージ

サポート対象：「サポートされている」ことを示す緑のチェックマーク

サポート対象外：「サポートされていない」ことを示す赤のX

エージェントアプリケーションにおけるリッチメディアのサポート

現在、リッチメディアはMAXでサポートされています。エージェントは、MAXの以下の場所で、リッチメディアコンテンツを含むメッセージテンプレートにアクセスできます。

TORM以外のテンプレート：[メッセージテンプレート]>[テンプレートの選択]。
TORM テンプレート：[リッチメッセージ]>[リッチメッセージ]。

次の表は、MAXの[顧客カード]セクションでエージェントが確認できる、チャネル別のリッチメディアコンテンツのサポート状況を示しています。

	アダプティブカードs	HTMLとMarkdownテキスト	リッチリンク	クイック返信	リストピッカー	タイムピッカー	フォームメッセージ
Apple Messages for Business
デジタルチャット
Eメール
Facebook Messenger
WhatsApp
Googleビジネスメッセージ

サポート対象：「サポートされている」ことを示す緑のチェックマーク

サポート対象外：「サポートされていない」ことを示す赤のX