提供外部系統取得機器人回應訊息。
步驟 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
errMsg | varchar(100) | 錯誤訊息。如成功此值為空值 |
understanding | int(1) | 機器人是否理解。(0:未能理解、1:已理解,並有回傳知識訊息) |
notSure | int(1) | 機器人對於內容理解是否肯定。(0:肯定、1:不肯定) |
serial | varchar(100) | 知識編號 |
category | varchar(20) | 回應知識所屬的知識分類名稱 |
answer | text | 應答內容 |
quickMenu | array, varchar(20) | 快速選單項目 |
time | int(13) | 回應時間 (milli timestamp) |