メッセージの送信

対話を開始した後、ボットへメッセージを送るにはこの API を使います。

URI

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

HTTP メソッド

POST

ヘッダー

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

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

リクエストのパラメータ

名称	型	説明
customChannelId	string	チャットチャネルの ID。起動リクエストと同じ ID を使ってください。対話の記憶はチャネル ID ごとです。
customMessageId	string	メッセージ ID。任意に設定するか空でも構いません。追跡とデバッグに便利で、通常は連番です。
text	string	送信するメッセージの内容。
action	string	ここでは常に `NONE` を指定します

ペイロードの例

{
  "customChannelId": "a-random-channel-id-1",
  "customMessageId": "a-random-msg-id-2",
  "text": "電子レンジオーブンでドイツ風豚足や生の食材を調理できますか。",
  "action": "NONE"
}

レスポンス

成功すると 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 のリファレンス — テンプレートデータの扱い方

URI​

HTTP メソッド​

ヘッダー​

リクエストのパラメータ​

ペイロードの例​

レスポンス​

各イベント​

Message Template​

URI