ja
5 分で読了 Business

コール監査エンタープライズAPI: エンドポイントと例

監査API v1の実践リファレンス: 組織キーによる認証、URLまたはアップロードによる監査作成、エージェント、チーム、スクリプト、分析、HMACウェブフック。

コール監査API v1の実践リファレンス — 監査モジュールとPABXまたは電話プラットフォームを連携するための統合チャネルです。エンタープライズプランの組織と組織のAPIキーが必要です。

認証

キーは /dashboard/organization/auditorias で作成します(OWNER/ADMINのみ。組織ごとに最大10個のアクティブなキー)。すべてのリクエストで送信します:

Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG
  • シークレットは作成時に一度だけ表示されます。当社はハッシュのみを保存します。
  • 各キーにはスコープaudits:writeaudits:readusage:readanalytics:read など)が含まれます。付与されていないものはデフォルトで拒否されます。
  • レート制限: キーごとに毎分60リクエスト

監査を作成する

curl -X POST https://www.vozparatexto.com.br/api/v1/audits \
  -H "Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG" \
  -H "Content-Type: application/json" \
  -d '{
    "audio_url": "https://pbx.suaempresa.com/gravacoes/8841.mp3",
    "webhook_url": "https://api.suaempresa.com/hooks/auditorias",
    "idempotency_key": "chamada-8841",
    "agent_external_id": "maria.souza",
    "team": "vendas-sp"
  }'

ルール:

  • audio_urlhttpsのみ、公開URL)または upload_id(下記参照)を受け付けます。
  • webhook_url必須です。結果はポーリングではなくウェブフックで届きます。
  • idempotency_keyは永続的に保存されます。同じキーで再送しても監査が重複しません。
  • 即時応答: 202 { "audit_id": "...", "status": "queued" }.

確認: GET /api/v1/audits(一覧)と GET /api/v1/audits/{id}(詳細)。

公開URLがない録音の場合

URLを公開できないPABXの場合は、一時的なアップロードURLをリクエストします:

curl -X POST https://www.vozparatexto.com.br/api/v1/uploads \
  -H "Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG"

レスポンスに含まれる put_url1時間有効です。PUTでファイルをアップロードし、監査作成時に返された upload_id を使用してください。

オペレーションの登録とメトリクス

エンドポイント機能
GET/POST /api/v1/agentsエージェント(お使いのシステムの外部IDを使用)
GET/POST /api/v1/teamsチーム
GET/POST /api/v1/scripts + POST /api/v1/scripts/{id}/versionsスクリプトとバージョン
GET /api/v1/usage期間中の消費量
GET /api/v1/analytics/summaryオペレーションの分析サマリー
GET /api/v1/analytics/agents/{external_id}エージェント別のメトリクス

ウェブフックと保証

  • 配信はHMAC-SHA256で署名されます(X-VPT-Signature + X-VPT-Event)。処理前に検証してください。
  • 試行ごとのタイムアウトは15秒、最大6回再試行し、5分から24時間のバックオフがあります。
  • 停止したジョブも消えません。10分以上停止したキューは再キューされ、60分以上停止した処理はエラーウェブフック付きの失敗になります。送信されたすべての音声は最終コールバックを生成します。

詳細は ウェブフックと通知 をご覧ください。

FAQ

ここで個人用APIキーを使用できますか?

いいえ — 監査APIは、OWNER/ADMINが監査ダッシュボードで作成した組織のキーを使用し、専用スコープを持ちます。

同じ通話を2回送信しました。重複しますか?

いいえ、同じidempotency_keyを使用していれば重複しません。冪等性はデータベース上で永続的に保証されます。

アップロード完了前にput_urlの有効期限が切れました。どうすればよいですか?

新しいput_url(有効期限1時間)を取得して再アップロードしてください。まだ何も作成されていません。

各インテグレーションの権限を制限するには?

システムごとに別々のキーを作成し、必要なスコープのみを付与します(例: 内部ダッシュボードはanalytics:readのみ)。不要になったら個別に失効させます。

関連記事

解決しませんか? チケットを開く — サポートチームが迅速に対応します。