CustomEvent

This help page is for Desktop Studio. This information is also available for CXone Studio.

建立用於傳輸獨特資料的自訂事件。自訂事件允許使用者傳遞字串給特定客服專員。這些事件可以因回應與客服專員相關的動作而產生，例如OnAnswer。只要在此動作的屬性中填入TargetAgent，這些事件也可以在指派客服專員之前產生。產生的自訂事件進入客服專員事件串流。若要接收自訂事件，請加入客服專員會話來偵聽事件，例如使用 get-next-event 模式。如果現有的事件不太適合您的用例，自訂事件就很有用。

支援的指令碼類型


通用	電郵	聊天	電話	語音郵件	工作項目	SMS

輸入屬性

這些屬性定義了動作執行時使用的資料。

屬性	描述
Caption	輸入在指令碼中唯一標識此操作的短語。標題出現在指令碼畫布上的動作圖示下。 The default is the action name.
TargetAgent	自訂事件所針對的客服專員的 ID。 Studio指令碼會在呼入通話的OnAnswer事件之後填入AgentId變數。自訂事件僅在AgentId被填入時執行。如果您想要在客服專員指派之前傳送自訂事件，您必須為TargetAgent欄位提供客服專員 ID。
EventName	為自訂事件輸入名稱。具有相同名稱的多個事件將相互覆寫。僅最新事件名稱將會保留。此欄位區分大小寫。
PersistInMemory	如果事件是在客服專員登出時執行，而您希望他們再次登入時收到事件，請將此值設定為 true。否則設定為 false。
Data	此事件的資料裝載。

結果分支條件

結果分支條件允許您在指令碼中建立分支，以處理執行動作時的不同結果。

條件	描述
Default	指令碼未能滿足需要它採用其中一個分支的條件時採用的路徑。如果沒有定義動作的其他分支，也會採用該路徑。
OnAgentNotConnected	未連接到目標客服專員時採用的路徑。

指令碼範例

在此指令碼範例中，分支示範了產生自訂事件的三種情況：

分支 1：在任何客服專員互動之前啟動並接收自訂事件。當聯絡人按下 1時，自訂事件會被get-custom-event循環接收。

檢視範例工作負載

{
	"sessionId": "aUF6WkZJeW1nNno4NUp1eEhwZkxGdVgzaUJIRjIyMWlkaUQ2NkN0ejN0VkFyODQ4UFBZV3BiOVhRUT09",
	"events": [
		{
			"IISHost": "AOA-B32COR01",
			"VCHost": "AOA-B32COR01",
			"type": "CustomEvent",
			"eventName": "This can be anything",
			"data": "Menu Press 1"
		}
	]
}

分支 2：在任何客服專員互動之前啟動並接收自訂事件。當聯絡人按下 2時，自訂事件會被get-custom-event循環接收。同時，在Reqagent發生之後，在客服專員接聽電話之前，會產生另一個自訂事件。

檢視範例工作負載

任何客服專員互動之前的工作負載：

{
	"sessionId": "NGVFOEd4UmJIdnlGWCtLblFEanRRSldtU2hDcXgxc1JhSUVHZ0NKNXdBSVRxa0F3MjhiOCtQM2E=",
	"events": [
		{
			"IISHost": "AOA-B32COR01",
			"VCHost": "AOA-B32COR01",
			"type": "CustomEvent",
			"eventName": "This can be anything",
			"data": "Menu Press 2"
		{
	]
}

Reqagent發生之後和客服專員接聽電話之前的工作負載：

{
	"sessionId": "NGVFOEd4UmJIdnlGWCtLblFEanRRSldtU2hDcXgxc1JhSUVHZ0NKNXdBSW4xeThiR0M2R1FBYlBhZz09",
	"events": [
		{
			"IISHost": "AOA-B32COR01",
			"VCHost": "AOA-B32COR01",
			"type": "CustomEvent",
			"eventName": "This can be anything",
			"data": "Menu Press 2 and post reqAgent"
		{
	]
}

分支 2 和 3：在客服專員接聽電話後啟動並接收自訂事件。

檢視範例工作負載

{
	"sessionId": "aktmZEY1aFpDWlVwM0FzenhzTHZ2TnhJanpsZjR5SXhsekYwaUN2TjFYbUcwOW82cjRsZVdIc1FKdz09",
	"events": [
		{
			"IISHost": "AOA-B32COR01",
			"VCHost": "AOA-B32COR01",
			"Type": "CallContactEvent",
			"ContactID": "510965166955",
			"MasterID": "510965166955",
			"Status": "Active",
			"OriginalState": "False",
			"CallType": "Regular",
			"DNIS": "",
			"ANI": "",
			"Skill": "23097992",
			"IsInbound": "True",
			"StartTimeUTC": "2024-07-12T15:46:38.000Z",
			"StartTime": "2024-07-12T15:46:38.000Z",
			"LastStateChangeTimeUTC": "2024-07-12T15:47:11.000Z",
			"LastStateChangeTime": "2024-07-12T15:47:11.000Z",
			"ScreenPopUrl": "",
			"DisconnectCode": "NA",
			"IsLogging": "False",
			"Timeout": "",
			"AllowDispositions": "True",
			"Label": "",
			"IsLinked": "False",
			"TimeZones": "",
			"FinalState": "False",
			"OtherInformation": "",
			"OtherInformationNewFormat": "",
			"BlendingToSkillName": "",
			"DeliveryType": "None",
			"CustomData": "",
			"ComplianceRecord": "False",
			"ConfirmationRequired": "False",
			"ParentContactId": "0",
			"OmniGroupId": "0",
			"ExternalId": "",
			"AnsMachineOverride": "False",
			"AnsMachineOverrideEndTime": "",
			"CustomerCardUrl": "",
			"InteractionId": "6a006eee-03d3-49fd-8aa9-614482684721",
			"IsRequireManualAccept": "False",
			"PhoneCallRefusalTimeOut": "45",
			"FaxMachineOveride": "False"
	},
		{
			"IISHost": "AOA-B32COR01",
			"VCHost": "AOA-B32COR01",
			"type": "CustomEvent",
			"eventName": "This can be anything",
			"data": "This is a sample message after onAnswer"
		},
		{
			"IISHost": "AOA-B32COR01",
			"VCHost": "AOA-B32COR01",
			"Type": "Mute",
			"AgentMuted": "True"
		}
	]
}

透過 API 建立自訂事件

您也可以使用custom-eventAPI建立自訂事件。如果CustomEvent動作不符合您的用例的要求，這可能是必要的。由於服務通常已經消耗客服專員事件串流，因此這是一種分享資料的方便方法，不需要實作您自己的自訂端點。這對於小範圍的應用程式或微服務尤其重要。

如果您不使用參數而使用屬性，使用 API 的效果類似於Studio動作。使用CXoneAPI 也需要您實作 API 認證。使用 API 時，請務必：

命名事件。
在Studio動作的agentId參數或目標客服專員屬性中指定目標客服專員。您可以使用AgentId變數中的 ID。這是在OnAnswer事件之後自動填入的。如果您要在指派客服專員之前傳送自訂事件，您仍必須提供客服專員 ID。
設定persistInMemory欄位。如果客服專員已登出，這會決定客服專員在重新登入後是否會收到事件。
填寫Data欄位，此欄位為字串形式的工作負載。
使用 get-next-event API 或Get Next Event Studio動作消耗自訂事件。

以下是透過 API 建立自訂事件的範例：

範例 curl：

curl -X PUT "https://api-$AREA.$DOMAIN/incontactapi/services/v30.0/agents/$AGENT_ID/custom-event?eventName=From_Postman&persistInMemory=false&data=Sent_from_Postman"

請求類型：PUT

欄位：

參數	類型	詳細資訊
agentId	字串	用於識別目標客服專員的客服專員 ID 值。
eventName	字串	事件名稱。此項必須由事件的任何消費者使用。
persistInMemory	布爾	如果agentId所識別的客服專員目前尚未登入，則事件會被忽略，或在該客服專員重新登入後該事件繼續。
data	字串	任何資料字串。