シナリオ変数

このセクションでは、Bright Pattern コンタクトセンターのシナリオおよびワークフローで使用される変数について説明します。

変数には、一般的な $(varname) というフォーマットでアクセスします。変数は整数および文字列式内で使用できます。

シナリオ変数のほとんどはローカル変数です。ローカルとは、接頭辞（例：item.、user. など）が付いておらず、その値が、定義元のシナリオ、および「別のシナリオを開始」ブロックを使用してその親シナリオから起動されたサブシナリオで利用可能であることを意味します。変数 $(item.customerPhone)、および、コンサルテーションコールやブラインド転送のために起動されたシナリオの「一般」または「ローカル」カテゴリーにあるすべての変数は、関連するプライマリコールの同じ変数の値を継承します。独立したシナリオ間でデータを共有するには、Fetch URL または DB Execute ブロックを使用して、変数値を永続ストレージに保存し、他のシナリオからアクセスすることをご検討ください。

入力フィールドに変数名を入力する際は、「$(」と入力すると、候補名のリストが表示されます。入力フィールドに文字を追加していくにつれて、候補リストは部分一致によって絞り込まれていきます。シナリオ内で生成されたカスタム変数は、リストの先頭にアルファベット順に表示されます。その後に、一般的なシナリオ変数が、同じくアルファベット順にリストされます。リスト内を移動するには上下の矢印キーを使用し、現在の候補を選択するには、Enterキーを押すか、その候補をダブルクリックしてください。

注: シナリオからワークフローへ情報を渡したい場合、すべてのシナリオ変数がワークフローへ情報を渡せるわけではないことにご注意ください。ただし、ローカル変数は常にワークフローに渡されます。ワークフローに渡されない変数については、変数の設定ブロックを使用して、必要なシナリオ変数をローカル変数に名前変更することができます（例："varDNIS" を $(item.DNIS) に設定する）。

ローカル変数

$(agentsBlacklistedForRouting)

「エージェント検索」ブロックは、この変数で指定されたエージェントにはインタラクションをルーティングしません。ルーティングから除外するエージェントは、コンマ区切りのエージェントIDまたはエージェント設定UUIDのリストとして指定します。例：

john.doe,48AD5207-CCD3-4765-9429-D092DF7526DE,wanda.bui

既定では、この変数は空です。「変数の設定」ブロックを使用して値を割り当てることができます。

この変数は、音声およびチャットの両方のシナリオで使用できます。

$(agentState)

$(agentState) は、直近の「エージェントの状態を取得」ブロックによって取得されたエージェントの状態を指定します。

$(banMonitoring)

$(banMonitoring) 変数を「1」または「true」（大文字小文字は区別されません）に設定することで、スーパーバイザーによるコールモニタリングを禁止できます。

$(banVoiceRecording)

$(banVoiceRecording) 変数を 1 または true（大文字小文字は区別されません）に設定すると、コール全体の音声録音を禁止できます。これにより、設定内のすべての録音設定が上書きされます。また、Agent Desktopやデスクトップ API メソッドを経由して手動で録音を有効にしようとする試みもすべてブロックされます。関連項目： $(doNotRecord)。さらに、この変数を使用して、録音の一部をミュートすることもできます。ミュートするには 1 に設定し、ミュートを解除するには 0 に設定してください。

なお、既定では、スーパーバイザーがコールをモニタリングする場合、$(banVoiceRecording) が「true」に設定されていても録音は自動的に開始されます。スーパーバイザーによるモニタリング対象のコールが録音されないようにするには、対応する録音オプションの選択を解除してください。コールのモニタリングを完全に禁止するには、$(banMonitoring) シナリオ変数を使用してください。

$(botContext)

$(botContext) 変数は、 AskABot ブロックの実行間で一貫したコンテキストを維持します。これにより、ボットに初期データを提供したり、シナリオからボット／チャット提案エンジン連携へ変数値を渡すことができます。シナリオ内で値が割り当てられた $(botContext) の各プロパティ（例：$(botContext.propertyName)）は、ボットエンジン側で propertyName として利用可能になります。

たとえば、シナリオで顧客名にアクセスできる場合、「変数の設定」ブロックを使用して botContext.customerName を設定することで、その値をボットの応答で使用できるようになります。この値の参照方法は、ボットプロバイダーによって異なります：

Amazon Lexボットの場合、値はセッション属性として利用可能であり、上記の例の変数は、インテントのプロパティを編集する際の「レスポンス」フィールドで [customerName] のように参照されます。
Watson Assistantsの場合、値はコンテキスト変数として利用可能であり、顧客名は、ダイアログのプロパティを編集する際の「応答内容」フィールドで $customerName として参照されます。

Watson V2 アシスタント固有のプロパティ

Watson Assistantsを使用する場合、以下の Watson 固有の $(botContext) プロパティに値を設定することができます：

$(botContext.metadata.user_id) - 電話番号など、コンタクトを一意に識別する識別子です。これにより、Watson は同じコンタクトからのやり取りを識別し、月間アクティブユーザー数の追跡が可能になります。
$(botContext.metadata.timezone) - コンタクトのタイムゾーン（IANA/Olson フォーマット）です。時間に基づく参照インターバル（例：「1時間後に折り返し電話する」）を計算するために使用されます。
$(botContext.metadata.locale) - コンタクトのロケール（ICU フォーマット）です。日付（例：月/日/年対日/月/年）など、ロケール固有のユーザー入力を解釈するために使用されます。

$(busyWithMediaType)

$(busyWithMediaType) は、直近の「エージェントの状態を取得」ブロックによって取得されたエージェントの「ビジー」理由を指定します。エージェントが異なるメディアタイプのインタラクションを複数保持している場合、以下の（ハードコーディングされた）優先順位に従って、1つのメディアタイプのみが返されます：

コール
チャット
プレビュー
メール

なお、After Call Work（ACW）の場合、メディアタイプは返されません。

$(destination)

$(destination) は、Connect Call または Connect Chat ブロックの宛先を指定します。

なお、宛先が IVR の場合、電話番号には、目的の連絡先やセルフサービスオプションにたどり着くために必要な休止や数字を含めることができます。休止にはコンマ記号を使用します。コンマ1つごとに、次の数字のダイヤルが1秒遅延します（例：18005552222,,,5,,245）。詳細については、『エージェントガイド』のセクション「外部IVRを通じたスピードダイヤルの方法」を参照してください。

$(dialerAssignedUserId)

個人割り当てのあるプログレッシブ・アウトバウンド・キャンペーンでカスタムシナリオを使用する場合、この変数にはダイヤラーによって割り当てられたエージェントIDが格納されます。これにより、「エージェント検索」ブロックを設定してまずこのエージェントを優先的に検索し、必要に応じてその他のロジックを使用して接続後のコールを処理することができます（たとえば、メッセージを再生したり、適切なスキルを持つ別のエージェントに転送したりするなど）。

$(doNotRecord)

$(doNotRecord) は、「コールを接続」ブロックの前に 1 または true（大文字小文字は区別されません）に設定することで、音声録音を無効にできます。これにより、設定内のすべての録音設定が上書きされます。録音は、Agent Desktopまたはデスクトップ API メソッドを経由して手動で有効にすることは引き続き可能です。関連項目： $(banVoiceRecording)。

$(fetchURLResultBody)

$(fetchURLResultBody) は、直近のFetch URLブロックによって受信されたHTTPレスポンスの本文を指定します。なお、このブロックは $(integrationResultBody) 変数経由でも同じ値を報告します。

$(fetchURLResultCode)

$(fetchURLResultCode) は、直近のFetch URLブロックによって受信されたHTTPレスポンスのコードを指定します。なお、このブロックは $(integrationResultCode) 変数経由でも同じ値を報告します。

$(integrationResultBody)

$(integrationResultBody) は、以下の統合ブロックのうち、最も直近のものによって受信された HTTP レスポンスの本文を指定します：

サードパーティ製アプリケーションでのデータの検索や更新の試行が失敗した理由を把握するには、各統合ブロックの後に、この変数と対応する $(integrationResultCode) を以下のように使用することをご検討ください：

If ブロックを使用して、失敗した試行と成功した試行を区別します（例：シナリオ変数（数値） $(integrationResultCode) が 200 でない場合）。（具体的な式は、サードパーティ製アプリケーションから返されるメッセージ、そのコード、および通知を受けたいメッセージの種類によって異なります。）
失敗した試行については、メールまたは内部メッセージブロックのいずれかを使用して、これら2つの変数のコンテンツを関係者に送信してください。

$(integrationResultCode)

$(integrationResultCode) は、直近の統合ブロックによって受信された HTTP レスポンスのコードを指定します。詳細については、$(integrationResultBody) 変数の説明を参照してください。

$(notReadyReason)

$(notReadyReason) は、直近の「エージェントの状態を取得」ブロックによって取得されたエージェントの「Not Ready」理由を指定します。

$(playListenDTMF)

シナリオ内でPlay-Listenブロックを使用する場合、$(playListenDTMF) 変数には、バッファに格納された顧客からのDTMF入力が保存されます。これにより、呼び出された後続のシナリオブロックでその情報を取得することが可能になります。なお、この変数に意味のある値が格納されるのは、顧客が電話のボタンを押した場合のみです。

$(targetDisconnectedCause)

顧客とのチャット中にエージェントとの接続が切断された場合、$(targetDisconnectedCause) 変数は、Connect Chat ブロックの「Target Disconnected」分岐において、エージェント切断の原因をチャットシナリオに通知します。考えられる原因としては、「UserHangup」、「SystemHangup」、「UserLogout」、または「Failure」のいずれかが挙げられます。

$(contactInfo)

タスクシナリオに適用されます。この変数は、Queue Task API リクエストで提供される、タスクに関連付けられたコンタクトのプロパティを含むオブジェクトです。ドット表記を使用して個々のプロパティにアクセスできます。たとえば、$(contactInfo.firstName) はコンタクトのファーストネームを返し、$(contactInfo.emails[0].address) はコンタクトのメールアドレスの1つを返します。その他のプロパティには、lastName、title、position、addresses などがあります。API ドキュメントには、contactInfo のすべてのプロパティが記載されています。

$(caseInfo)

この変数は、Queue Task API リクエストで提供される、タスクに関連付けられたコンタクトのプロパティを含むオブジェクトです。個々のプロパティにはドット表記でアクセスできます。ケースカテゴリーを取得するには $(caseInfo.category) を、カスタムフィールドを取得するには $(caseInfo.custom_<custom_field_name>) を使用します。

$(taskInfo)

この変数は、Queue Task API リクエストで提供される、タスクに関連付けられたコンタクトのプロパティを含むオブジェクトです。個々のプロパティにはドット表記でアクセスできます。タスクの件名を取得するには $(taskInfo.subject) を、カスタムフィールドを取得するには $(caseInfo.custom_<custom_field_name>) を使用します。

$(ttsVoice)

$(ttsVoice) を設定することで、シナリオで使用する TTS 音声を指定できます。

$(___sip_response_code___)

$(___sip_response_code___) は、応答されなかったインバウンドコールに対して送信される SIP 応答コードを指定するオプションの変数です。既定値は 480 です。この変数は、シナリオに Accept または Answer ブロックが含まれており、かつシナリオが Answer ブロックの前に終了する場合にのみ機能します。

$(XXX)

$(XXX) はカスタム（ユーザー定義）変数です。XXX を意味のある変数名（例：$(accountNumber)）に置き換えてください。カスタム変数は、同じシナリオ内のブロック間でカスタムデータを渡すため、また、プライマリの顧客コールのシナリオから関連する従属コール（コンサルテーションおよびブラインド転送）へそのようなデータを転送するために使用されます。コンサルテーションコールおよびブラインド転送のために起動されたシナリオは、関連するプライマリコールのシナリオで定義されたすべてのカスタム変数を再作成し、その値を継承します。

スクリーンポップデータ

$(screenpopData.XXX)

$(screenpopData.XXX) は、IVR（対話型音声応答）によって受信または設定されたスクリーンポップデータのリストを指定します。利用可能なスクリーンポップデータ要素の実際のリストは、特定の IVR および統合環境によって異なります。

メディア項目（コール、チャット、タスク、メール）のプロパティ

$(item.allowChatHistoryForCase)

チャットシナリオでは、$(item.allowChatHistoryForCase) により、BPCC Mobile/Web Messaging API v2 を経由してケース履歴にアクセスできるようになります。具体的には、Get Case History メソッドを使用してチャットケース履歴を取得したり、Close Case メソッドを使用してケースをクローズしたりすることができます。Set Variable ブロックを使用して、変数 $(item.allowChatHistoryForCase) にケースIDの値を設定できます。

この変数を使用するシナリオの例については、『Mobile SDK 取扱説明書』のセクション「Bright Patternのシナリオとアプリケーション」を参照してください。

$(item.averageSentiment)

インタラクションに対して感情分析が実行されている場合、$(item.averageSentiment) 変数には現在の平均感情値が設定されます。この値は、平均感情値が更新されるたびに変更されます。

注：この変数はワークフロー内で利用可能です。

$(item.body)

メールシナリオでは、メールの本文が含まれます。

$(item.caseId)

メールシナリオでは、関連するケースのIDが含まれます。

$(item.caseNumber)

メールシナリオでは、関連するケースの番号が含まれます。

$(item.cc)

メールシナリオでは、メールの CC（カーボンコピー）フィールドに含まれるすべてのアドレスを文字列として格納します。複数のアドレスはコンマで区切られます。例："Name" <email@domain.com>, email2@domain.com)。

$(item.coBrowsing)

コブラウジングが有効になっている場合、$(item.coBrowsing) は、チャットクライアントからコブラウジングセッションが要求されたかどうかを判定するために使用されます。この変数は、シナリオ内のカスタムレポートフィールドに追加することができます。この変数が整数値 1 を返す場合、チャットセッション内でコブラウジングセッションがリクエストされたことを意味します。初期値は 0 です。

注: 「カスタムレポートフィールドの設定」ブロックをConnect Chatブロックの後に配置する場合は、この機能を正しく動作させるために、「カスタムレポートフィールドの設定」ブロックの前に、1秒の遅延を設定した待機ブロックを追加することを推奨します。

$(item.contactId)

$(item.contactId) は、発信者に紐づく CRM コンタクト（存在する場合）の ID を指定します。

注：この変数はワークフロー内で利用可能です。

$(item.continuationUserId)

顧客が以前にシステムに連絡し、エージェントに接続されていた場合、$(item.continuationUserId) 変数にはそのエージェントのユーザーIDが設定されます。この変数を使用することで、新規の顧客とのやり取りを同じエージェントにルーティングすることができます。注: この変数を使用するには、シナリオの「エージェント検索」ブロックの前、および／またはこの変数を参照する箇所の前のいずれかに、「コンタクトの識別」ブロックを含める必要があります。詳細については、「内部データベースを使用した最終担当エージェントルーティングの設定方法」を参照してください。

$(item.customerPhone)

$(item.customerPhone) は、顧客の電話番号を指定します。この変数を使用することで、プライマリのインバウンドおよびアウトバウンド顧客コールのシナリオから、関連するコンサルテーションおよびブラインド転送のシナリオへ、顧客の電話番号情報を渡すことが可能になります。

新規着信のために起動されたシナリオでは、その値は $(item.from) 変数の値と一致します。
新規発信コールのために起動されたシナリオでは、その値は $(item.to) 変数の値と一致します。
コンサルテーションコールおよびブラインド転送のために起動されたシナリオでは、$(item.customerPhone) の値は、関連するプライマリコールのシナリオから継承されます。

注：この変数はワークフローで使用可能です。

$(item.data.<name>)

$(item.data.<name>) は、オプションの追加インタラクションデータのキーと値のリストを指定します。特定のデータ要素のコンテンツを取得するには、$(item.data.<name>) を使用します（例：$(item.data.firstName)）。

$(item.email)

$(item.email) は、顧客のメールアドレスを指定します。カンマまたはセミコロンで区切られた複数のアドレスが含まれる場合があり、シナリオではこの変数の取得や設定が可能です。メールシナリオで送信者のメールアドレスが必要な場合は、$(item.from) 変数を使用してください。

注：この変数はワークフロー内で利用可能です。

$(item.emotion)

インタラクションに対して感情分析が実行されている場合、$(item.emotion) 変数には、最後に分析されたフレーズの感情値が設定されます。

$(item.EWT)

音声およびチャットのインタラクションでは、$(item.EWT) はそのアイテムの現在の推定待ち時間（秒単位）です。

$(item.externalChatData)

チャットのインタラクションでは、$(item.externalChatData) 変数を使用して、顧客のチャットページから受信したデータ全体を指定します。これは、チャットがRequest Inputブロックにあった際に顧客が入力したすべての値を格納するコンテナであり、シナリオ内で後から使用できるようになっています。

さらに、$(item.externalChatData) を使用すると、ウィジェットのプレチャット設定からカスタム変数を渡すことができます。入力フィールド（テキストボックス）はこれらのカスタム変数として保存でき、name フィールドの値が変数名の末尾として保存されます（例：name = issue の場合、変数 = $(item.externalChatData.issue)）。なお、この変数は大文字小文字が区別されます。正しく機能させるには、変数を小文字で入力する必要があります。

$(item.externalChatData.user_platform.browser)

チャットのインタラクションでは、この変数は顧客が使用しているブラウザの種類とバージョンを返します。なお、この変数にデータが含まれるのは、顧客側のチャットアプリケーションがBright Pattern Chat Widget Configurationアプリケーションを使用して設計されている場合のみです。

$(item.externalChatData.channel)

チャットのインタラクションでは、この変数は、顧客がチャットセッションで使用しているメッセンジャーの名前を返します：

Viber - "viber" LINE - "line" WhatsApp - "whatsapp" Telegram - "telegram" Facebook - "facebook" Twitter - "twitter" WeChat - "wechat" $(item.externalChatData) のコンテンツ構造は、CWSから受信する session_data のコンテンツ構造と同じです。

$(item.externalChatData.language)

チャットのインタラクションでは、この変数は以下のフォーマットでデータを返します：

Viber - ISO 639-1 コード（「en」） LINE - ISO 639-1 コード Telegram - ISO 639-1 コード Facebook - ISO 639-1 コード Twitter DM - "" またはなし WeChat - "" またはなし

$(item.externalChatData) のコンテンツ構造は、CWSから受信する session_data のコンテンツ構造と同じです。


	Facebook：$(item.externalChatData.language) を利用可能にするには、Facebookアプリに pages_user_locale へのアクセス権限が付与されている必要があります。コンタクトセンターは、Facebookの適切なチャネルを通じてこれを申請し、Facebookによる承認を得る必要があります。

$(item.externalChatData.user_platform.browser)

チャットのインタラクションでは、この変数は顧客が使用しているブラウザの種類とバージョンを返します。なお、この変数にデータが含まれるのは、顧客側のチャットアプリケーションがBright Pattern Chat Widget Configurationアプリケーションを使用して設計されている場合のみです。

$(item.externalChatData.user_platform.os)

チャットのインタラクションでは、この変数は顧客が使用しているオペレーティングシステムの種類とバージョンを返します。なお、この変数にデータが含まれるのは、顧客側のチャットアプリケーションがBright Pattern Chat Widget Configurationアプリケーションを使用して設計されている場合のみです。

$(item.externalChatData.user_platform.description)

チャットのインタラクションでは、この変数は顧客が使用しているブラウザおよびオペレーティングシステムの種類とバージョンを返します。なお、この変数にデータが含まれるのは、顧客側のチャットアプリケーションがBright Pattern Chat Widget Configurationアプリケーションを使用して設計されている場合のみです。

$(item.externalChatData.user_platform.ip)

チャットのインタラクションでは、この変数は「Request Chat」リクエストを送信したクライアントまたは最後のプロキシのIPアドレスを返します。なお、この変数にデータが含まれるのは、顧客側のチャットアプリケーションがBright Pattern Chat Widget Configurationアプリケーションを使用して設計されている場合のみです。

$(item.extCaseId)

タスクシナリオでは、APIを介してタスクがキューに登録された際に extCaseId プロパティに指定されていた場合、そのタスクに関連付けられたケースの外部IDが含まれます。

$(item.extContactId)

タスクシナリオでは、APIを介してタスクがキューに登録された際に extContactId プロパティに指定されていた場合、そのタスクに関連付けられた外部コンタクトIDが含まれます。

$(item.extTaskId)

タスクシナリオでは、APIを介してタスクがキューに登録された際に extTaskId プロパティに指定されていた場合、そのタスクの外部IDが含まれます。

$(item.firstName)

$(item.firstName) は、顧客のファーストネームを指定します。シナリオでは、この変数を取得または設定することができます。変数を設定すると、履歴データベースのインタラクションステップおよび顧客のチャット相手情報も更新されます。

注：この変数はワークフロー内で利用可能です。

$(item.Files)

$(item.Files) には、チャット経由で送受信された添付ファイルに関する情報が格納されます。具体的には、添付ファイルのID、ファイル名、BPCCによって割り当てられたURL、添付ファイルの種類、および関連するテキストが格納されます。添付ファイルのリストは配列として列挙され、システムログまたはコンタクトセンターのストレージデータベースで確認できます。$(item.numFiles) が空の場合、$(item.files) も空となり、添付ファイルの表は表示されません。

注：この変数はワークフロー内で利用可能です。

$(item.from)

$(item.from) は発信元アドレスを指定します。この変数は ANI とも呼ばれます。インタラクションのソースに応じて、以下のいずれかになります：

電話番号
チャットユーザーの表示名
チャットユーザーのIPアドレス
発信者の メッセンジャーチャネル：ユーザーID（例：whatsapp:15555555555 または viber:jsaydns7256s）
送信者のメールアドレス

$(item.globalInteractionId)

$(item.globalInteractionId) は、グローバルインタラクション識別子を指定します。

$(item.interactionId)

$(item.interactionId) は、インタラクション識別子を指定します。このパラメータは、下位互換性を維持するために保持されています。Bright Pattern Contact Center バージョン 3.11 以降では、インタラクション識別に関わる操作には $(item.globalInteractionId) 変数の使用が推奨されます。

$(item.interactionStepId)

$(item.interactionStepId) は、インタラクションステップ識別子を指定します。この変数は、 Interaction Content API を通じて録音データや関連するメタデータを取得するために使用できます。

その他のインタラクション識別に関わる操作については、$(item.globalInteractionId) 変数を使用する必要があります。

$(item.keywords)

インタラクションに対して感情分析が実行されている場合、$(item.keywords) 変数には、最後に分析されたフレーズに含まれるキーワードの配列が設定されます。

$(item.language)

メールシナリオでは、可能な場合、そのメールから検出された言語が含まれます。

$(item.lastName)

$(item.lastName) は、顧客の姓を指定し、SMSインタラクションでは ANI を渡します。シナリオでは、この変数を取得または設定することができます。変数を設定すると、履歴データベースのインタラクションステップおよび顧客のチャット相手情報も更新されます。

注：この変数はワークフロー内で利用可能です。

$(item.lastTransferTargetPhone)

この変数は、エージェントがインタラクション中にコールを転送した先の電話番号を表します。単一ステップの転送が開始されたとき、またはコンサルテーション転送が完了したときに設定されます。転送が実行されると、この変数は定義され、次の転送が発生するまでその値を保持します。この変数はワークフローでも利用可能です。

$(item.media)

$(item.media) は、メディアの種類を指定します。この変数は、voice、chat、email、または task に設定できます。

$(item.message)

チャットのインタラクションでは、$(item.message) 変数は、発信元側から受信した最新のチャットメッセージを指定します。

$(item.newcaseflag)

メールシナリオでは、そのメールが新規のケースを作成したか（値 1）、既存のケースに関連付けられたか（値 0）を示します。

$(item.newMessage)

チャットのインタラクションでは、$(item.newMessage) 変数は、顧客から受信したものとして新しいメッセージを追加します。この変数は、チャットセッションにフォームフィールドの値を入力するために使用されます。新しいメッセージは、顧客から受信したものとして扱われ、チャットのトランスクリプトに追加されます。

$(item.numFiles)

$(item.numFiles) は、チャットまたはメールで送受信された添付ファイルの数を指定します。注：この変数はワークフロー内で利用可能です。

$(item.order)

タスクのインタラクションでは、タスクの処理順序タイプを示します。値は、fifo（先入れ先出し）または lifo（後入れ先出し）のいずれかになります。

$(item.priority)

タスクシナリオでは、タスクを作成したAPIリクエストで設定された初期優先度値を示します。注: 「優先度の設定」ブロックによってタスクの優先度が更新された場合でも、この変数の値はシナリオ実行中は変更されません。

$(item.priorTo)

$(item.priorTo) は、直前の宛先アドレス（電話番号またはチャット起動ポイント名）を指定します。これは、転送されたコールに使用されます。

$(item.queuePos)

音声およびチャットのインタラクションでは、$(item.queuePos) は、そのアイテムのキュー内での現在の順位を表します。なお、案内されるキュー内の順位は、実際の順位よりも高くなる場合があります。これは、顧客が「あなたのキュー内の順位は3番目です」と案内された後、1分後に同じ顧客が「あなたのキュー内の順位は5番目です」と案内されるような事態を防ぐためです。この変数は、インタラクションが「エージェント検索」ブロック内にある間のみ結果を表示します。それ以外のときは空白となります。

$(item.replyto)

メールシナリオでは、指定されている場合、そのメールの返信先アドレスが含まれます。

$(item.screenpop)

タスクシナリオでは、APIを介してタスクがキューに登録された際に screenpop プロパティに指定されていた場合、そのスクリーンポップ文字列（例：SHOW_OBJECT:192837465:task）が含まれます。

$(item.sendTranscript)

チャットのインタラクションでは、セッションのトランスクリプトを顧客にメールで送信するために、シナリオで $(item.sendTranscript) 変数を 1 に設定する必要があります。この変数はいつでも設定可能です。トランスクリプトは、セッション終了時に $(item.email) で指定されたアドレス宛てにメールで送信されます。対応するメールテンプレートおよびSMTP設定については、『コンタクトセンター管理者ガイド』のセクション「メール設定」を参照してください。

$(item.sentiment)

インタラクションに対して感情分析が実行されている場合、$(item.sentiment) 変数には、最後に分析されたフレーズの感情値が設定されます。

$(item.sip.headers)

$(item.sip.headers) は、インバウンドコールからの SIP INVITE ヘッダーのキーと値のリストを取得します。この変数を使用すると、個々の P-、X-、Diversion ヘッダーのコンテンツを取得できます。特定のヘッダーのコンテンツを取得するには、$(item.sip.headers.<header_name>) を使用します（例：$(item.sip.headers.X-tdm-channelnumber)）。

$(item.sip.headers.XXX=ZZZ)

インバウンドコールがシナリオに届く場合、シナリオはSIP INVITE内のSIPヘッダーを item.sip.headers.XXX=ZZZ というフォーマットで受信できます。ここで、XXX はヘッダー名（例：「P-Customer-Type」）です。なお、XXX は文字「P」または「X」で始まる必要があります。注: P- や X- 以外のさまざまなSIPヘッダーを受信することも可能ですが、それらはコンタクトセンターのトランクに対して定義されている必要があります。詳細については、サービスプロバイダーにお問い合わせください。

注: Bright Pattern Contact Center の一部のバージョンでは、以下のヘッダーを設定することはできません：

P-Preferred-Identity
P-Asserted-Identity
P-Called-Party-ID
P-Associated-URI
P-Media-Authorization
P-Ipcm-Extensions
P-Mref-To
P-Conf-Policy
P-Conf-Party

$(item.sip.send.headers.XXX=ZZZ)

Connect Call ブロックを使用して発信を行う場合、シナリオは発信側のSIP INVITEに、item.sip.send.headers.XXX=ZZZ というフォーマットでSIPヘッダーを追加することができます。ここで、XXX はヘッダー名（例：「P-Customer-Type」）です。なお、XXX は文字「P」または「X」で始まる必要があります。注: P- や X- 以外のさまざまなSIPヘッダーを送信することも可能ですが、それらはコンタクトセンターのトランクに対して定義されている必要があります。詳細については、サービスプロバイダーにお問い合わせください。

注: Bright Pattern Contact Center の一部のバージョンでは、以下のヘッダーを設定することはできません：

P-Preferred-Identity
P-Asserted-Identity（*場合によっては設定可能です。サービスプロバイダーにお問い合わせください）
P-Called-Party-ID
P-Associated-URI
P-Media-Authorization
P-Ipcm-Extensions
P-Mref-To
P-Conf-Policy
P-Conf-Party

$(item.subject)

メールおよびタスクのシナリオでは、メールまたはタスクの件名が含まれます。

$(item.to)

$(item.to) は宛先アドレスを指定します。この変数は DNIS とも呼ばれ、以下の情報を含む可能性があります：

ダイヤルされた電話番号
チャット起動ポイント名
対象の メッセンジャーチャネル：ユーザーID（例：whatsapp:15555555555 または viber:jsaydns7256s）
宛先メールアドレス

$(item.transcript)

$(item.transcript) は、チャットセッションまたは音声コールの完全なJSON形式のトランスクリプトを取得します（つまり、Speech to Text連携が設定されている場合）。

$(item.transcript.text)

$(item.transcript.text) は、チャットセッションまたは音声コールのテキストトランスクリプトを取得します（つまり、Speech to Text連携が設定されている場合）。

$(item.transcript.HTML)

$(item.transcript.HTML) は、チャットセッションまたは音声コールのHTML形式のトランスクリプトを取得します（つまり、Speech to Text連携が設定されている場合）。

$(item.transcript.JSON)

$(item.transcript.JSON) は、チャットセッションまたは音声コールのトランスクリプトを、JSON形式の文字列として取得します（つまり、Speech to Text連携が設定されている場合）。

$(item.virtualDevice)

音声シナリオでは、$(item.virtualDevice) 変数を設定することで、シナリオ終了時にインバウンドコールを終了させないよう指定できます。この場合、コールは「仮想電話」（PBX上の外部エージェント用）に変換されます。

シナリオ設定プロパティ

$(app.version)

$(app.version) は、シナリオのバージョン（設定サーバーから報告される値）を指定します。

$(app.appName)

$(app.appName) 変数は、シナリオの名前を指定します。

$(app.name)

$(app.name) は、シナリオエントリー名を指定します。

$(app.priority)

$(app.priority) 変数には、シナリオの起動ポイントで指定された優先度が格納されます。

なお、「app」で始まるすべての変数は、シナリオ自体（例：app.name）または起動ポイント（例：app.priority）からの設定パラメータであることにご注意ください。

$(app.tenantName)

$(app.tenantName) はテナント名です。

カスタムパラメータ

$(app.custom.XXX)

$(app.custom.XXX) は、シナリオエントリーで指定できるカスタムパラメータの名前です。この変数は、$(app.custom.XXX) という命名規則に従う必要があります。ここで、XXX はカスタムパラメータの名前です。この規則に準拠するすべてのシナリオ変数は、カスタムパラメータとして扱われます。このようなパラメータのリストは、対象のシナリオに関連付けられたすべてのシナリオエントリーの「シナリオパラメータ」プロパティに表示されます。これらのカスタムパラメータの値は、各シナリオエントリーごとに個別に設定できます。

ユーザー設定変数

$(user.id)

$(user.id) は、設定情報内でこのユーザーオブジェクトに割り当てられた一意の識別子です。

$(user.version)

$(user.version) は、ユーザーの設定情報のバージョンです。

$(user.loginId)

この変数は、ユーザーのユーザー名です。

注：この変数はワークフロー内で利用可能です。

$(user.team)

$(user.team) は、ユーザーが割り当てられているチームの名前です。

$(user.firstName)

$(user.firstName) は、ユーザーのファーストネームです。

注：この変数はワークフロー内で利用可能です。

$(user.lastName)

$(user.lastName) は、ユーザーの姓です。

注：この変数はワークフロー内で利用可能です。

$(user.phone)

この変数は、ユーザーがログインしている電話番号、または設定で指定されたユーザーの内線番号です。

サービスパラメータ

$(service.id)

$(service.id) は、サービスIDを返します。これはシナリオでのみ機能し、ワークフローでは機能しません。

$(service.name)

$(service.name) は、（シナリオエントリーまたは「スキルまたはサービスのリクエスト」ブロックで指定された）サービスの名前です。

$(service.outCallDropTimeout)

$(service.outCallDropTimeout) は、Unattended call timeout の設定値です。なお、この変数は予測型およびプログレッシブアウトバウンドキャンペーンでのみ利用可能です。

$(service.version)

$(service.version) は、サービス設定情報のバージョンです。

$(service.slPercent)

この変数は、サービスレベルコールの割合を指定します。

$(service.slTimeout)

$(service.slTimeout) 変数は、サービスレベルのタイムアウトを秒単位で指定します。

$(service.EWT)

$(service.EWT) は、そのサービスの現在の推定待ち時間です。これは、直近の応答済み20件のインタラクションが、応答されるまでサービスキューで待機していた平均時間として算出されます。

$(service.queueLength)

$(service.queueLength) は、特定のサービスのキューの長さを示します。ここで、「キューの長さ」とは、キュー内のコールの総数を指します（例：現在キューで待機中のコールが20件ある場合、それがそのキューの長さとなります）。

アウトバウンドターゲットワークアイテムのパラメータ

$(workitem.id)

$(workitem.id) は、ワークアイテムの識別子です。

$(workitem.firstName)

$(workitem.firstName) は、顧客のファーストネームです。

$(workitem.lastName)

$(workitem.lastName) は、顧客の姓です。

$(workitem.suggestedPhone)

この変数は、顧客の既定の電話番号です。

$(workitem.otherInfo)

$(workitem.otherInfo) は、電話番号、ファーストネーム、姓を除くすべてのリストフィールドを指定します（例：$(workitem.otherInfo.MTN)）。

$(workitem.fullInfo)

$(workitem.fullInfo) は、すべてのリストフィールドを指定します（例：$(workitem.fullInfo.MTN)）。

< 前へ