跳至主要内容

啟動與重置的API

當您是頻道首次啟動,或是需要重置 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-KEYstring您使用的 API-Key

Request Parameters

名稱類型描述
customChannelIdstring聊天頻道 ID,必填,可任意設定。。同一頻道 ID 才會記憶對話內容。
customMessageIdstring訊息 ID,可自訂或留空,便於追蹤與除錯。
textstring初始化時請留空
actionstring初始化必須填寫 RESET_CHANNEL

Sample Payload

{
"customChannelId": "a-random-channel-id-1",
"customMessageId": "a-random-msg-id-1",
"text": "",
"action": "RESET_CHANNEL"
}

實際應用範例

請參考下方的請求操作教學,內含完整 JSON 範例與應用說明:

Response

成功就會收到連串的 JSON 訊息,需要了解每個事件的詳細資訊?請參考底下文件說明:

詳細事件說明

Message Template

message 物件的 template 欄位提供了前端公版的渲染資料物件,詳細可參考: