常見問題 @ Yesing 燁星科技有限公司

分類

標題

Cami
外部系統串接機器人API說明
提供外部系統取得機器人回應訊息。

步驟 1
前往管理中心 > 系統整合 > API 金鑰管理，建立或使用既有的 API Key，
建立完成後，會包含金鑰 (API Key) 及密鑰 (API Secret)，請妥善保存。

步驟 2
傳送參數至 API 位置，格式如下：

Method：HTTP POST
API URI：https://伺服器編號.cami.yesing.com/api/v2/bot/response

apiKey必要varchar(100)所使用的 API Key (url encode)setSession必要varchar(10 ~ 40)為這個請求循環 (一個對話) 指定一個唯一的識別IDplatform非必要varchar(6)訊息來源的所屬平台 (web、inApp)scope必要varchar(100)知識庫應用範圍，留空為預設，將使用通用設定之機器人知識庫account必要varchar(30)系統公司帳號message必要text提問內容

API 回傳參數如下：

JSON
errMsgvarchar(100)錯誤訊息。如成功此值為空值understandingint(1)機器人是否理解。(0：未能理解、1：已理解，並有回傳知識訊息)notSureint(1)機器人對於內容理解是否肯定。(0：肯定、1：不肯定)serialvarchar(100)知識編號categoryvarchar(20)回應知識所屬的知識分類名稱answertext應答內容quickMenuarray, varchar(20)快速選單項目timeint(13)回應時間 (milli timestamp)
Cami
Cami Agent APP 使用說明
1
Android：Cami Agent APP
iOS：Cami Agent APP

以下為 Google Play 商店流程說明

2
下載完成後，點擊開啟Cami Agent APP程式

3
請輸入您的帳號及密碼資訊進行登入(服務帳號必須開啟自動接聽功能才能登入APP)

4
點擊下方「選單」可切換線上狀態及查看環境資訊

5
點擊「對話」可與訪客進行線上對談

6
點擊「人員」可查看目前其他在線服務人員

注意事項
* 服務帳號必須開啟自動接聽功能才能登入 APP。
* 登入 APP 的線上時間不會計算到報表中，但接聽數會計算。
* 網頁版登入時，APP 中的對話功能將暫停使用，於網頁版登出時自動恢復。
Cami
會員系統串接機制(v2)
步驟 1
請先依照說明安裝 Cami 系統代碼

步驟 2
前往管理中心 > 系統整合 > API 金鑰管理，建立或使用既有的 API Key，
建立完成後，會包含金鑰 (API Key) 及密鑰 (API Secret)，請妥善保存。

步驟 3
於 Cami 系統代碼上方加入以下代碼，此時可利用各開發者工具查看 console 是否有紀錄錯誤訊息。

const camiBridge = {
  setting:{
    apiKey:’API Key’,
    timestamp:’以十位數的 timestamp 表示現在時間’,
    token:’利用 API Secret 將資訊經過 sha256 編碼後的字串 ({API Secret}{timestamp}{Member uniqueId})’
  },
  member:{
    uniqueId:’會員識別編號’
  }
};

步驟 4
前往管理中心 → 網站設置 → 通用設定或個別設定 → 設定頁面拉至最下方，選擇「API 設定」並完成以下欄位設定。

會員登入網址：當 API URL 回傳需要訪客登入時，系統會將其引導到此處所設定的網址進行登入。
整合 API URL：Cami 將依據所帶入的會員編號 (Member unique id)，傳送至此 API 位址，取回會員資料。

Cami 傳送資訊至 API URL 時，格式如下：

HTTP GET
apiKey
所使用的 API Key
(將經過 url encode 處理，驗證時請先 decode)
requestId本次進程的識別 ID
(uuid 格式，例：9ee14520-6d0c-e5cf-a61e-e1da153dd4ad)timestamp
以十位數的 timestamp 表示現在時間token供驗證來源正確性，利用 API Secret 將資訊經過 sha256 編碼後的字串
({API Secret}{timestamp}{requestId}{Member uniqueId})memberUniqueId
會員識別編號
(必須有唯一性，無法確認會員登入狀態時，請留空)
請務必確實驗證 token 正確後才回傳相關資料，API URL 須回傳格式如下：

JSON
timestamp
required以十位數的 timestamp 表示現在時間，Cami 收到回傳資訊時，將驗證此時間戳記，其誤差必須在正負 120 秒內token
required供驗證來源正確性，利用 API Secret 將資訊經過 sha256 編碼後的字串
({API Secret}{timestamp}{requestId}{Member uniqueId})loginRequired required
是否要求訪客進行登入
1：必須登入
0：不須登入
member.displayNameoptional會員顯示名稱member.realNameoptional會員姓名member.sexoptional
會員性別
1：男
2：女
3：其他
member.phoneoptional會員電話member.mobileoptional會員手機號碼member.emailoptional會員 email 電子信箱member.birthdayoptional
會員生日 {yyyy/mm/dd}
member.addressoptional會員地址customizeData.0.keyoptional第一個自訂資料欄位名稱customizeData.0.valueoptional第一個自訂資料欄位值customizeData.1.key
optional第二個自訂資料欄位名稱
customizeData.1.valueoptional第二個自訂資料欄位值
customizeData.2.keyoptional第三個自訂資料欄位名稱
customizeData.2.valueoptional第三個自訂資料欄位值
回傳 JSON 範例如下：

{"token":"cd1ad25f9608661ca7c73f02f75829c4cb84a0dfd0872fe8ccb82f8e","timestamp":1609430400,"loginRequired":0,"member":{"displayName":"Display Name","realName":"Real Name","sex":"1","phone":"02-2697-1701","mobile":"0987654321","email":"member@mail.com","birthday":"2009\/09\/03","address":"新北市"},"customizeData":[{"key":"近期訂單編號","value":"abc001、abc002、abc003"},{"key":"會員等級","value":"LV5"}]}

步驟 5
當訪客進入裝有 Cami 代碼的頁面時，若有設定 API Key，系統將自動向所設定的 API 位址取得會員資訊
Cami
案件標籤設定流程
步驟 1
在管理中心的通用或個別設定最下方的額外設定項目內，點選案件分類標籤

步驟 2
預設標籤數量為20個，可進行新增、編輯與刪除，透過拖曳可變更排列順序，設定完成後，再次點擊可編輯標籤名稱

步驟 3
新增完成後，在通用或個別設定中可開啟或關閉案件分類功能
Cami
問卷新增流程
步驟 1
請至管理中心的問卷管理內點選新增問卷

步驟 2
點擊後便可設定問卷內容

步驟 3
新增完成後，透過通用或個別設定就可連結問卷
Cami
應答訊息BBCode使用說明
若需要在機器人應答訊息或一般訊息中，加入超連結、文字顏色、圖片等格式，
必須使用BBCode設定語法(紅字部份請視需求修改)

1. [url=https://www.yesing.com/]https連結名稱文字[/url]
若只是單純想顯示超連結不需自定連結文字，請直接輸入連結即可
2. [img]圖片網址[/img]
3. [b]粗體文字[/b]
4. [i]斜體文字[/i]
5. [u]底線文字[/u]
6. [color=HEX顏色編號]上色文字[/color]
7. [connect]點此連結服務人員[/connect]
8. [leave_message]點此前往留言[/leave_message]
9. [guest_say=點擊後系統自動為訪客送出這一句話]點此自動發話[/guest_say]
10. [youtube]Youtube影片編號[/youtube]

※ 離線留言不適用BBCode語法
Cami
系統嵌入APP設定
Cami線上智慧客服系統的本質為Web Base，可以透過WebView或iframe方式，
並利用Cami提供的Bridge及Trigger功能將系統嵌入於APP中使用

Cami Bridge使用說明
 Cami Trigger使用說明

步驟 1
建立一Web頁面，內容如下(紅字部份請依照各別帳號的專屬資訊修改)
<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" />
<title>Cami 線上客服系統</title>
<script>
var cami_bridge = {
customize: {
self_startup: 1, // 設定開啟客服時，在原頁面跳轉
complete_callback: function () { // 設定當 Cami 讀取完成時，欲執行的動作
document.getElementById(’cami_trigger’).click(); // Cami 讀取完成時，自動點擊客服按鈕
}
}
};

(function(y,e,s,i,n,g){i=y.createElement(e);i.async=1;i.src=s;
n=y.getElementsByTagName(e)[0];n.parentNode.insertBefore(i,n);
})(document,’script’,’//伺服器編號.cami.yesing.com/patrol/gather/department/公司帳號’);
</script>
</head>
<body>

<div id="cami_trigger" class="cami_trigger" data-cami-trigger-assign="a1b2c3e4">客服按鈕</div>
</body>
</html>

步驟 2
將前一步驟所完成的頁面以WebView或iframe方式嵌入APP中

步驟 3
範例參考請於Android Google Play搜尋「燁星科技」，安裝Yesing Technologies APP
Cami
機器人知識API串接說明
步驟 1
前往管理中心 > 系統整合 > API 金鑰管理，建立用途為「機器人知識 API」的 API 金鑰，
建立完成後，會包含金鑰 (API Key) 及密鑰 (API Secret)，請妥善保存。

步驟 2
訪客輸入的訊息觸發有設定 API 功能的機器人知識時，機器人將以 HTTP POST 方式，傳送以下參數至所設定的 API URL
apiKey所使用的 API KeychatId目前對話的 IDintegration.memberId若有進行會員串接，機器人將同時帶入 memberId，沒有 memberId 時值為 nullknowledgeSummary所觸發的知識主旨userInput訪客輸入的訊息step機器人與API連結目前執行的階段 (剛觸發時此值必為1)storeDataAPI 流程進行中所紀錄的資料userIp 訪客 IPtimestamp訪客輸入訊息的時間 (UNIX timestamp)token供驗證來源正確性，利用 API Secret 將資訊經過 sha256 編碼後的字串
({API Secret}{timestamp}{talkId}{knowledgeSummary}{userInput}{step}{userIp})
API 端所須回傳參數 (JSON)
replyMessage欲顯示給訪客的回覆訊息 (若 API 執行錯誤，請留空)quickMenu(非必要) 快速選單名稱 (多個選項請以符號 , 區隔)
nextStep下一步驟編號 (小於等於 9999的數字，若API執行錯誤，請留空)
9999 表示結束 API 連結storeData(非必要) API 流程進行中所需要紀錄的資料customizeStatusCode(非必要) 自定義錯誤碼，當機器人執行 API URL 發生錯誤時，機器人會將此值顯示於訊息中※ Debug 請參考機器人回應訊息 (Status Code)
※ 利用 customizeStatusCode 可對 API 程式進行 Debug

Status Code狀態說明
001
010
API Secret 錯誤002
004
011
013
replyMessage 錯誤003
005
006
012
014
015
nextStep 錯誤007
008
016
017
storeData 錯誤
009
018
API 錯誤
PHP範例
範例僅供參考，請依實際情況檢驗參數及確認相關辨別條件。
<?php
if (!$_POST[’chatId’]) {
echo json_encode([
’customizeStatusCode’ => 1
]);
exit;
} elseif (!$_POST[’knowledgeSummary’]) {
echo json_encode([
’customizeStatusCode’ => 2
]);
exit;
} elseif ($_POST[’userInput’] === ’’) {
echo json_encode([
’customizeStatusCode’ => 3
]);
exit;
} elseif (!$_POST[’step’]) {
echo json_encode([
’customizeStatusCode’ => 4
]);
exit;
} elseif (!$_POST[’userIp’]) {
echo json_encode([
’customizeStatusCode’ => 5
]);
exit;
} elseif (!$_POST[’timestamp’]) {
echo json_encode([
’customizeStatusCode’ => 6
]);
exit;
} elseif (!$_POST[’token’]) {
echo json_encode([
’customizeStatusCode’ => 7
]);
exit;
}

$_POST[’integration’] = isset($_POST[’integration’]) ? $_POST[’integration’] : [];
$_POST[’integration’][’memberId’] = isset($_POST[’integration’][’memberId’]) ? $_POST[’integration’][’memberId’] : null;
$_POST[’storeData’] = isset($_POST[’storeData’]) ? $_POST[’storeData’] : [];

$apiSecret = ’請填入 API Secret’;
$verifyString = $apiSecret . $_POST[’timestamp’] . $_POST[’chatId’] . $_POST[’knowledgeSummary’] . $_POST[’userInput’] . $_POST[’step’] . $_POST[’userIp’];
$verifyToken = hash(’sha256’, $verifyString);

if ($verifyToken !== $_POST[’token’]) {
echo json_encode([
’customizeStatusCode’ => 8
]);
exit;
}

if ($_POST[’step’] == 1) {
$success = [
’replyMessage’ => ’執行 Action A 請輸入 A，Action B 請輸入 B’,
’quickMenu’ => ’A,B’,
’nextStep’ => 2
];
} elseif ($_POST[’step’] == 2) {
if ($_POST[’userInput’] === ’A’) {
$success = [
’replyMessage’ => ’選擇了 Action A，是否確定？’,
’quickMenu’ => ’是,否’,
’nextStep’ => 3,
’storeData’ => [
’action’ => ’A’
]
];
} elseif ($_POST[’userInput’] === ’B’) {
$success = [
’replyMessage’ => ’選擇了 Action B，是否確定？’,
’quickMenu’ => ’是,否’,
’nextStep’ => 3,
’storeData’ => [
’action’ => ’B’
]
];
} else {
$success = [
’replyMessage’ => ’輸入錯誤，請重新輸入’,
’nextStep’ => 2
];
}
} elseif ($_POST[’step’] == 3) {
if ($_POST[’userInput’] == ’是’) {
$success = [
’replyMessage’ => ’已儲存選擇 ’ . $_POST[’storeData’][’action’],
’nextStep’ => 9999
];
} else {
$success = [
’replyMessage’ => ’請重新選擇 A 或 B 。’,
’quickMenu’ => ’A,B’,
’nextStep’ => 1
];
}
}

if (!isset($success)) {
echo json_encode([
’customizeStatusCode’ => 9
]);
}

echo json_encode($success);
Cami
Cami Trigger使用說明
在裝有Cami代碼的頁面上，可對頁面元素設定cami_trigger，訪客點擊此元素等同於點擊客服圖示
cami_trigger可指定部門或客服人員，並預設訪客訊息

設定方式
1. 對HTML元素(div、span、a ...)，增加class cami_trigger
2. 對前項中的元素增加屬性(attribute)：
data-cami-trigger-assign
指定部門或客服人員的識別編號(視目前頁面上的系統安裝方式為部門或客服人員)，編號於部門設定或帳號管理中取得
data-cami-trigger-robot
當機器人設定為開啟，且此值為1時，不管機器人為優先或替補，皆會進入機器人模式
data-cami-trigger-message
設定當訪客點擊後的預設訊息

範例
<div class="cami_trigger" data-cami-trigger-assign="a1b2d3e4" data-cami-trigger-robot="0" data-cami-trigger-message="如何申請">詢問如何申請客服</div>
Cami
Cami Bridge使用說明(單一頁面設定獨立參數)
利用Cami Bridge功能可以對單一頁面進行獨立的設定，目前支援的設定項目：
1. 客服狀態圖示
2. 客服原視窗跳轉
3. 系統載入完畢後執行callback function

如需對其他項目進行個別設定，
如：進入客服系統後的網站名稱及說明、服務時段、進站諮詢提醒等，請利用管理中心中的網站個別設定功能

步驟 1
於Cami系統原本的安裝代碼上方加入camiBridge變數
<script>
const camiBridge = {

};
</script>

步驟 2
調整camiBridge變數 (不需設定的項目不必加入camiBridge中)
camiBridge.styles.pics.online
變更客服「線上」圖示(網址)
camiBridge.styles.pics.busy
變更客服「忙線」圖示(網址)
camiBridge.styles.pics.offlie
變更客服「離線」圖示(網址)
camiBridge.styles.pics.appear_online
變更文字捲動精簡模式，客服「線上」圖示(網址)
camiBridge.styles.pics.appear_busy
變更文字捲動精簡模式，客服「忙線」圖示(網址)
camiBridge.styles.pics.appear_offline
變更文字捲動精簡模式，客服「離線」圖示(網址)
camiBridge.customize.self_startup
是否於原視窗跳轉至Cami系統
1：是
0：開新視窗
camiBridge.customize.complete_callback
Cami載入完畢後，執行callback function
camiBridge.customize.service_alert.switch_on
設定進站諮詢提醒開關
1：開啟
0：關閉
camiBridge.customize.service_alert.department
進站諮詢提醒負責部門編號(請至管理中心的部門管理中取得)
camiBridge.customize.service_alert.first.time
訪客於頁面上停留多久後，第一次提醒
camiBridge.customize.service_alert.first.message
第一次提醒所顯示的訊息
camiBridge.customize.service_alert.second.time
訪客於頁面上停留多久後，第二次提醒
camiBridge.customize.service_alert.second.message
第二次提醒所顯示的訊息

camiBridge設定範例
const camiBridge = {
  styles: {
      pics: {
          online: ’https://cami.yesing.com/images/online.gif’,
  busy: ’https://cami.yesing.com/images/busy.gif’,
  offline: ’https://cami.yesing.com/images/offline.gif’
  }
},
customize: {
  complete_callback: function () {
    alert(’Cami callback’);
  }
}
};