起動とリセット

チャネルを初めて起動するとき、またはボットの対話履歴をリセットするときに、この API で対話を開始します。

{{base_url}}/generic/ns/{{namespace}}/bot-provider/{{bot_provider_name}}/message/sse

POST

API キーの機能を有効にしている場合、ヘッダーに X-API-KEY を含め、Asgard の管理画面で設定した API キーを指定してください。指定しないと接続できません。

名称	型	説明
X-API-KEY	string	ご利用の API キー

名称	型	説明
customChannelId	string	チャットチャネルの ID。必須で、任意に決められます。対話の記憶はチャネル ID ごとです。
customMessageId	string	メッセージ ID。任意に設定するか空でも構いません。追跡とデバッグに便利です。
text	string	初期化時は空にします
action	string	初期化時は `RESET_CHANNEL` を指定します

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

成功すると JSON メッセージが連続して届きます。各イベントの詳細は次を参照してください。

message オブジェクトの template 項目には、フロントエンドの標準コンポーネント向けの描画データが入ります。