Amazon Connect 中可用的聯絡屬性清單及其 JSONPath 參考 - Amazon Connect

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Amazon Connect 中可用的聯絡屬性清單及其 JSONPath 參考

下表描述 Amazon Connect 提供的聯絡屬性。

提供了每個屬性的 JSONPath 引用,以便您可以 建立動態文字字串

系統屬性

這些是 Amazon Connect 中預先定義的屬性。您可以參考系統屬性,但無法自行建立這些屬性。

並非所有流程​中的區塊都支援使用系統屬性。例如,您不能使用系統屬性來存放客戶輸入。請以使用者定義屬性來存放使用者輸入的資料。

屬性 描述 Type JSONPath 參考

AWS 區域

使用時,這會傳回正在處理聯絡人 AWS 區域 的 。例如,us-west-2,us-east-1,等等。

系統

$.AwsRegion 或 $['AwsRegion']

客戶地址或號碼

客戶的電話號碼或電子郵件地址 (如果使用電子郵件管道)。

支援用於語音通話、SMS、WhatsApp 商業傳訊和電子郵件。

在外撥低語流程中使用時,這是客服人員撥號聯絡客戶的號碼。​用於撥入流程時,這是客戶的發話號碼。此屬性包含在聯絡人記錄中。在 Lambda 函數中使用時,它會包含在 CustomerEndpoint 下的輸入物件中。

系統

$.CustomerEndpoint.Address

客戶 ID

客戶的識別號碼。例如,CustomerId 可能是 CRM 中的客戶編號。您可以建立 Lambda 函數,從 CRM 系統中提取來電者的唯一客戶 ID。語音 ID 會使用此屬性作為來電者的 CustomerSpeakerId

系統

$.CustomerId

系統地址或號碼

支援用於語音通話、SMS、電子郵件和 WhatsApp 商業傳訊。

客戶撥打到聯絡中心的電話號碼,或聯絡人將電子郵件傳送到的電子郵件地址 (如果使用電子郵件管道)。

此屬性包含在聯絡人記錄中。在 Lambda 函數中使用時,它會包含在 SystemEndpoint 下的輸入物件中。

系統

$.SystemEndpoint.Address

客戶顯示名稱

傳送至聯絡中心的電子郵件上的客戶名稱。

系統

$.CustomerEndpoint.DisplayName

系統顯示名稱

客戶傳送的電子郵件地址的顯示名稱。

系統

$.SystemEndpoint.DisplayName

副本電子郵件地址清單

傳送至聯絡中心的傳入電子郵件副本電子郵件地址的完整清單。

系統

$.AdditionalEmailRecipients.CcList

收件者電子郵件地址清單

傳送至聯絡中心的傳入電子郵件收件者電子郵件地址的完整清單。

系統

$.AdditionalEmailRecipients.ToList

客戶回撥電話號碼

Amazon Connect 用來回電給客戶的號碼。

此號碼可以是佇列回電使用的號碼,或當客服人員從 CCP 撥號時使用的號碼。轉接至回電佇列功能,或用於客服人員從 CCP 撥號。

預設值是客戶用來呼叫您的聯絡中心的號碼。但該值可用 設定回撥號碼 區塊來覆寫。

​此屬性不包含在聯絡人記錄中,也無法在 Lambda​ 輸入中存取。然而,您可以使用 設定聯絡屬性 區塊,將包含於聯絡人記錄中的屬性複製到使用者定義屬性。您也可以將此屬性作為 Lambda 輸入參數 (未包含於聯絡人記錄中) 傳遞到 AWS Lambda 函數 區塊中。

系統

不適用

存放的客戶輸入

從最近的 儲存客戶輸入內容 區塊調用建立的屬性。

從最近的 儲存客戶輸入內容 區塊調用建立的屬性值。​此屬性不包含在聯絡人記錄中,也無法在 Lambda​ 輸入中存取。您可以使用 設定聯絡屬性 區塊,將包含於聯絡人記錄中的屬性複製到使用者定義屬性。您也可以將此屬性作為 Lambda 輸入參數傳遞到 AWS Lambda 函數 區塊中。

系統

$.StoredCustomerInput

佇列名稱

佇列的名稱。

系統

$.Queue.Name

佇列 ARN

佇列的 ARN。

系統

$.Queue.ARN

佇列外撥號碼

選定佇列的外撥來電者 ID 編號。此屬性只能在外撥低語流程中使用。

系統

文字轉語音音檔

在流程中用於文字轉換語音的 Amazon Polly 語音名稱。

系統

$.TextToSpeechVoiceId

聯絡人 ID

聯絡案例的唯一識別碼。

系統

$.ContactId

初始聯絡案例 ID

客戶與您的聯絡中心首次互動時,與聯絡案例關聯的唯一識別符。使用初始聯絡案例 ID 可追蹤流程之間的聯絡案例。

系統

$.InitialContactId

任務聯絡人 ID

任務聯絡人的唯一識別符。使用工作聯絡人 ID 追蹤流程之間的任務。

系統

$.Task.ContactId

先前的聯絡人 ID

聯絡案例在轉交前的唯一識別符。使用前聯絡案例 ID 可追蹤流程之間的聯絡案例。

系統

$.PreviousContactId

Channel

與聯絡中心聯絡所用的方法:VOICE、CHAT、TASK、EMAIL。

系統

$.Channel

執行個體 ARN

您的 Amazon Connect 實例的 ARN。

系統

$.InstanceARN

啟動方法

聯絡案例最初啟動的方式。有效值包括:INBOUND、OUTBOUND、TRANSFER、CALLBACK、QUEUE_TRANSFER、EXTERNAL_OUTBOUND、MONITOR、DISCONNECT、WEBRTC_API 和 API。

系統

$.InitiationMethod

Name

任務的名稱。

系統

$.Name

Description

任務的描述。

系統

$.Description

參考

連結至與聯絡人相關的其他文件。

系統

$.References.ReferenceKey.Value 和 $.References.ReferenceKey.Type,其中 ReferenceKey 是使用者定義的 Reference 名稱。

Language

內容使用的語言。

使用標準的 java.util.Locale。例如,en-US 代表美國英文,ja-JP 代表日文等。

系統

$.LanguageCode

系統端點類型

系統端點的類型。有效值為 TELEPHONE_NUMBER。

系統

$.SystemEndpoint.Type

客戶端點類型

客戶端點的類型。有效值為 TELEPHONE_NUMBER。

系統

$.CustomerEndpoint.Type

佇列外撥發起人 ID 編號

該佇列定義的外撥發起人 ID 編號。適合用來在設好自訂發起人 ID 後再回復發起人 ID。

系統

$.Queue.OutboundCallerId.Address

佇列外撥發起人 ID 編號類型

外撥發起人 ID 編號的類型。有效值為 TELEPHONE_NUMBER。

系統

$.Queue.OutboundCallerId.Type

Tags (標籤)

用來組織、追蹤或控制此資源存取的標籤。如需 在 Amazon Connect 中將標籤新增至資源 標籤的詳細資訊,請參閱 和 設定精細帳單以查看 Amazon Connect 用量的詳細視圖

系統

$.Tags

區段屬性

區段屬性是使用屬性對應存放在個別聯絡區段上的一組系統定義的鍵值對。但您可以建立使用者定義的區段屬性,如下表所述。

屬性 Description 允許的值 Type JSONPath 參考

connect:Subtype

代表用於聯絡的管道子類型。

  • "connect:SMS"

  • "connect:WebRTC"

  • "connect:Guide"

  • "connect:Apple"

  • "connect:WhatsApp"

  • "connect:ExternalAudio"

  • "connect:Chat"

  • "connect:Telephony"

  • "connect:Task"

  • "connect:Email"

ValueString

$.SegmentAttributes['connect:Subtype']

connect:Direction

代表聯絡的方向。例如,傳入或傳出。

  • "INBOUND"

  • "OUTBOUND"

ValueString

$.SegmentAttributes['connect:Direction']

connect:CreatedByUser

代表建立任務的使用者 ARN。

ValueString

$.SegmentAttributes['connect:CreatedByUser']

connect:AssignmentType

代表任務的指派方式。

"SELF"

ValueString

$.SegmentAttributes['connect:AssignmentType']

connect:EmailSubject

代表電子郵件聯絡的主旨。

ValueString

$.SegmentAttributes['connect:EmailSubject']

connect:ScreenSharingDetails

ScreenSharingDetails 區段會保留對聯絡執行之螢幕共用活動的相關資訊。

ScreenSharingActivated 索引鍵會指出是否為聯絡啟用了螢幕共用工作階段。

"connect:ScreenSharingDetails": { "ScreensharingActivated" : "TRUE" // Allowed Values "TRUE" and "FALSE" }

ValueString

$.SegmentAttributes['connect:ScreenSharingDetails']

connect:ContactExpiry

包含聯絡到期的詳細資訊,例如任務和電子郵件聯絡的 ExpiryDurationExpiryTimeStamp

valueMap

$.SegmentAttributes['connect:ContactExpiry']

connect:CustomerAuthentication

聊天聯絡的身分驗證詳細資訊。

"connect:CustomerAuthentication": { "valueMap": { "IdentityProvider": { "ValueString": ""}, "ClientId": { "ValueString": ""}, "Status": { "ValueString": *AUTHENTICATED | FAILED | TIMEOUT*}, "AssociatedCustomerId": { "ValueString": ""} "AuthenticationMethod": { "ValueString": "*CONNECT" | "CUSTOM*" } } }

ValueMap

$.SegmentAttributes['connect:CustomerAuthentication']

connect:ValidationTestType

代表測試和模擬類型。對於非模擬聯絡人,此欄位保持空白。您可以在分析儀表板中使用此屬性來篩選出實際的客戶聯絡人,或識別聯絡人是否在您的聯絡人記錄物件中模擬。

「EXPERIENCE_VALIDATION」 ValueString $.Segment.Attributes【'connect:ValidationTestType'】

用戶端 ID

Amazon Cognito 應用程式用戶端識別碼。

ValueString

$.SegmentAttributes['connect:CustomerAuthentication']['ClientId']

身分提供者

用來驗證客戶的身分提供者。

ValueString

$.SegmentAttributes['connect:CustomerAuthentication']['IdentityProvider']

狀態

身分驗證程序的狀態。

AUTHENTICATED | FAILED | TIMEOUT

ValueString

$.SegmentAttributes['connect:CustomerAuthentication']['Status']

相關聯的客戶 ID

客戶的識別號碼。這是自訂識別碼或客戶設定檔識別碼。

ValueString

$.SegmentAttributes['connect:CustomerAuthentication']['AssociatedCustomerId']

身分驗證方法

Amazon Connect 管理的身分驗證工作流程或客戶自管身分驗證工作流程。

CONNECT | CUSTOM

ValueString

$.SegmentAttributes['connect:CustomerAuthentication']['AuthenticationMethod']

電子郵件主旨

客戶傳送至聯絡中心的電子郵件中的電子郵件主旨。如果您想要查看電子郵件主旨中是否有特定關鍵字,這將有其效用。

區段屬性

$.SegmentAttributes['connect:EmailSubject']

Amazon SES 垃圾郵件判定

當電子郵件送達您的聯絡中心時,Amazon SES 會掃描電子郵件是否為垃圾郵件。您可以檢查是否有 FAILED 狀況,然後捨棄電子郵件,或將其放入特殊佇列中供主管檢閱。

區段屬性

$.SegmentAttributes['connect:X-SES-SPAM-VERDICT']

Amazon SES 病毒判定

當電子郵件送達您的聯絡中心時,Amazon SES 會掃描電子郵件是否有病毒。您可以檢查是否有 FAILED 狀況,然後捨棄電子郵件,或將其放入特殊佇列中供主管檢閱。

區段屬性

$.SegmentAttributes['connect:X-SES-VIRUS-VERDICT']

使用者定義屬性

您可以選擇任何使用者定義的屬性,並將其存放在區段屬性下的聯絡上。屬性必須預先定義,才能用來將值存放在聯絡上。請參閱 使用聯絡區段屬性

若未預先定義任何值,Amazon Connect 會允許所有字串值。未選取新增預先定義的屬性頁面上的強制執行有效值選項時,也是如此。若已選取強制執行有效值選項,並預先定義值,則聯絡只會針對預先定義的屬性索引鍵存放有效且預先定義的值。(如果使用 API,請參閱 EnableValueValidationOnAssociation 參數。)

String

$.SegmentAttributes['Attribute_key_name']

檢視屬性

下表列出 Amazon Connect 中可用的檢視屬性。

屬性 描述 Type JSONPath 參考

Action

與檢視互動的使用者所採取的動作。動作會顯示為來自 顯示檢視 區塊的流程分支

檢視

$.Views.Action

檢視結果資料

使用者與檢視互動產生的輸出資料 (根據使用者執行操作的元件)。

檢視

$.Views.ViewResultData

功能屬性

下表列出 Amazon Connect 中可用的功能屬性。這些屬性支援螢幕和影片共用功能。如需詳細資訊,請參閱設定應用程式內、Web、視訊通話,以及螢幕共用功能

屬性 描述 Type JSONPath 參考

客服人員螢幕共用功能

為參與者啟用的螢幕共用功能。

功能

$.Capabilities.Agent.ScreenShare

客服人員視訊功能

為通話參與者啟用的視訊共用功能。

功能

$.Capabilities.Agent.Video

客戶螢幕共用功能

為參與者啟用的螢幕共用功能。

功能

$.Capabilities.Customer.ScreenShare

客戶視訊功能

為通話參與者啟用的視訊共用功能。

功能

$.Capabilities.Customer.Video

客服人員屬性

下表列出的是 Amazon Connect 提供的客服人員屬性。

屬性 描述 Type JSONPath 參考

客服人員使用者名稱

客服人員用來登入 Amazon Connect 的使用者名稱。

系統

$.Agent.UserName

客服人員名字

客服人員於自己的 Amazon Connect 使用者帳戶輸入的名字。

系統

$.Agent.FirstName

客服人員姓氏

客服人員在自己的 Amazon Connect 使用者帳戶輸入的姓氏。

系統

$.Agent.LastName

客服人員 ARN

客服人員的 ARN。

系統

$.Agent.ARN

注意

當您在 轉移至客服人員 流程中使用客服人員聯絡屬性時,客服人員屬性會反映目標客服人員,而不是啟動轉接的客服人員。

客服人員屬性僅適用於下列流程類型:

  • 客服人員低語

  • 客戶低語

  • 客服人員保留

  • 客戶保留

  • 外撥低語

  • 轉接給客服人員。在這種情況下,客服人員屬性會反映目標客服人員,而不是啟動轉接的客服人員。

客服人員屬性不適用於下列流程類型:

  • 客戶佇列

  • 轉接至佇列

  • 入站流程

佇列屬性

這些是您在流程中使用 取得佇列指標 區塊時傳回的系統屬性。

若您的聯絡中心目前沒有活動,這些屬性會傳回空值。

屬性 描述 Type JSONPath 參考

佇列名稱

指標擷取來源佇列的名稱。

系統

$.Metrics.Queue.Name

佇列 ARN

指標擷取來源佇列的 ARN。

系統

$.Metrics.Queue.ARN

佇列中的聯絡人

佇列中目前等待的聯絡案例數。

系統

$.Metrics.Queue.Size

佇列中最舊的聯絡人

在佇列中等待最久的聯絡案例的等待時間,以秒計。

系統

$.Metrics.Queue.OldestContactAge

線上客服人員

目前在線上的客服人員數量,也就是已登入且處於離線以外的狀態的客服人員。

系統

$.Metrics.Agents.Online.Count

可提供服務的客服人員

狀態設為可提供服務的客服人員人數。

系統

$.Metrics.Agents.Available.Count

駐守客服人員

目前駐守的客服人員人數,也就是已登入且處於可提供服務、ACW 或忙碌狀態的客服人員。

系統

$.Metrics.Agents.Staffed.Count

處於聯絡後工作狀態的客服人員

目前處於 ACW 狀態的客服人員人數。

系統

$.Metrics.Agents.AfterContactWork.Count

忙碌中的客服人員

目前正在處理聯絡案例的客服人員人數。

系統

$.Metrics.Agents.Busy.Count

漏接客服人員數

處於漏接狀態的客服人員數,客服人員漏接聯絡人後即會進入此狀態。

系統

$.Metrics.Agents.Missed.Count

非生產狀態的客服人員

處於非生產 (NPT) 狀態的客服人員人數。

系統

$.Metrics.Agents.NonProductive.Count

電話語音中繼資料屬性 (通話屬性)

電話語音中繼資料提供與電話運營商的呼叫發起相關的其他資訊。

屬性

描述

Type

JSONPath 參考

P-Charge-Info

負責支付相關通話費用的一方。

系統

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

與請求相關聯的最終使用者身分。

系統

$.Media.Sip.Headers.From

受話方或請求接收方的相關資訊。

系統

$.Media.Sip.Headers.To

ISUP-OLI

原始線路指示器 (OLI)。顯示線路撥號的類型 (例如 PSTN、800 服務呼叫、無線/行動電話、公用電話)。

系統

$.Media.Sip.Headers.ISUP-OLI

JIP

司法管轄權指示參數 (JIP)。指示來電者/交換機的地理位置。

範例值:212555

系統

$.Media.Sip.Headers.JIP

Hop-Counter

跳躍計數器。

範例值:0

系統

$.Media.Sip.Headers.Hop-Counter

Originating-Switch

原始交換器。

範例值:710

系統

$.Media.Sip.Headers.Originating-Switch

Originating-Trunk

原始主幹。

範例值: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

SIPREC 中繼資料

Amazon Contact Lens 連接器接收到的 SIPREC 中繼資料 XML

系統

$.Media.Sip.SiprecMetadata

注意

電話語音中繼資料的可用性在所有電話語音供應商之間並不一致,而且可能無法在所有情況下提供。在某些情況下,這可能會導致空值。

聊天初始訊息屬性

屬性

描述

Type

JSONPath 參考

InitialMessage

客戶在網路聊天或 SMS 上提供的初始訊息。

系統

$.Media.InitialMessage

電子郵件屬性

下表列出 Amazon Connect 中可用的電子郵件屬性。

屬性

描述

Type

JSONPath 參考

電子郵件訊息 (純文字)

使用取得預存內容流程區塊時,這會存放來自電子郵件聯絡人的電子郵件訊息的純文字版本。

系統

$.Email.EmailMessage.Plaintext

媒體串流屬性

下表列出的屬性可用來在即時媒體串流中,識別客戶音訊啟動和停止的位置。

屬性

描述

Type

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 機器人傳回的屬性。這些屬性也稱為工作階段屬性

屬性 描述 Type JSONPath 參考

替代網域

Amazon Lex 提供的替代意圖清單。每個意圖都有相應的可信度分數和要填補的插槽。

Lex

$.Lex.AlternativeIntents.x.IntentName

$.Lex.AlternativeIntents.x.IntentConfidence.Score

$.Lex.AlternativeIntents.x.Slots

$.Lex.AlternativeIntents.y.IntentName

$.Lex.AlternativeIntents.y.IntentConfidence.Score

$.Lex.AlternativeIntents.y.Slots

$.Lex.AlternativeIntents.z.IntentName

$.Lex.AlternativeIntents.z.IntentConfidence.Score

$.Lex.AlternativeIntents.z.Slots

其中,xyz 是 Lex 回應中的意圖名稱

意圖可信度分數

Amazon Lex 傳回的意圖可信度分數。

Lex

$.Lex.IntentConfidence.Score

意圖名稱

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 機器人傳回的最後對話狀態。若有某個意圖傳回流程,該值即為「Fulfilled」。

N/A (UI 中未顯示任何類型)

$.Lex.dialogState

Case 聯絡屬性

下表列出與 Amazon Connect Cases 搭配使用的屬性。

屬性 描述 Type JSONPath 參考 資料來自何處

案例 ID

以 UUID 格式表示的案例的唯一識別碼 (例如:689b0bea-aa29-4340-896d-4ca3ce9b6226) text

$.Case.case_id

Amazon Connect

案例原因

開啟案例的原因

單選

$.Case.case_reason 客服人員

客戶

API 是客戶設定檔 ID。案例:欄位 頁面上會顯示客戶的名稱。

text

$.Case.customer_id Amazon Connect

關閉日期/時間

上次關閉案例的日期和時間。它不能保證案例已結束。如果重新開啟案例,此欄位會包含上次將狀態變更為「已關閉」的日期/時間戳記。

date-time

$.Case.last_closed_datetime Amazon Connect

開啟日期/時間

案例開啟的日期和時間。

date-time

$.Case.created_datetime Amazon Connect

更新日期/時間

案例的更新日期和時間。

date-time

$.Case.last_updated_datetime Amazon Connect

參考編號

以 8 位數數字格式表示的案例易記號碼。

參考編號 (與案例 ID 不同) 不保證是唯一的。我們建議您識別客戶,然後收集參考編號以正確找到正確的案例。

text

$.Case.reference_number 客服人員

狀態

案例的目前狀態

text

$.Case.status 客服人員

總結

案例摘要

text

$.Case.summary 客服人員

Title

案例標題

text

$.Case.title 客服人員

使用 Lambda 聯絡屬性

Lambda 屬性會從最近的 AWS Lambda 函數 區塊調用以鍵值對的形式傳回。Lambda 調用屬性會在每次調用 Lambda​ 函數時覆寫。

若要參考 JSONPath 中的屬性,請使用:

  • $.LambdaInvocation.ResultData.attributeName

其中 AttributeName 是屬性名稱,或從函數傳回的鍵值對中的鍵。

舉例而言,如果函式傳回了聯絡案例 ID,請以 $.LambdaInvocation.ResultData.ContactId 來參考屬性。當參考從 Amazon Connect 傳回的聯絡案例 ID 時,JSONPath 是 $.ContactId

如需在 Lambda 函數中使用屬性的詳細資訊,請參閱 授予 Amazon Connect 存取您的 AWS Lambda 函式

這些屬性不包含於聯絡記錄,不會傳送到下一次 Lambda 調用,而且不會傳送至 CCP 當做快顯資訊。不過,它們可以傳入作為 AWS Lambda 函數 區塊上的 Lambda 函數輸入,或使用 設定聯絡屬性​ 區塊複製到使用者定義的屬性。在 設定聯絡屬性 區塊中​使用時,複製的屬性會包含於聯絡人記錄中,而且可以使用於 CCP。

使用者定義屬性

對於所有其他屬性,Amazon Connect 定義了鍵和值。但是,對於使用者定義的屬性,您可以為鍵和值提供名稱。

如果您想要將值儲存在流程中,請使用使用者定義的屬性,然後稍後參考這些值。例如,如果您整合了 Amazon Connect 和 CRM 或其他系統,可能會希望從客戶那裡獲得輸入,例如他們的會員編號。然後,您可以使用該會員編號從 CRM 中檢索有關會員的資訊,及/或在整個流程中使用會員編號等。

屬性

描述

Type

JSONPath 參考

您選擇的任何名稱

使用者定義屬性有兩個部分:

  • 目的地索引鍵:這是您為索引鍵選擇的任何名稱。然而,$. (句號) 字元不允許使用,因為它們都用於定義 JSONPath 中的屬性路徑。

  • 值:這可以是您選擇的任何值。如果需要,您可以輸入長達幾個段落的文字!(如需聯絡人記錄屬性區段的大小上限,請參閱 Amazon Connect 功能規格。)

使用者定義

$.Attributes.name_of_your_destination_key

若要建立使用者定義屬性,請使用 設定聯絡屬性 區塊。

流程屬性

流程屬性與類型使用者定義屬性類似,但是,它們僅限於設定它們的流程。

如果您不想在整個聯絡人中保留資料,例如當您需要使用客戶的信用卡號碼等敏感資訊來執行 Lambda 資料轉換時,流程屬性非常有用。

  • 流程屬性是儲存在本機的暫存變數,且僅用於流程。它們在流程外的任何地方都看不到,即使將聯絡人轉接到其他流程也不會顯示。

  • 最多可達 32 KB (聯絡人記錄屬性區段的大小上限)。

  • 除非明確設定為參數,否則它們不會傳遞至 Lambda:在 調用 AWS Lambda 函數 區塊中,選擇 新增參數

  • 它們不會傳遞給模組。您可以在模組內設定流程屬性,但該屬性不會傳遞到模組外。

  • 它們不會出現在聯絡人記錄中。

  • 它們不會向 CCP 中的客服人員顯示。

  • GetContactAttributes API 無法公開它們。

  • 如果您已在流程上啟用記錄功能,則鍵和值會顯示在 Cloudwatch 日誌中。

屬性

描述

Type

JSONPath 參考

您選擇的任何名稱

流程屬性有兩個部分:

  • 目的地索引鍵:這是您為索引鍵選擇的任何名稱。然而,$. (句號) 字元不允許使用,因為它們都用於定義 JSONPath 中的屬性路徑。

  • 值:這可以是您選擇的任何值。

流程

$.FlowAttributes.name_of_your_destination_key

流程模組屬性

流程模組輸入屬性是傳遞至模組中的屬性,該模組已使用調用模組區塊定義流程或其他模組的輸入結構描述。流程模組 從調用模組區塊的最新調用中傳回輸出和結果屬性。模組輸出和結果屬性會在每次叫用模組函數時覆寫。

這些屬性不包含在聯絡記錄中,不會傳遞給下一個模組調用,也不會傳遞給 CCP 以取得螢幕快顯資訊。不過,您可以使用設定聯絡屬性區塊將其複製到使用者定義的屬性。在設定聯絡屬性區塊中使用時,複製的屬性會包含在聯絡記錄中,並可用於 CCP。

下表列出 Amazon Connect 中可用的流程模組屬性。

屬性 描述 Type JSONPath 參考

Input

輸入資料可讓您存取傳遞至模組的輸入。這會傳回為 JSON 物件,而特定格式由模組輸入結構描述定義。

模組

$.Modules.Input

結果

結果資料會擷取從模組傳回的分支名稱,但錯誤分支除外。這會以字串傳回。

模組

$.Modules.Result

Output (來自 UI 的屬性參考)

輸出資料會擷取從模組執行產生的結果資料。這會傳回為 JSON 物件,而特定格式是由模組輸出結構描述所定義。

模組

$.Modules.ResultData

資料表屬性

Data Table 區塊操作傳回的屬性。使用這些來存取從聯絡流程中資料表擷取的資料。

評估資料表值屬性

使用資料表區塊中的評估動作來查詢特定屬性值時傳回的屬性。

  • 如果查詢未傳回結果或找不到屬性,則參考將為空或 null。

屬性 描述 Type JSONPath 參考

資料表評估的查詢結果

由具名查詢擷取的特定屬性值。<QueryName> 將 取代為指派給查詢的唯一名稱,並將 <AttributeName>取代為您選取要擷取的屬性名稱。

資料表

$.DataTables.<QueryName>。<AttributeName>

列出資料表值屬性

使用資料表區塊中的列出動作擷取完整記錄時傳回的屬性。

  • 清單會傳回完整記錄 (所有屬性),而不只是選取的記錄。

  • 如果找不到相符的記錄,則 primaryKeyGroups 陣列將為空白。

  • 未設定主索引鍵群組時,會載入整個資料表,並以「預設」群組名稱存取結果:$.DataTableList.Result.primaryKeyGroups.default[index]

  • 清單命名空間的最大資料限制為 32 KB。

屬性 描述 Type JSONPath 參考

資料表 ID

從中擷取記錄之資料表的唯一識別符。

資料表清單

$.DataTableList.Result.dataTableId

鎖定版本

資料表的鎖定版本資訊。

資料表清單

$.DataTableList.Result.lockVersion.dataTable

預設群組名稱

未設定主索引鍵群組時,會載入整個資料表,並以「預設」群組名稱存取結果。

資料表清單

$.DataTableList.Result.primaryKeyGroups.default[index]

主索引鍵群組

依主要值群組名稱整理的擷取記錄集合。<GroupName> 將 取代為指派給主要值群組的名稱。

資料表清單

$.DataTableList.Result.primaryKeyGroups.<GroupName>

特定資料列

存取主索引鍵群組中的特定資料列。<GroupName> 將 取代為您的群組名稱,並將 [index]取代為資料列的以零為基礎的索引。

資料表清單

$.DataTableList.Result.primaryKeyGroups.<GroupName>【索引】

主索引鍵值

存取特定資料列中主索引鍵屬性的值。

資料表清單

$.DataTableList.Result.primaryKeyGroups.<GroupName>【index】.primaryKeys【index】.attributeValue

屬性值

存取特定資料列中非主要屬性的值。

資料表清單

$.DataTableList.Result.primaryKeyGroups.<GroupName>【index】.attributes【index】.attributeValue

Apple Messages for Business 屬性

使用下列聯絡屬性來路由 Apple Messages for Business 客戶。例如,如果您有不同的業務使用 Apple Messages for Business,您可以根據 AppleBusinessChatGroup 聯絡屬性分支至不同的流程。或者,如果您想要與其他聊天訊息不同的方式路由 Apple Messags for Business 訊息,您可以根據訊息平台進行分支。

屬性 描述 Type 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

AppleFormCapability

客戶裝置是否支援表單。

若為 true,表示支援客戶裝置。

若為 false,表示不支援其裝置。

使用者定義 $.Attributes.AppleFormCapability

AppleAuthenticationCapability

客戶裝置是否支援身分驗證 (OAuth2)。若為 true,表示支援客戶裝置。若為 false,表示不支援其裝置。

使用者定義 $.Attributes.AppleAuthenticationCapability

AppleTimePickerCapability

客戶裝置是否支援時間選擇器。

若為 true,表示支援客戶裝置。

若為 false,表示不支援其裝置。

使用者定義 $.Attributes.AppleTimePickerCapability

AppleListPickerCapability

客戶裝置是否支援清單選擇器。

若為 true,表示支援客戶裝置。

若為 false,表示不支援其裝置。

使用者定義 $.Attributes.AppleListPickerCapability

AppleQuickReplyCapability

客戶裝置是否支援快速回覆。

若為 true,表示支援客戶裝置。

若為 false,表示不支援其裝置。

使用者定義 $.Attributes.AppleQuickReplyCapability

客戶設定檔屬性

下表列出與 Amazon Connect 「客戶設定檔」搭配使用的屬性。

整個流程的「客戶設定檔」聯絡屬性總大小限制為 14,000 個 (56 個屬性,假設每個屬性的大小上限為 255)。這包括在流程中保留為「客戶設定檔」區塊中回應欄位的所有值。

屬性 描述 Type JSONPath 參考

profileSearchKey

您要用來搜尋設定檔的屬性名稱。

使用者定義

不適用

profileSearchValue

您要搜尋的索引鍵的值,例如客戶名稱或帳號。

使用者定義

不適用

設定檔 ID

客戶設定檔的唯一識別符。

text

$.Customer.ProfileId

設定檔 ARN

客戶設定檔的 ARN。

text

$.Customer.ProfileARN

名字

客戶的名字。

text

$.Customer.FirstName

中間名

客戶的中間名。

text

$.Customer.MiddleName

姓氏

客戶的姓氏。

text

$.Customer.LastName

帳戶號碼

您提供給客戶的唯一帳號。

text

客戶. 帳號$.Customer.AccountNumber

電子郵件地址

尚未指定為個人或公司地址的客戶電子郵件地址。

text

$.Customer.EmailAddress

電話號碼

尚未指定為行動電話號碼、住家或公司號碼的客戶電話號碼。

text

$.Customer.PhoneNumber

其他資訊

與客戶設定檔相關的任何其他資訊。

text

$.Customer.AdditionalInformation

對象類型

客戶的對象型態。

text

$.Customer.PartyType

公司名稱

客戶的業務名稱。

text

$.Customer.BusinessName

出生日期

客戶的出生日期。

text

$.Customer.BirthDate

Gender

客戶性別。

text

$.Customer.Gender

手機電話號碼

客戶的行動電話號碼。

text

$.Customer.MobilePhoneNumber

住家電話號碼

客戶的住家電話號碼。

text

$.Customer.HomePhoneNumber

商業電話號碼

客戶的公司電話號碼。

text

$.Customer.BusinessPhoneNumber

電子郵件地址

客戶的公司電子郵件地址。

text

$.Customer.BusinessEmailAddress

地址

與客戶相關聯,且非用於郵寄、送貨或帳單的一般地址。

text

$.Customer.Address1

$.Customer.Address2

$.Customer.Address3

$.Customer.Address4

$.Customer.City

$.Customer.County

$.Customer.Country

$.Customer.PostalCode

$.Customer.Province

$.Customer.State

發貨地址

客戶的運送地址。

text

$.Customer.ShippingAddress1

$.Customer.ShippingAddress2

$.Customer.ShippingAddress3

$.Customer.ShippingAddress4

$.Customer.ShippingCity

$.Customer.ShippingCounty

$.Customer.ShippingCountry

$.Customer.ShippingPostalCode

$.Customer.ShippingProvince

$.Customer.ShippingState

郵寄地址

客戶的電子郵件地址。

text

$.Customer.MailingAddress1

$.Customer.MailingAddress2

$.Customer.MailingAddress3

$.Customer.MailingAddress4

$.Customer.MailingCity

$.Customer.MailingCounty

$.Customer.MailingCountry

$.Customer.MailingPostalCode

$.Customer.MailingProvince

$.Customer.MailingState

帳單地址

客戶的帳單地址。

text

$.Customer.BillingAddress1

$.Customer.BillingAddress2

$.Customer.BillingAddress3

$.Customer.BillingAddress4

$.Customer.BillingCity

$.Customer.BillingCounty

$.Customer.BillingCountry

$.Customer.BillingPostalCode

$.Customer.BillingProvince

$.Customer.BillingState

屬性

客戶設定檔屬性的鍵值對。

text

$.Customer.Attributes.x

物件屬性

客戶設定檔自訂物件屬性的鍵值對。

text

$.Customer.ObjectAttributes.y

已計算屬性

已計算客戶設定檔屬性的鍵值對。

text

$.Customer.CalculatedAttributes.z

資產

客戶的標準資產。

text

$.Customer.Asset.AssetId

$.Customer.Asset.ProfileId

$.Customer.Asset.AssetName

$.Customer.Asset.SerialNumber

$.Customer.Asset.ModelNumber

$.Customer.Asset.ModelName

$.Customer.Asset.ProductSKU

$.Customer.Asset.PurchaseDate

$.Customer.Asset.UsageEndDate

$.Customer.Asset.Status

$.Customer.Asset.Price

$.Customer.Asset.Quantity

$.Customer.Asset.Description

$.Customer.Asset.AdditionalInformation

$.Customer.Asset.DataSource

$.Customer.Asset.Attributes.x

順序

客戶的標準訂單。

text

$.Customer.Order.OrderId

$.Customer.Order.ProfileId

$.Customer.Order.CustomerEmail

$.Customer.Order.CustomerPhone

$.Customer.Order.CreatedDate

$.Customer.Order.UpdatedDate

$.Customer.Order.ProcessedDate

$.Customer.Order.ClosedDate

$.Customer.Order.CancelledDate

$.Customer.Order.CancelReason

$.Customer.Order.Name

$.Customer.Order.AdditionalInformation

$.Customer.Order.Gateway

$.Customer.Order.Status

$.Customer.Order.StatusCode

$.Customer.Order.StatusUrl

$.Customer.Order.CreditCardNumber

$.Customer.Order.CreditCardCompany

$.Customer.Order.FulfillmentStatus

$.Customer.Order.TotalPrice

$.Customer.Order.TotalTax

$.Customer.Order.TotalDiscounts

$.Customer.Order.TotalItemsPrice

$.Customer.Order.TotalShippingPrice

$.Customer.Order.TotalTipReceived

$.Customer.Order.Currency

$.Customer.Order.TotalWeight

$.Customer.Order.BillingName

$.Customer.Order.BillingAddress1

$.Customer.Order.BillingAddress2

$.Customer.Order.BillingAddress3

$.Customer.Order.BillingAddress4

$.Customer.Order.BillingCity

$.Customer.Order.BillingCounty

$.Customer.Order.BillingCountry

$.Customer.Order.BillingPostalCode

$.Customer.Order.BillingProvince

$.Customer.Order.BillingState

$.Customer.Order.ShippingName

$.Customer.Order.ShippingAddress1

$.Customer.Order.ShippingAddress2

$.Customer.Order.ShippingAddress3

$.Customer.Order.ShippingAddress4

$.Customer.Order.ShippingCity

$.Customer.Order.ShippingCounty

$.Customer.Order.ShippingCountry

$.Customer.Order.ShippingPostalCode

$.Customer.Order.ShippingProvince

$.Customer.Order.ShippingState

$.Customer.Order.Attributes.y

案例

客戶的標準案例。

text

$.Customer.Case.CaseId

$.Customer.Case.ProfileId

$.Customer.Case.Title

$.Customer.Case.Summary

$.Customer.Case.Status

$.Customer.Case.Reason

$.Customer.Case.CreatedBy

$.Customer.Case.CreatedDate

客戶. 案例更$.Customer.Case.UpdatedDate新日期

$.Customer.Case.ClosedDate

$.Customer.Case.AdditionalInformation

$.Customer.Case.DataSource

$.Customer.Case.Attributes.z

對外行銷活動屬性

您可以使用區段清單中的資料 Amazon Pinpoint 來自訂 Amazon Connect 流程中的體驗。若要參考區段清單中的資料,請使用 $.Attributes.attribute coming in the segment。例如,如果您的某個區段有兩欄 "Attributes.FirstName" 和 "Attributes.ItemDescription",您會將其指稱為:

  • $.Attributes.FirstName

  • $.Attributes.ItemDescription

如需詳細資訊,請參閱《Amazon Pinpoint 使用者指南》中的將個人化內容新增至訊息範本

Amazon Q in Connect 屬性

下列屬性會存放 Amazon Q in Connect 工作階段 ARN。此屬性的使用案例之一,是您想要執行任何 API 動作時,例如 UpdateSession UpdateSessionData。您可以將此屬性傳入作為 AWS Lambda 函數 區塊的輸入。此外,Lambda 可根據輸入工作階段 ARN 呼叫這些 API。

屬性 描述 Type JSONPath 參考

SessionArn

Amazon Q in Connect 工作階段的 Amazon Resource Name (ARN)。

流程

$.Wisdom.SessionArn