API リファレンス

POST /v1/agents

type Agent = { id: string; name: string; version: number; config?: AgentConfig; created_at: number; updated_at: number };

type AgentConfig = {
  greeting: string;            // 最初のあいさつ（300 文字まで）
  persona: string;             // 役割と話し方（1,000 文字まで）
  fields: { key: string; label: string; required?: boolean; type?: 'text' | 'phone' }[]; // 1〜20 個
  handoff_when: string[];      // 人に引き継ぐ条件（20 個まで）
  closing: string;             // 聞き取りが終わったときの締め（300 文字まで）
  closing_answered?: string;   // よくある質問で用が済んだときの締め
  faq?: { q: string; a: string }[];  // 50 個まで
  domain?: string;             // 業種（音声認識の手がかり）
  vocabulary?: string[];       // 用語（音声認識の手がかり、200 個まで）
  voice?: string;              // 声の名前（既定 Aoede）
  speaking_rate?: number;      // 話す速さ（既定 1.15）
  tools?: AgentTool[];         // 通話中の道具（10 個まで）
  connectors?: ConnectorEntry[]; // 連携（10 個まで）
};

type AgentTool = {
  name: string; description: string; url: string; confirm?: boolean;
  parameters?: { properties: Record<string, { type: 'string' | 'number' | 'integer' | 'boolean'; description?: string; enum?: string[] }>; required?: string[] };
};

type ConnectorEntry =
  | { connector: string; actions: string[]; confirm?: string[] }   // プリセット
  | { connection: string; actions: string[]; confirm?: string[] }; // 決まった連携（con_…）

GET /v1/agents

GET /v1/agents/{id}?version=

PUT /v1/agents/{id}

GET /v1/agents/{id}/versions

DELETE /v1/agents/{id}

POST /v1/tenants

type Tenant = { id: string; external_id: string; name: string; agent_id: string | null; status: 'active' | 'disabled'; created_at: number };

GET /v1/tenants

GET /v1/tenants/{id}

PATCH /v1/tenants/{id}

POST /v1/tenants/{id}/secret

DELETE /v1/tenants/{id}

GET /v1/calls?tenant_id=&cursor=&limit=

type Call = {
  id: string; tenant_id: string; agent: { id: string; version: number };
  provider_call_id: string | null;   // Twilio の CallSid、Web・アプリはセッションの ID
  from: string | null;               // かけてきた番号（電話で from を渡したとき）
  started_at: number; ended_at: number | null; duration_ms: number | null;
  outcome: 'completed' | 'answered' | 'handoff' | 'hangup' | 'error' | null; reason: string | null;
  fields: Record<string, string> | null;
  summary: string | null; category: string | null; has_transcript: boolean;
  channel: 'phone' | 'web'; output: 'audio' | 'text';
  billed_yen: number | null;         // この通話の利用料（税別の円、小数 3 桁まで）。通話中は null
};

GET /v1/calls/{id}

GET /v1/calls/by-provider/{providerCallId}

GET /v1/calls/{id}/transcript

POST /v1/sessions

GET /v1/usage?from=&to=&group_by=

type Usage = {
  environment: 'live' | 'test'; from: number; to: number;
  group_by: 'tenant' | 'day' | 'channel' | null; unit_price_yen: number;
  total: { calls: number; seconds: number; minutes: number; amount_yen: number };
  data: (({ tenant: { id: string; external_id: string; name: string } } | { day: string } | { channel: 'phone' | 'web' })
        & { calls: number; seconds: number; minutes: number; amount_yen: number })[];  // group_by が無ければ []
  note: string;
};

POST /v1/webhooks/portal

GET /v1/billing

type Billing = {
  organization_id: string; month: string;            // 今月（日本時間、YYYY-MM）
  contract: { payment_method: 'card' | 'invoice'; per_minute_yen: number; invoice_days_until_due: number };
  has_card: boolean;                                   // オートチャージに使うカードを保存したか
  usage: { calls: number; seconds: number; minutes: number };  // 今月の通話（本番とテストの合計）
  estimate_yen: number;                                // チャージ式は今月に引いた額、請求書払いは見込み
  balance: { yen: number; milli_yen: number; depleted: boolean; next_expiry: { yen: number; at: number } | null } | null;  // チャージ式だけ
  auto_recharge: { enabled: boolean; threshold_yen: number; amount_yen: number; monthly_cap_yen: number | null;
                   recharged_this_month_yen: number; failures: number; max_failures: number } | null;  // チャージ式だけ
  topup: { min_yen: number; max_yen: number; quick_yen: number[]; credit_months: number };
  spending_cap_yen: number | null; cap_reached: boolean;
  payment: { failed_at: number; grace_ends_at: number; suspended: boolean } | null;  // 請求書払いの支払いの遅れ
  tax: 'excluded'; tax_rate: number;
  // ほかに price・stripe_enabled・subscription_status・threshold
};

POST /v1/billing/topups

GET /v1/tools/secret

POST /v1/tools/secret/rotate

GET /v1/connectors

type Connector = {
  id: string; name: string; description: string;
  category: 'scheduling' | 'crm' | 'notify' | 'custom'; auth: 'oauth2' | 'api_key' | 'webhook_url';
  available: boolean;      // この voicast で使える
  needs_setup: boolean;    // つないだあとに設定が要る
  notify: boolean;         // 通話のあとに通知する
  env_only: boolean;       // 環境の連携だけ（埋め込みの連携の画面に出ない）
  inputs: { name: string; type: 'text' | 'password' | 'url' | 'number' }[];
  actions: { name: string; tool: string; description: string; confirm: boolean }[]; // tool は AI に見せる名前
};

GET /v1/connections?tenant_id=

type Connection = {
  id: string; connector: string; tenant_id: string | null;
  label: string;           // 相手のアカウント名（clinic@example.com・ワークスペース #チャンネル など）
  status: 'active' | 'needs_setup' | 'needs_reauth';
  config: object; created_by: string | null; created_at: number; updated_at: number;
};

POST /v1/connections

GET /v1/connections/{id}

PATCH /v1/connections/{id}

GET /v1/connections/{id}/options

DELETE /v1/connections/{id}

GET /v1/tenants/{id}/connections

POST /v1/tenants/{id}/connect-links

wss://voice.voicast.jp/ws

POST https://voice.voicast.jp/v1/webrtc/offer

PATCH https://voice.voicast.jp/v1/webrtc/offer