メインコンテンツまでスキップ

REST API リファレンス

すべての API エンドポイントは /api/ プレフィックス付きで、セッション cookie による認証が必要です。すべてのリクエストとレスポンスは Content-Type: application/json を使用します。


会話

エンドポイントメソッド説明
/api/conversationsGET会話一覧(フィルター: status, channel_type, tag, search, page)
/api/conversations/{id}GET会話取得(unread_count をリセット)
/api/conversationsPOST会話作成
/api/conversations/{id}/statusPOSTステータス更新
/api/conversations/{id}/tagsPOSTタグ追加
/api/conversations/{id}/tags/{tag}DELETEタグ削除
/api/conversations/{id}/assignPOSTエージェント割り当て

メッセージ

エンドポイントメソッド説明
/api/conversations/{id}/messagesGETメッセージ一覧
/api/conversations/{id}/messagesPOSTメッセージ送信

AI 提案

エンドポイントメソッド説明
/api/ai-suggest?conversation_id={id}GETAI 返信提案を取得

コンタクト

エンドポイントメソッド説明
/api/contactsGETコンタクト一覧
/api/contacts/{id}GETコンタクト取得
/api/contactsPOSTコンタクト作成
/api/contacts/{id}PATCHコンタクト更新
/api/contacts/{id}DELETEコンタクト削除(管理者)

チャネル(管理者のみ)

エンドポイントメソッド説明
/api/channelsGETチャネル一覧
/api/channelsPOSTチャネル作成
/api/channels/{id}PATCHチャネル更新
/api/channels/{id}DELETEチャネル削除

オートメーション(管理者のみ)

エンドポイントメソッド説明
/api/automationsGETオートメーション一覧
/api/automationsPOSTオートメーション作成
/api/automations/{id}/togglePOST有効/無効の切り替え
/api/automations/{id}DELETEオートメーション削除

アナリティクス

エンドポイントメソッド説明
/api/analytics?days=30GETアナリティクスデータ取得

エージェント(管理者のみ)

エンドポイントメソッド説明
/api/agentsGETエージェント一覧
/api/agentsPOSTエージェント作成
/api/agents/{id}/rolePOSTロール更新
/api/agents/{id}DELETEエージェント削除

設定

エンドポイントメソッド説明
/api/settings/workspaceGETワークスペース設定取得
/api/settings/workspacePOSTワークスペース更新(管理者)
/api/settings/passwordPOSTパスワード変更

エラー形式

{"error": "Human-readable error message"}
コード意味
200成功
201作成済み
400不正なリクエスト
401未認証
403禁止
404見つかりません
409競合
500内部エラー