REFERENCE
開發者參考
認證、API、SDK、Flow Agent 處理節點與參數取值的完整參考。
發送訊息
當您已經啟動對話，需要發送訊息給 Bot 時，需要使用這個 API 來發送訊息。
URI
{{base_url}}/generic/ns/{{namespace}}/bot-provider/{{bot_provider_name}}/message/sse
HTTP Method
POST
Headers
如果您有設定使用 API-Key 功能，請在 Header 中加入 X-API-KEY 欄位，值為您在 Asgard 後台設定的 API-Key。否則會無法正常連線。
| 名稱 | 類型 | 描述 |
|---|---|---|
| X-API-KEY | string | 您使用的 API-Key |
Request Parameters
| 名稱 | 類型 | 描述 |
|---|---|---|
| customChannelId | string | 聊天頻道 ID，請使用同啟動請求用的頻道 ID。同一頻道 ID 才會記憶對話內容。 |
| customMessageId | string | 訊息 ID，可自訂或留空，便於追蹤與除錯。通常為流水號遞增。 |
| text | string | 輸入的訊息內容。 |
| action | string | 這邊固定使用NONE |
Sample Payload
{
"customChannelId": "a-random-channel-id-1",
"customMessageId": "a-random-msg-id-2",
"text": "微波烤箱可以烤德國豬腳或生鮮料理嗎?",
"action": "NONE"
}
Response
成功就會收到連串的 JSON 訊息，需要了解每個事件的詳細資訊？請參考底下文件說明：
詳細事件說明
- asgard.run.init - 啟動事件
- asgard.message.start - 訊息開始事件
- asgard.message.delta - 訊息增量事件
- asgard.message.complete - 訊息完成事件
- asgard.run.done - 完成事件
- asgard.run.error - 錯誤事件
Message Template
message 物件的 template 欄位提供了前端公版的渲染資料物件，詳細可參考：
- Message Template 完整說明 - 了解如何處理模板資料