Webhookモード
Webhookモード
GPTBots のエージェント応答モードには、現在 blocking、streaming、webhook の3種類が用意されています。webhookモード を使用する場合、エージェントまたはカスタマーサポート担当者が送信したメッセージは指定された Webhook アドレスへ送信されます。
リクエストメソッド
POST
エンドポイント
メッセージの受信先アドレスは、「エージェント → インテグレーション → API → Webhook」 ページで設定してください。
認証
認証の詳細は「概要」セクションをご参照ください。
リクエスト
リクエストの例
curl -X POST YOUR_API \
-H 'Authorization: Bearer your_apikey' \
-H 'Content-Type: application/json' \
-d '{
"message_id": "65a4ccfC7ce58e728d5897e0",
"message_type": "ANSWER",
"text": "Hi, is there anything I can help you?",
"flow_output": [
{
"content": "hello",
"branch": "1",
"from_component_name": "User Input"
}
],
"create_time": 1679587005,
"conversation_id": "657303a8a764d47094874bbe"
}
'
curl -X POST YOUR_API \
-H 'Authorization: Bearer your_apikey' \
-H 'Content-Type: application/json' \
-d '{
"message_id": "65a4ccfC7ce58e728d5897e0",
"message_type": "ANSWER",
"text": "Hi, is there anything I can help you?",
"flow_output": [
{
"content": "hello",
"branch": "1",
"from_component_name": "User Input"
}
],
"create_time": 1679587005,
"conversation_id": "657303a8a764d47094874bbe"
}
'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer または Basic ${token} | 認証には Authorization: Bearer または Basic ${token} を使用します。トークンは「APIキー」ページから取得してください。 |
| Content-Type | application/json | データの形式は application/json を設定してください。 |
リクエストボディ
| フィールド | タイプ | 説明 |
|---|---|---|
| message_id | String | 一意のメッセージID |
| message_type | String | メッセージの種別。指定可能な値：ANSWER、QUESTION |
| text | String | エージェントが提供するテキスト内容 |
| flow_output | JSON Array | フローモードにおけるエージェントの応答内容。 |
| content | String | フローモードでエージェントコンポーネントから返されるテキスト応答 |
| branch | String | フローモードにおけるエージェントのブランチ名 |
| from_component_name | String | フローモードにおける上流コンポーネント名 |
| create_time | Long | レスポンスメッセージが作成されたタイムスタンプ |
| conversation_id | String | 会話（Conversation）のID |
レスポンス
レスポンス例
{
"code": 200,
"msg": "success"
}
{
"code": 200,
"msg": "success"
}
このコードブロックをポップアップで表示