Yesing Forum » 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)為這個請求循環 (一個對話) 指定一個唯一的識別ID
platform非必要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)