與機器人對話過程中,觸發設有知識 API 的知識時,機器人將主動前往 API 位址取得回應內容。
建立 API 金鑰
請先前往管理中心 > 系統整合 > API 金鑰管理,建立或使用既有的機器人知識 API Key,
建立完成後,會包含金鑰 (API Key) 及密鑰 (API Secret),請妥善保存,後續的 API 程式開發將會使用到。
知識 API 程式開發
當觸發知識 API 時,機器人將以 HTTP POST 方式,發送請求至指定的 API 位址,相關參數格式說明如下:
chatId | varchar(50) | 對話識別 ID |
knowledgeSummary | varchar(150) | 被觸發的知識主旨 |
userInput | text | 使用者輸入的訊息內容 |
step | int | 知識 API 過程中的步驟編號 |
userLang | varchar(10) | 使用者語系 |
userIp | varchar(39) | 使用者 IP |
timestamp | int | 以十位數的 timestamp 表示現在時間 |
token | varchar(32) | 供驗證來源正確性,利用 API Secret 將資訊經過 sha256 編碼後的字串 ({API Secret}{timestamp}{chatId}{knowledgeSummary}{userInput}{step}{userLang}{userIp}) |
API 回傳參數如下:
customizeStatusCode | int | 自定義狀態碼,用於除錯或已預期的錯誤回傳 |
replyMessage | text | 回覆內容 |
quickMenu | text | 快速選單 (多個以符號 , 區隔) |
nextStep | int | 下一個流程編號 |
storeData | array | 儲存中繼資料,可用於後續流程 (key: value) |
timestamp | int | 以十位數的 timestamp 表示現在時間 |
token | varchar(32) | 供驗證來源正確性,利用 API Secret 將資訊經過 sha256 編碼後的字串 ({API Secret}{timestamp}{chatId}{replyMessage}{quickMenu}{nextStep}{userIp}) |
設定 API 位址
完成程式開發後,請將 API 位置設定於機器人問候語或知識 API 欄位中。