APIリファレンス

Telmia は REST API を提供しており、外部システムとの連携やプログラムからの操作が可能です。

ノート

APIは現在ベータ版です。エンドポイントや仕様は今後変更される可能性があります。各エンドポイントの詳細ドキュメントは順次追加予定です。

認証

すべてのAPIリクエストには、Authorizationヘッダーにベアラートークンを含める必要があります。

Authorization: Bearer <YOUR_API_TOKEN>

APIトークンは、設定 > API からテナントごとに発行できます。

主要エンドポイント一覧

認証

メソッド	パス	説明
POST	/api/auth/login	ログイン
POST	/api/auth/register	アカウント登録
POST	/api/auth/refresh	トークンリフレッシュ

Q&A

メソッド	パス	説明
GET	/api/qa	Q&A一覧の取得
POST	/api/qa	Q&Aの追加
PUT	/api/qa/:id	Q&Aの更新
DELETE	/api/qa/:id	Q&Aの削除
POST	/api/qa/import	CSVインポート
POST	/api/qa/sync	AIへの同期を実行

テナント

メソッド	パス	説明
GET	/api/tenants	所属テナント一覧
POST	/api/tenants	テナント作成
PUT	/api/tenants/:id	テナント情報の更新
DELETE	/api/tenants/:id	テナント削除

ユーザー・メンバー

メソッド	パス	説明
GET	/api/members	メンバー一覧
POST	/api/members/invite	メンバー招待
PUT	/api/members/:id/role	ロール変更
DELETE	/api/members/:id	メンバー削除

会話履歴

メソッド	パス	説明
GET	/api/conversations	会話一覧の取得
GET	/api/conversations/:id	会話詳細の取得
GET	/api/conversations/export	CSVエクスポート

設定

メソッド	パス	説明
GET	/api/settings	テナント設定の取得
PUT	/api/settings	テナント設定の更新
GET	/api/phone-numbers	電話番号一覧
POST	/api/phone-numbers	電話番号の追加

レスポンス形式

すべてのレスポンスは JSON 形式で返されます。

{
  "success": true,
  "data": { ... }
}

エラー時は以下の形式になります。

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "認証が必要です"
  }
}

レート制限

APIリクエストは1分あたり60回までに制限されています。制限を超えた場合、429 Too Many Requests が返されます。