ワークフロー変数
このセクションでは、Bright Pattern コンタクトセンターで使用される変数について説明します。 ワークフロー変数へのアクセスでは、一般的な $(varname) というフォーマットを使用します。変数は 整数 および 文字列 式内で使用できます。
| シナリオとワークフロー間の変数の受け渡し | ||
|
| |
共通変数
$(ユーザー.loginId)
$(user.loginId)
は 、ワークフローがエージェントのアクションによって開始された場合、そのエージェントのログイン ID を指定します。
注 ：この変数はシナリオ内で利用可能です。
$(ユーザー.firstName)
$(user.firstName) は、エージェントのファーストネームを指定します。
注 ：この変数は、シナリオ内で利用可能です。
$(ユーザー.lastName)
$(user.lastName)
は 、エージェントの姓を指定します。
注 ：この変数はシナリオ内で利用可能です。
$(item.caseId)
$(item.caseId)
は 、利用可能な場合、そのインタラクションのケース ID を指定します。
$(item.caseNumber)
$(item.caseNumber)
は 、利用可能な場合、そのインタラクションのケース番号を指定します。
$(item.contactId)
$(item.contactId) は、利用可能な場合、顧客の連絡先の id を指定します。
注 ：この変数はシナリオ内で利用可能です。
$(item.firstName)
$(item.firstName)
は 、利用可能な場合、顧客のファーストネームを指定します。
注 ：この変数はシナリオ内で利用可能です。
$(item.lastName)
$(item.lastName)
は 、利用可能な場合、顧客の姓を指定します。
注 ：この変数はシナリオ内で利用可能です。
$(item.agentSummary)
以下の機能にアクセスできます リアルタイムAI要約 にアクセスできます。
ワークフローが 「最後の disposition によるインタラクション終了」 または 「平均sentimentでインタラクションが終了」によってワークフローがトリガーされた場合、によってワークフローがトリガーされた場合、最後のエージェントの処理結果およびメモに基づいた、そのエージェントの要約のみが利用可能となります。
そのやり取りに関与したすべてのエージェントの要約を取得するには、 「エージェントが任意のdispositionでインタラクションを完了」 トリガーでワークフローを起動してください。
$(item.agentSummary.JSONObject)
以下の構造を持つ JSON オブジェクトとして、リアルタイム AI 要約が含まれます：
template_name(文字列)：要約の生成に使用されたテンプレートの名前。topics(オブジェクトの配列)：name(文字列)：トピックの名前。value(文字列)：トピックプロンプトに対する値。hide_from_agent(0, 1)：トピックがエージェントに対して非表示に設定されている場合は1、非表示でない場合は0となります。
{
"template_name": "Example Template",
"topics": [
{
"name" : "お問い合わせの理由",
"value" : "お客様から、120ドルの無料の客室カーペットクリーニング特別キャンペーンについてのお問い合わせがありました。",
"hide_from_agent" : "0"
},
{...}
]
}
$(item.agentSummary.HTML)
読みやすさを考慮してHTML形式でトピックタイトルがフォーマットされ、リアルタイムAI要約を提供します。トピック間は空行で区切られています。なお、「エージェントに非表示」とマークされているトピックであっても、すべてのトピックが含まれる点にご注意ください。
$(item.agentSummary.text)
リアルタイムAI要約をプレーンテキストフォーマットで提供します。トピックは空行で区切られています。「エージェントに非表示」としてマークされているトピックであっても、すべてのトピックが含まれる点にご注意ください。
$(global_interaction_id)
$(global_interaction_id) は、 グローバルインタラクション識別子を指定します。この変数は、$(item.globalInteractionId) としても知られています。
メモ：この変数はシナリオ内で利用可能です。
$(disposition)
$(disposition) は、 disposition を指定します。
注：この変数はシナリオ内で利用可能です。
$(サービス)
$(service) は、そのインタラクションに関連付けられたサービスを、サービス名を含む JSON オブジェクトとして返します。例：
{"name":"Email_third"}
値は生の JSON オブジェクトであるため、そこからサービス名を抽出するには、文字列操作または正規表現が必須となります。名前を直接扱う場合は、代わりに $(service.name) を使用してください。
$(サービス.名前)
$(service.name) は、サービス対話に関連付けられたサービスの名前をプレーンな文字列（例: "Email_third"）として返します。解析は不要です。
チャット用の変数
$(item.averageSentiment)
インタラクションに対してsentiment分析が実行されている場合、この変数には現在の平均sentiment値が設定されます。
メール用の変数
$(item.cc)
メールのCC（カーボンコピー）フィールドに含まれるすべてのアドレスを格納した文字列です。複数のアドレスはコンマで区切られます。例："名前" <EMAIL@domain.com>, email2@domain.com)。
$(item.language)
メールコンテンツから自動検出された言語
$(item.replyTo)
メールの返信先アドレス
音声用の変数
$(LanguageAsked)
$(LanguageAsked)
は、 お客様が特定の言語を指定したかどうか（例：「はい」）を示します。
$(NPS_raw)
$(NPS_raw) は、ネットプロモータースコア（NPS）の値を指定します（例：「11」）。
$(contact_satisfaction)
$(contact_satisfaction) は、顧客の連絡先満足度評価を指定します（例：「1」）。
$(destination)
$(destination) は、 Connect Call ブロックの宛先を指定します（例：「2042」）。
注：この変数はシナリオ内で利用可能です。
$(first_call)
$(first_call)
は、 この音声インタラクションが最初にかけられたコールであるかどうかを指定します（例：「1」）。
$(screenpopData)
$(screenpopData)
は 、IVR (対話型の音声応答) によって受信または設定されたスクリーンポップデータのリストを指定します。利用可能なスクリーンポップデータエレメントの実際のリストは、特定の IVR および統合環境によって異なります。
注 ：この変数はシナリオ内で利用可能です。
$(item.ANI)
$(item.ANI) は、ANI (自動番号識別) を指定します。これは、発信者に自身の電話番号を提供する電話会社のサービスです。「ANI」は、「発信者番号」の代わりに使用されることがよくあります。
注 ：この変数はシナリオ内で利用可能です。
$(item.DNIS)
$(item.DNIS) は、ダイヤル番号認識サービス (DNIS)を指定します。これは、電話会社によるサービスで、着信側に発信者がダイヤルした番号を提供するものです。「DNIS」は、「着信番号」の略語としてよく使用されます。
注 ：この変数はシナリオ内で利用可能です。
$(item.cnam)
$(item.cnam) は、発信元IDの表示名です（SIPネットワークによって提供されている場合）。
$(item.customerPhone)
$(item.customerPhone) は、顧客の電話番号を指定します。この変数を使用することで、顧客からのインバウンドおよびアウトバンドの主要なシナリオから、関連するコンサルテーションやブラインド転送のシナリオへ、顧客の電話番号情報を引き継ぐことができます。
- 新規着信のために起動されたシナリオでは、その値は $(item.from)
変数の値と適合します。
- 新規発信コール用に起動されたシナリオでは、その値は $(item.from)
変数の値と一致します。
- コンサルテーションコールおよびブラインド転送用に起動されたシナリオでは、$(item.customerPhone)
の値は、関連するプライマリコールのシナリオから継承されます。
注 ：この変数はシナリオ内で利用可能です。
$(item.メール)
顧客のメールアドレスです。シナリオでは、この変数の値を取得または設定することができます。
$(item.averageSentiment)
インタラクションに対してsentiment分析が実行されている場合、この変数は現在の平均sentiment値に設定されます。
$(item.from)
$(item.from) は、発信元アドレス（電話番号やチャットのユーザー表示名など）を指定します。この変数は、ANI とも呼ばれます。
$(item.interactionId)
$(item.interactionId) は、インタラクション識別子を指定します。
注 ：この変数はシナリオ内で利用可能です。
$(item.media)
$(item.media) は、メディアの種類（例：「音声」）を指定します。
注 ：この変数はシナリオ内で利用可能です。
$(outbound_data)
$(outbound_data) には架電リストからのデータが含まれており、ワークフローがアウトバンド・キャンペーンからトリガーされた場合に利用可能です。
$(メモ)
ケース／disposition結果に関するメモ（利用可能な場合）
$(item.トランスクリプト.JSON)
$(item.transcript.JSON) は、チャットセッションまたは音声コールの完全なトランスクリプトを JSON フォーマットで文字列として返します。
注 ：この変数は、シナリオからの情報を渡すことができます。
$(item.トランスクリプト.HTML)
$(item.transcript.HTML) には、チャットセッションまたは音声コールの HTML フォーマットのトランスクリプトが含まれます。
注 ：この変数には、シナリオからの情報が渡される場合があります。
$(item.トランスクリプト.テキスト)
$(item.transcript.text) には、チャットセッションまたは音声コールのテキスト形式のトランスクリプトが含まれます。
注 ：この変数には、シナリオからの情報が渡される場合があります。
過去の資産変数コレクション
以下の内容を含む変数 過去のトランスクリプト および インテリジェンス・エンジン.
$(item.customerSummary)
以下のものへのアクセスを提供します インタラクション終了後に生成される要約 へのアクセスを提供します。 「Wait Historical Asset」 ブロックが成功して実行された場合にのみ、このコレクションにデータが格納されます。データが格納された場合、このコレクションには、ワークフローがエージェント単位でトリガーされたか、インタラクション単位でトリガーされたかに関わらず、インタラクション全体の要約が含まれます。
$(item.customerSummary.JSONObject)
以下の構造を持つ JSON オブジェクトとして、AI 履歴要約が含まれます：
template_name(文字列)：要約の生成に使用されたテンプレートの名前。topics(オブジェクトの配列)：name(文字列)：トピックの名前です。value(文字列)：トピックのコンテンツまたは応答です。hide_from_agent(ブール値)：トピックがエージェントに非表示の場合は1、表示される場合は0です。
例：
{
"template_name": "既定(デフォルト）",
"topics": [
{
"name" : "連絡先の理由",
"value" : "お客様から、120ドルの無料客室カーペットクリーニング特別キャンペーンについてのお問い合わせが発信されました。",
"hide_from_agent" : "0"
},
{...}
]
}
$(item.customerSummary.HTML)
読みやすさを考慮してHTMLフォーマットでトピックタイトルが設定された、過去のAI要約を提供します。トピック間は空行で区切られています。「エージェントに非表示」とマークされているトピックであっても、すべてのトピックが含まれる点にご注意ください。
$(item.customerSummary.text)
トピックタイトルがプレーンテキストフォーマットで記載された、過去のAI要約を提供します。トピック間は空行で区切られています。「エージェントに非表示」としてマークされているトピックであっても、すべてのトピックが含まれる点にご注意ください。
$(item.histTranscript)
以下の内容にアクセスできます。 過去のトランスクリプト にアクセスできます。 「Wait Historical Asset」 ブロックが成功して実行された場合にのみ、このコレクションにデータが格納されます。データが格納されている場合、このコレクションには、ワークフローがエージェント単位でトリガーされたか、インタラクション単位でトリガーされたかに関わらず、インタラクション全体のトランスクリプトが含まれます。
$(item.histTranscript.JSONArray)
インタラクションの完全な履歴トランスクリプトを、メタデータを含むイベントオブジェクトの JSON 配列として返します。
$(item.histTranscript.HTML)
インタラクションの履歴トランスクリプト全体を、HTMLフォーマットで返します。
$(item.histTranscript.text)
履歴トランスクリプト全体をプレーンテキストフォーマットで返します。
$(item.categorySets)
以下の結果が含まれています。 カテゴリ化 の結果が含まれています。 「Wait Historical Asset」 ブロックが成功して初めて、このコレクションにデータが格納されます。
$(item.categorySets.JSONArray)
分類結果が、以下の構造を持つJSONオブジェクトの配列として格納されています：
set_name(文字列)：カテゴリーセットの名前です。
subset_name(文字列)：カテゴリーサブセットの名前です（オプション）。
categories(文字列の配列): 以下のインテントで指定されたカテゴリーのリスト インタラクション中にトリガーされた によってインタラクション内でトリガーされたカテゴリのリストです。
例：
[
{
"set_name": "連絡先の理由",
"カテゴリー": ["キャンセル", "再スケジュール"],
},
{
"set_name": "感情",
"subset_name": "ネガティブ",
"カテゴリー": ["怒り", "失望"],
},
{...}
]
$(item.categorySets.categoriesAll)
すべてのカテゴリセットにわたる対話中にトリガーされた、すべての異なるカテゴリーの配列が含まれます。例：
["キャンセル", "再スケジュール", "怒り", "失望", "混乱"]
$(item.discoveries)
インタラクションに対して識別子と発見を記載 Discoveryによって特定されたタグとディスカバリーが含まれます。 Wait Historical Asset ブロックが成功して初めて、このコレクションにデータが格納されます。
$(item.discoveries.JSONArray)
このインタラクションのディスカバリー結果が、以下の構造を持つJSONオブジェクトの配列として格納されています：
discovery_name(文字列)：ディスカバリーの名前です。
tags(文字列の配列)：そのディスカバリーに対して特定されたタグのリストです。
例：
[
{
"discovery_name": "連絡先の理由",
"tags": ["キャンセル", "再スケジュール"],
},
{
"discovery_name": "Sentiment",
"tags": ["Negative"],
},
{...}
]
$(item.discoveries.tagsAll)
そのインタラクションに関するすべての発見で識別された、重複のないタグをすべて含む配列です。例：
["キャンセル", "再スケジュール", "ネガティブ"]
CRM変数
CRM 統合（例：コミュニケーションウィジェットの使用）経由で開始されたインタラクションがワークフローをトリガーした場合、そのワークフローでは以下の CRM 変数にアクセスできます。これらの変数の使用例については、 コールと関連する Microsoft Dynamics レコードの関連付け.
$(recordingUrl)
$(recordingUrl) には、コンタクトセンター管理者アプリケーション内の対話レコードの URL が格納されています。
$(playbackUrl)
$(playbackUrl) には、対話レコードの再生用の独立した URL が含まれています。
$(serviceName)
$(serviceName) には、 そのインタラクションに関連付けられたサービスの名前が指定されます。
$(方向)
$(direction)
は、 インタラクションの方向を指定します。取り得る値は「inbound」および「outbound」です。
$(duration)
$(duration) は、 インタラクションの継続時間を秒単位で指定します。
$(startTime)
$(startTime)
は、 インタラクションが開始された時刻を示すタイムスタンプを指定します。
$(endTime)
$(endTime)
は、 インタラクションが終了した時刻を示すタイムスタンプを指定します。
$(numberOfAssociatedRecords)
$(numberOfAssociatedRecords) は、エージェントが当該インタラクションに関連付けられていると検証したCRMレコードの数を指定します。
$(associatedRecords)
$(associatedRecords) には、そのインタラクションに関連付けられた CRM レコードの識別子を含む JSON オブジェクトの配列が含まれています。この配列の長さは、$(numberOfAssociatedRecords) の値と一致します。 各 JSON オブジェクトには、「objectId」（CRM 内のレコード id）と「objectType」（CRM 内のレコードタイプ）という 2 つのプロパティが含まれています。
$(activityRecordId)
$(activityRecordId)
は、
作成されたアクティビティ・レコードの id を指定します。CRM 連携により複数のアクティビティ・レコードが作成された場合、この変数には最初のレコードの id のみが含まれます。