Webhook
Cognigy.AIでは、Webhook Endpointとの統合を使用することで、リソースを簡単にWebhookに接続できます。このセットアップにより、準備ができたときに指定されたコールバックURLに即座に情報を送信することで、迅速なコミュニケーションが実現します。CognigyリソースをこのWebhookに接続することで、高速でスムーズなやりとりが可能となり、リアルタイムの更新やアクションが可能になります。
音声用のAI CopilotをWebhook Endpointで使用する場合、特定のVoice Copilot Endpointに切り替えることができます。これにより、必要なロジックはすべてVoice Copilot Endpointにすでに含まれているため、Webhook URLを作成するために別のCode Nodeを用意する必要がなくなります。
基本Endpoint設定
Find out about the generic endpoint settings available with this endpoint on the following pages:
- Endpoints Overview(エンドポイントの概要)
- Data Protection & Analytics(データ保護と分析)
- Transformer Functions(トランスフォーマー関数)
- NLU Connectors(NLUコネクタ)
- Handover Settings(ハンドオーバー設定)
- Real Time Translation Settings(リアルタイム翻訳設定)
Inject & Notify対応
このタイプのEndpointでは、[Inject & Notify]機能を使用できます。
アプリケーションに接続する
POSTコールを受信するWebサーバーを実行する必要があります。割り当てられたフローの出力が送信されるアプリケーションのWebhook URLを入力します。ユーザーとパスワードの項目は、Webサーバーの基本認証を定義している場合にのみ使用されます。
Endpoint URLに送信されたすべてのPOSTリクエストは、割り当てられたFlowによって処理され、トリガーされた出力はWebhook URLに転送されます。リクエストのボディ(本文)は以下の形式である必要があります:
{
"userId":"userId",
"sessionId": "someUniqueId",
"text":"message text",
"data": {
"key": "value"
}
}
パラメータ userId – 文字列の形式で、REST EndpointにアクセスできるユーザーのユーザーID sessionId – 文字列の形式で、現在のトークを追跡するために使用される一意のID text – 文字列の形式で、割り当てられたフローによって処理されるべきメッセージテキスト data – オブジェクトの形式で、割り当てられたフローによって処理されるべきメッセージデータ
テキストとデータの送信
Webhook Endpointを使用して、テキストまたはデータのいずれかをFlowに送信できます。両方を送信することもできますが、少なくとも1つは必要です。無効なテキストと無効なデータが指定された場合、Webhook Endpointはエラーを発生させます。
セッションID
sessionIdは、トークの状態を保持するために使用される一意の識別子です。つまり、新しいトークが始まるたびに新しい固有のIDを生成する必要があり、メッセージごとに生成する必要はありません。テスト目的であれば、好きな文字列値を sessionId として使用し、新しいトークを開始するたびに変更することができます。