一般聊天機器人配置
一般聊天機器人設定
- 導航到管理>頻道>目的地，點擊聊天機器人分頁。
- 在聊天機器人分頁中，點擊右上角的加入聊天機器人按鈕。
- 點擊下拉式清單，選擇一般聊天機器人為聊天機器人來源。
- 填上URL、URL參數以及HTTP標頭。
下表為URL、URL參數以及HTTP標頭的例子。
| 欄目 | 例子 | 描述 |
|---|---|---|
| 方法 | POST | 此欄目必須使用POST。這個HTTP方法表示，CINNOX會向你的伺服器發送數據，以建立或更新資源。 |
| URL | https://jsonplaceholder.typicode.com/todos/1 | 傳送諮詢數據到該目的地的是CINNOX。此欄目必須填寫。 |
| URL 參數 | "enquiryType":chat | URL需要的參數。可選擇填寫此欄目。 |
| HTTP 標頭 | "Content-Type": application/json | 此欄目為當CINNOX藉HTTP方法，發送數據時的額外資料。可選擇填寫此欄目。 |
從CINNOX發送的Request
完成了必填填寫的欄位後，當目的地的聊天機器人需要處理諮詢時，CINNOX會以以下格式發送Request。
CINNOX發送Request的例子
{
"query": "string",
"queryParams":{
payload: []byte, //請unmarshal此payload
}
}
- 當收到Request Payload後，需要Unmarchal此payload。以下例子是Unmarchale此payload後的內容。
{
// tag
tagType: "string",
tagId: "string",
tagName: "string",
// channel
channelType: "string",
channelId: "string",
channelName: "string",
channelSourceName: "string",
channelPhoneNumber: "string",
// visitor
visitorName: "string",
visitorPhone: "string",
// others
omniType: "string",
}
發送到CINNOX的Response
第三方聊天機器人的回覆必須傳送給CINNOX，以便相應地回覆該諮詢。CINNOX中，一般聊天機器人可使用兩種回應類型：文字訊息和進階訊息。
注意事項
一般聊天機器人必須使用JSON格式，發送回應中的Key和Value給CINNOX。
文字訊息
文字訊息是一條你可以的自訂文字訊息。你可以使用下面的Key和Value，來自訂文字訊息。根據回應中的Key和Value，CINNOX會使用你的文字訊息，回覆諮詢。
| Key | Type | Value |
|---|---|---|
| message.type | Number | 如果它是文字訊息(Text Message)，其value為1；如果它是進階訊息(Advanced Message)，其value為5。 |
| message.text | String | 有三個可供使用的Value。 Value = 文字 (CINNOX會在諮詢聊天室，顯示該文字來回覆諮詢)。例如：Value = 「請聯絡我們的客戶支援中心」。這段文字「請聯絡我們的客戶支援中心」會顯示在諮詢聊天室內，作為回覆。 Value = DIRECT_TRANSFER 啟用了「將聊天機器人轉移到線上客服」的功能後，此Value會觸發轉移，將諮詢從聊天機器人，轉移到真人客服來處理。關於從聊天機器人轉移諮詢到真人客服的詳細資料，請參考本指南的轉移諮詢 - 從聊天機器人到線上客服的部份。 Value = CLOSE_ENQUIRY 此Value會觸發自動關閉諮詢的操作。 |
| message.advanced | String | 如果它是進階訊息，其value為5。 |
使用文字訊息的Response例子
{
"message": {
"type": number,
"text": "string",
"advanced":"string",
}
}
進階訊息
進階訊息是一種你可以使用下面列出的Key和Value，來自訂風格的訊息。它具有不同的格式、操作和內容，例如：Text、Button和Media File。根據你Response的Key和Value，CINNOX會相應地使用你自訂的訊息回覆諮詢。
訊息格式
進階訊息包括的格式：Bubble、Carousel、Quick Reply、List以及Text。它們對應的Key和Value在下表列出：
| Key (必須提供) | Type | Value (必須提供) |
|---|---|---|
| advanced.type | Number | 當Value = 1，訊息格式為Bubble。 |
| advanced.type | Number | 當Value = 2，訊息格式為Carousel。 |
| advanced.type | Number | 當Value = 3，訊息格式為Quick Reply。 |
| advanced.type | Number | 當Value = 4，訊息格式為List。 |
| advanced.type | Number | 當Value = 9，訊息格式為Text。 |
格式例子
下表列出不同格式的訊息。
訊息內容必須按Text、Media以及Buttons順序顯示。
訊息組成部份
Text
進階訊息的文字格式，包括Title、Text以及Footer。
| Key | Type | Value |
|---|---|---|
| advanced.type (用作自訂Title、Text以及Footer) | Number | 該Value可以是： - 1，當顯示的文字訊息，其格式為Bubble。 - 2，當顯示的文字訊息，其格式為Carousel。 |
| advanced.items.type (用作自訂Title、Text以及Footer) | Number | Value = 9 (必須填寫以自訂Title、Text以及Footer) |
| advanced.items.title | String | 訊息的Title。如果Value為"好結果學習中心"，訊息的Title便是"好結果學習中心"。 |
| advanced.items.text | String | 訊息的Body。如果Value為"你的考試專家"，訊息的Body便是"你的考試專家"。 |
| advanced.items.footer | String | 訊息的Footer。如果Value為"參加我們的考試班吧!"，訊息的Footer便是"參加我們的考試班吧!"。 |
Title、Text以及Footer的字數限制為10000個字元。
Button
進階訊息包含自訂功能和操作的按鈕。它們對應的Key和Value在下表列出：
| Key | Type | Value |
|---|---|---|
| advanced.type | Number | 該Value可以是： - 1，訊息格式為Bubble。 - 2，訊息格式為Carousel。 |
| advanced.items.type | Number | 當Value = 12，訊息包含按鈕。 |
| advanced.items.text | String | 按鈕的顯示名稱。如果Value是「網頁」，顯示名稱為「網頁」。顯示名稱最多為20個字元。 |
| advanced.items.action.type | String | - 當Value = 0，訪客點擊按鈕時，按鈕沒有任何操作。 - 當key = advanced.items.action.text，Value = 1。 - 當key = advanced.items.action.url，Value = 2。 |
| advanced.items.action.text | String | 該Value可以是： - 聊天室顯示的訊息。例如：如果Value = 「謝謝你的資訊」。當訪客點擊按鈕時， 訊息「謝謝你的資訊」，會顯示在聊天室內。 - DIRECT_TRANSFER。如果啟用了「將聊天機器人轉移到線上客服」功能，當訪客點擊按鈕時，諮詢會轉移到分配的員工或客服群組。 - CLOSE_ENQUIRY。此Value觸發自動關閉諮詢的操作。 關於從聊天機器人轉移諮詢到真人客服的詳細資料，請參考本指南的轉移諮詢 - 從聊天機器人到線上客服的部份。 |
| advanced.items.action.url | String | 如果advanced.items.action.type的Value為2(URL)，則Value為URL。當訪客點擊按鈕時，訊息會將訪客轉到此URL的網頁。 |
Media File
進階訊息包括各種媒體文件，如圖片、影片以及聲音檔案。它們對應的Key和Value在下表列出：
| Key | Type | Value |
|---|---|---|
| advanced.items.type | Number | 當Value = 10，訊息中的媒體檔案為圖片。支援1:1 或 1.5:1兩種比例的圖片。 |
| advanced.items.type | Number | 當Value = 11，訊息中的媒體檔案為影片。 |
| advanced.items.type | Number | 當Value = 13，訊息中的媒體檔案為聲音檔案。 |
| advanced.items.type | String | 該Value為訊息中媒體檔案的對應URL。 URL的格式必須為 "https://www.grlc/teaching.png"。 |
注意事項
支援的媒體檔案格式：
圖片
- JPEG、JPG、PNG 和 WebP
聲音
- M4A、W4A、MP3、WAV、MPEG 和 AAC
影片
- MP4 和 3GPP
媒體檔案大小最多必須為20MB。
進階訊息例子
以下例子展示了，發送到CINNOX的Response中，其Key和Value。
{
"advanced": [
{
"type": 3,
"items": [
{
"type": 9,
"title": "好結果學習中心",
"text": "你的考試專家",
"footer": "參加我們的考試班吧!"
},
{
"type": 10,
"fileUrl": "https://www.grlc/teaching.png"
}
]
},
{
"type": 3,
"items": [
{
"type": 12,
"text": "網頁",
"action": {
"type": 2,
"url": "https://www.grlc.com"
}
},
{
"type": 12,
"text": "電郵",
"action": {
"type": 1,
"text": "[email protected]"
}
},
{
"type": 12,
"text": "地址",
"action": {
"type": 1,
"text": "新界荃灣青山公路好結果大廈3座3樓3室"
}
}
]
}
]
}
下圖為根據上述Key和Value例子產生的訊息，用來回覆諮詢。
Updated 6 months ago