使用可能な問い合わせ属性のリストと、その JSONPath リファレンス - Amazon Connect

使用可能な問い合わせ属性のリストと、その JSONPath リファレンス

以下の表により、Amazon Connect で利用できる問い合わせ属性について説明します。

各属性の JSONPath 参照が提供されているため、それらを動的なテキスト文字列の作成に使用できます。

システム属性

これらは、Amazon Connect に定義済みの属性です。システム属性は参照できますが、作成することはできません。

問い合わせフロー内のすべてのブロックがシステム属性を使用してサポートするわけではありません。例えば、顧客の入力を保存するためにシステム属性を使用することはできません。お客様が入力したデータを保存するには、ユーザー定義の属性を使用します。

属性 説明 タイプ JSONPath 参照

顧客番号

顧客の電話番号。

アウトバウンドウィスパーフローで使用する場合、これは顧客に連絡するためにエージェントがダイヤルした番号です。インバウンドフローで使用した場合、これは顧客が電話をかけた番号です。この属性は、問い合わせレコードに含まれています。これを Lambda 関数で使用する場合には、CustomerEndpoint にある入力オブジェクト内のものを使用します。

システム

$.CustomerEndpoint.Address

カスタマー ID

顧客 ID 番号。

システム

$.CustomerId

ダイヤルした番号

顧客がコンタクトセンターに電話するためにダイヤルした番号。

この属性は、問い合わせレコードに含まれています。Lambda 関数で使用する場合には、SystemEndpoint にある入力オブジェクトに含まれています。

システム

$.SystemEndpoint.Address

顧客のコールバック番号

Amazon Connect が、顧客に折り返し通話するために使用する電話番号。

この電話番号は、キューに登録された折り返し通話に使用される番号や、エージェントが CCP からダイヤルする際に使用される番号です。折り返し通話のキュー機能、または CCP からダイヤルするエージェントに対し転送します。

デフォルト値は、顧客がコンタクトセンターに連絡するために使用した番号です。ただしこの値は、[折り返し通話番号を設定する] ブロックにより上書きが可能です。

この属性は問い合わせレコードに含まれず、Lambda 入力でアクセスすることもできません。ただしこの属性は、問い合わせレコードに含まれている [Set contact attribute] (問い合わせ属性を設定する) ブロックを使用することで、ユーザー定義の属性にコピーできます。またこの属性は、問い合わせレコードに含まれていない [AWS Lambda function] ( Lambda 関数を呼び出す) ブロックに、Lambda 入力パラメータとして渡すことができます。

システム

該当なし

保存済みのお客様の入力

最近の [顧客の入力を保存する] ブロックから作成される属性。

この属性値は、最近の [顧客の入力を保存する] ブロックの呼び出しで作成されたものです。この属性は問い合わせレコードに含まれず、Lambda 入力でもアクセスできません。この属性は、問い合わせレコードに含まれている [Set contact attribute] (問い合わせ属性の設定) ブロックを使用してユーザー定義の属性にコピーできます。またこの属性は、[AWS Lambda 関数を呼び出す] ブロックに、Lambda 入力パラメータとして渡すことができます。

システム

該当なし

キュー名

キューの名前。

システム

$.Queue.Name

キュー ARN

キューの ARN。

システム

$.Queue.ARN

アウトバウンドの番号をキューに登録する

選択されたキューへのアウトバウンド通話者 ID 番号の登録。この属性は、アウトバウンドのウィスパー問い合わせフローでのみ使用可能です。

システム

テキスト読み上げの音声

問い合わせフローでテキスト読み上げ機能に使用する Amazon Polly 音声の名前。

システム

$.TextToSpeechVoiceId

問い合わせ ID

問い合わせの一意の識別子。

システム

$.ContactId

イニシャル問い合わせ ID

問い合わせのための、(顧客とコンタクトセンターとの間で最初に行われた対話に関連付けられた) 一意の識別子。最初の問い合わせ ID を使用して、問い合わせフロー間の問い合わせを追跡します。

システム

$.InitialContactId

タスク問い合わせ ID

タスク問い合わせの一意の識別子。タスク問い合わせ ID を使用して、問い合わせフロー間の問い合わせを追跡します。

システム

$.Task.ContactId

前の問い合わせ ID

転送される前の問い合わせの一意の識別子。前の問い合わせ ID を使用して、問い合わせフロー間の問い合わせを追跡します。

システム

$.PreviousContactId

チャンネル

コンタクトセンターとの通話に使用する方法 (VOICE、CHAT、または TASK)。

システム

$.Channel

インスタンス ARN

Amazon Connect インスタンスの ARN。

システム

$.InstanceARN

開始メソッド

問い合わせが開始された方法。有効な値は、INBOUND、OUTBOUND、TRANSFER、CALLBACK、API、QUEUE_TRANSFER、DISCONNECT、および API です。

エージェントウィスパーフローまたはお客様ウィスパーフローでは、開始メソッドは動作しません。

システム

$.InitiationMethod

名前

タスクの名前。

システム

$.Name

説明

タスクの説明。

システム

$.Description

リファレンス:

問い合わせに関連する他のドキュメントへのリンク。

システム

$.References.ReferenceKey. 値と、$.References.ReferenceKey. タイプ。ReferenceKey はユーザー定義の参照名に置き換えます。

言語

コンテンツの言語。

標準の java.util.Locale を使用します。例えば、米国英語の場合は en-US、日本語の場合は JP-JP などです。

システム

$.LanguageCode

システムエンドポイントタイプ

システムエンドポイントのタイプ。有効な値は TELEPHONE_NUMBER です。

システム

$.SystemEndpoint.Type

カスタマーエンドポイントタイプ

カスタマーエンドポイントのタイプ。有効な値は TELEPHONE_NUMBER です。

システム

$.CustomerEndpoint.Type

キューのアウトバウンド発信者 ID 番号

アウトバウンド発信者 ID 番号はキューに対して定義されます。カスタム発信者 ID を設定した後に発信者 ID を復元するのに便利です。

システム

$.Queue.OutboundCallerId.Address

キューのアウトバウンド発信者 ID 番号タイプ

キューのアウトバウンド発信者 ID 番号のタイプ。有効な値は TELEPHONE_NUMBER です。

システム

$.Queue.OutboundCallerId.Type

エージェントの属性

次の表に、Amazon Connect で利用できるエージェントの属性を一覧表示します。

属性 説明 タイプ JSONPath 参照

エージェントユーザー名

エージェントが Amazon Connect にログインするために使用するユーザー名。

システム

$.Agent.UserName

エージェントの名

Amazon Connect のユーザーアカウントに入力されているエージェントの名 (ファーストネーム)。

システム

$.Agent.FirstName

エージェントの姓

Amazon Connect のユーザーアカウントに入力されているエージェントの姓 (ラストネーム)

システム

$.Agent.LastName

エージェント ARN

エージェントの ARN。

システム

$.Agent.ARN

注記

エージェントへの転送フローで使用するエージェントの問い合わせ属性には、転送を開始したエージェントではなくターゲットのエージェントが反映されます。

エージェント属性は、次のタイプの問い合わせフローでのみ使用できます。

  • エージェントウィスパー

  • お客様ウィスパー

  • エージェント保留

  • お客様ウィスパー

  • 発信ウィスパー

  • エージェントへの転送。この場合のエージェント属性には、転送を開始したエージェントではなく、ターゲットのエージェントが反映されます。

エージェント属性は、次の問い合わせフロータイプでは使用できません。

  • 顧客キュー

  • キューへの転送

  • 着信問い合わせフロー

キュー属性

これらは、問い合わせフローの [キューメトリクスを取得する] ブロックを使用したときに返されるシステムメトリクス属性です。

コンタクトセンターで現在のアクティビティがない場合、これらの属性に対して NULL 値が返されます。

属性 説明 タイプ JSONPath 参照

キュー名

メトリクスが取得されたキューの名前。

システム

$.Metrics.Queue.Name

キュー ARN

メトリクスが取得されたキューの ARN。

システム

$.Metrics.Queue.ARN

キュー内の問い合わせ

現在キュー内にある問い合わせの数。

システム

$.Metrics.Queue.Size

キューの最も古い問い合わせ

最も長くキューに入っている問い合わせの場合は、問い合わせがキューに入っている時間の長さ (秒単位)。

システム

$.Metrics.Queue.OldestContactAge

オンラインエージェント

現在オンライン、つまり、ログインしていて、オフライン以外の何らかの状態にあるエージェントの数。

システム

$.Metrics.Agents.Online.Count

使用可能なエージェント

状態が [Available] に設定されているエージェントの数。

システム

$.Metrics.Agents.Available.Count

対応エージェント

現在対応可能なエージェントの数。対応可能とは、ログインしていて、[Available]、[ACW] または [Busy] 状態にあるエージェントです。

システム

$.Metrics.Agents.Staffed.Count

連絡作業後のエージェント

現在 ACW 状態にあるエージェントの数。

システム

$.Metrics.Agents.AfterContactWork.Count

ビジー状態のエージェント

現在、問い合わせに対応中のエージェントの数。

システム

$.Metrics.Agents.Busy.Count

不在のエージェント数

[Missed] 状態のエージェント数。エージェントは、不在問い合わせの後、この状態に入ります。

システム

$.Metrics.Agents.Missed.Count

非生産的な状態にあるエージェント

非生産的 (NPT) 状態にあるエージェントの数。

システム

$.Metrics.Agents.NonProductive.Count

テレフォニー通話メタデータ属性 (通話属性)

テレフォニーメタデータは、テレフォニーキャリアからの通話発信に関連する追加的な情報を提供します。

属性

説明

タイプ

JSONPath 参照

P-Asserted-Identity

エンドユーザーのソース。

システム

$.Media.Sip.Headers.P-Asserted-Identity

P-Charge-Info

通話に関連する料金の責任者。

システム

$.Media.Sip.Headers.P-Charge-Info

From

リクエストに関連付けられたエンドユーザーの ID。

システム

$.Media.Sip.Headers.From

To

リクエストの着信側または受信側に関する情報。

システム

$.Media.Sip.Headers.To

ISUP-OLI

発信ラインインジケータ (OLI) 通話を発信する回線のタイプ (PSTN、800 サービスコール、ワイヤレス/セルラー PCS、公衆電話など) を示します。

システム

$.Media.Sip.Headers.ISUP-OLI

JIP

管轄区域表示パラメータ (JIP) 発信者/スイッチの地理的位置を表します。

値の例: 212555

システム

$.Media.Sip.Headers.JIP

ホップカウンター

ホップカウンター。

値の例:0

システム

$.Media.Sip.Headers.Hop-Counter

発信スイッチ

発信スイッチ。

値の例: 710

システム

$.Media.Sip.Headers.Originating-Switch

発信トランク

発信トランク。

値の例: 0235

システム

$.Media.Sip.Headers.Originating-Trunk

Call-Forwarding-Indicator

通話転送インジケータ (ディバージョンヘッダーなど) 国内または海外の通話の発信元を示します。

値の例:sip:+15555555555@public-vip.us2.telphony-provider.com;reason=unconditional

システム

$.Media.Sip.Headers.Call-Forwarding-Indicator

Calling-Party-Address

発信側アドレス (電話番号)。NPAC dip は、真のラインタイプと国内の地理的スイッチを示します。

値の例: 15555555555;noa=4

システム

$.Media.Sip.Headers.Calling-Party-Address

Called-Party-Address

着信側アドレス (電話番号)。

値の例: 15555555555;noa=4

システム

$.Media.Sip.Headers.Called-Party-Address

注記

テレフォニーメタデータは、すべてのテレフォニープロバイダーで利用できるわけではなく、すべてのケースに対応するとは限りません。この値は空になることがあります。

メディアストリームの属性

次の表は、ライブメディアストリーム内で顧客の音声が開始/停止する位置を特定するための属性の一覧です。

属性

説明

タイプ

JSONPath 参照

顧客のオーディオストリーム ARN

参照のための顧客データを含む、ライブメディアストリーミングに使用される Kinesis Video ストリームの ARN。

メディアストリーム

$.MediaStreams.Customer.Audio.StreamARN

ライブメディアストリーミングに使用される、顧客側 Kinesis ビデオストリームのオーディオ開始タイムスタンプ。

顧客のオーディオストリームが開始された時刻。

メディアストリーム

$.MediaStreams.Customer.Audio.StartTimestamp

顧客のオーディオ停止タイムスタンプ

ライブメディアストリーミングが使用している Kinesis ビデオストリームが、顧客側のオーディオストリームによって停止された時刻。

メディアストリーム

$.MediaStreams.Customer.Audio.StopTimestamp

顧客のオーディオ開始フラグメント番号

ライブメディアストリーミングで使用されているストリーム内にあり、顧客側のオーディオストリームの開始に使用された、Kinesis Video Streams のフラグメントを識別する番号。

メディアストリーム

$.MediaStreams.Customer.Audio.StartFragmentNumber

Amazon Lex 問い合わせ属性

次の表は、Amazon Lex ボットから返される属性の一覧です。

属性 説明 タイプ JSONPath 参照

代替インテント

Amazon Lex から利用可能な代替インテントのリスト。各インテントには、対応する信頼スコアと入力するスロットがあります。

Lex

$.Lex.AlternateIntents.x.IntentName

$.Lex.AlternateIntents.x.IntentConfidence

$.Lex.AlternateIntents.x.Slots

$.Lex.AlternateIntents.y.IntentName

$.Lex.AlternateIntents.y.IntentConfidence

$.Lex.AlternateIntents.y.Slots

$.Lex.AlternateIntents.z.IntentName

$.Lex.AlternateIntents.z.IntentConfidence

$.Lex.AlternateIntents.z.Slots

インテントの信頼スコア

Lex

$.Lex.

インテント名

Amazon Lex によって返されるユーザーのインテント。

Lex

$.Lex.IntentName

感情ラベル

Amazon Comprehend が最も信頼度が高いと推測されるセンチメント。

Lex

$.Lex.SentimentResponse.Label

感情スコア

センチメントが正しく推測された可能性。

Lex

$.Lex.SentimentResponse.Scores.Positive

$.Lex.SentimentResponse.Scores.Negative

$.Lex.SentimentResponse.Scores.Mixed

$.Lex.SentimentResponse.Scores.Neutral

セッション属性

セッション固有のコンテキスト情報を表すキーと値のペアのマップ。

Lex

$.Lex.SessionAttributes.attributeKey

スロット

対話中にユーザーによる入力から Amazon Lex が検出した、インテントのスロットのマップ (キー/値のペア)。

Lex

$.Lex.Slots.slotName

ダイアログ状態

Amazon Lex ボットから返される最後のダイアログの状態。インテントが問い合わせフローに返された場合、値は「受理済み」です。

該当なし (UI に表示されるタイプはなし)

$.Lex.dialogState

ケースの問い合わせ属性 (プレビュー)

次の表では、Amazon Connect Cases で使用される属性を一覧表示しています。

属性 説明 タイプ JSONPath 参照 データソース

ケース ID

UUID 形式のケースの一意の識別子 (例: 689b0bea-aa29-4340-896d-4ca3ce9b6226) text

$.Case.case_id

Amazon Connect

ケースの理由

ケースをオープンした理由

$.Case.case_reason

single-select エージェント

カスタマー

API は顧客プロファイル ID です。[Cases: Fields] (Cases: フィールド) ページに、顧客の名前が表示されます。

$.Case.customer_id

text Amazon Connect

クローズ日時

ケースが最後にクローズされた日時。ケースがクローズされたことを保証するものではありません。ケースが再度オープンにされた場合、このフィールドには、ステータスが最後にクローズに変更されたときの日時のスタンプが含まれます。

$.Case.last_closed_datetime

date-time Amazon Connect

オープン日時

ケースがオープンされた日時。

$.Case.created_datetime

date-time Amazon Connect

更新日時

ケースが最後に更新された日時。

$.Case.last_updated_datetime

date-time Amazon Connect

参照番号

数字形式 (8 桁) のケースのわかりやすい番号。

参照番号は、(Case ID とは異なって) 一意であることが保証されません。顧客を特定してから、参照番号を収集して適切なケースを正しく見つけるようにすることをお勧めします。

$.Case.reference_number

text エージェント

ステータス

ケースの現在のステータス

$.Case.status

text エージェント

概要

ケースの概要

$.Case.summary

text エージェント

[Title] (タイトル)

ケースのタイトル

$.Case.title

text エージェント

Lambda での問い合わせ属性

Lambda の属性は、[AWS Lambda 関数を呼び出す] ブロックの最新の呼び出しからキーと値のペアとして返されます。Lambda の属性は、Lambda 関数の呼び出ごとに上書きされます。

JSONPath で外部属性を参照するには、以下を使用します。

  • $.External.attributeName

この際、AttributeName は属性名、または関数から返されたキーと値のペアの中のキーの部分を意味します。

例えば、関数が問い合わせ ID を返した場合は、 $.External.ContactId を使用して属性を参照します。Amazon Connect から返される問い合わせ ID を参照する場合の JSONPath は $.ContactId です。

注記

属性と Amazon Connect の間に関連がない場合は、JSONPath 参照に .External が含まれることに注意してください。外部ソースから返される属性名の大文字と小文字が一致していることを確認します。

Lambda 関数で属性を使用する方法の詳細については、「AWS Lambda 関数を呼び出す」を参照してください。

これらの属性は問い合わせレコードに含まれておらず、次回の Lambda 呼び出しにも渡されません。また、スクリーンのポップ情報のために CCP に渡されることもありません。ただし、AWS Lambda 関数を呼び出すブロックにおいて Lambda 関数入力として渡すことや、問い合わせ属性を設定するブロックを介して、ユーザー定義の属性にコピーすることは可能です。[Set contact attributes] (問い合わせ属性の設定) ブロックで使用されると、コピーされた属性が問い合わせレコードに含まれ、CCP で使用できるようになります。

ユーザー定義の属性

その他のすべての属性については、Amazon Connect によってキーと値が定義されます。ただし、ユーザー定義の属性については、ユーザーがキーと値の名前を指定します。

問い合わせフローに値を格納し、それらの値を後で参照する場合は、ユーザー定義の属性を使用します。例えば、Amazon Connect と CRM などのシステムを統合する場合には、顧客にメンバー番号などの情報を入力してもらう必要があります。このメンバー番号は、メンバーに関する情報を CRM から取得するためや、問い合わせフロー全体的のために使用することができます。

属性

説明

タイプ

JSONPath 参照

選択した任意の名前

ユーザー定義の属性は、以下の 2 つの部分で構成されます。

  • 送信先キー: キーに対して選択した任意の名前です。ただし、$ および . (ピリオド) 文字は、ともに JSONPath の属性パスを定義するために使用されるため使用できません。

  • 値: 任意の値を設定します。必要であれば、いくつかの段落を入力しテキスト文を構成することも可能です。(問い合わせレコード属性セクションの最大サイズについては、「機能の仕様」を参照してください。)

ユーザー定義

$.Attributes.name_of_your_destination_key

ユーザー定義の属性を作成するには、問い合わせ属性の設定ブロックを使用します。

Apple Messages for Business の属性

Apple Business Chat の顧客をルーティングするには、次の問い合わせ属性を使用します。例えば、様々な基幹業務で Apple Business Chat を使用している場合は、 AppleBusinessChatGroup お問い合わせ属性に基づいてそれぞれの問い合わせフローへの分岐が可能です。また、Apple Business Chat のメッセージを他のチャットメッセージとは異なる方法でルーティングしたい場合は、MessagingPlatform に基づいた分岐を行います。

属性 説明 タイプ JSON

MessagingPlatform

顧客からの要求の発信元であるメッセージングプラットフォーム。

正確な値: AppleBusinessChat

ユーザー定義 $.Attributes.MessagingPlatform

AppleBusinessChatCustomerId

Apple から提供された、顧客の不明瞭な ID。この値は、AppleID とビジネスに対しては一定のままです。これを使用して、メッセージが新しい顧客からのものか、再訪した顧客からのものかを識別できます。

ユーザー定義 $.Attributes.AppleBusinessChatCustomerId

AppleBusinessChatIntent

チャットのインテント、あるいは目的を定義することができます。このパラメータは、顧客側で [ビジネスチャット] ボタンがクリックされている場合に、メッセージ内でチャットセッションを開始した URL の中に含まれます。

ユーザー定義 $.Attributes.AppleBusinessChatIntent

AppleBusinessChatGroup

顧客における特定の質問や問題を処理するのに最適な、部門または個人を指定するためのグループを定義します。このパラメータは、顧客側で [ビジネスチャット] ボタンがクリックされている場合に、メッセージ内でチャットセッションを開始した URL の中に含まれます。

ユーザー定義 $.Attributes.AppleBusinessChatGroup

AppleBusinessChatLocale

ユーザーインターフェイスに表示したい言語とAWS リージョンを定義します これは、言語識別子 (ISO 639-1) とリージョン識別子 (ISO 3166) で構成されます。例えば、en_US

ユーザー定義 $.Attributes.AppleBusinessChatLocale

Customer Profiles の属性

次の問い合わせ属性を使用して、エージェントアプリケーション内の顧客プロファイルに、希望の値を自動入力します。

属性

説明

タイプ

JSONPath 参照

profileSearchKey

ユーザー定義の属性は、以下の 2 つの部分で構成されます。

  • 送信先キー: キーに対して選択した任意の名前です。ただし、$ および . (ピリオド) 文字は、ともに JSONPath の属性パスを定義するために使用されるため使用できません。

  • 値: 任意の値を設定します。必要であれば、いくつかの段落を入力しテキスト文を構成することも可能です。(問い合わせレコード属性セクションの最大サイズについては、「機能の仕様」を参照してください。)

ユーザー定義

$.Attributes.name_of_your_destination_key