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

公開 REST API 概要

Recho 公開 REST API は、API キーを使って参照系データをプログラムから取得するための HTTP API です。通話ログ・統計・文字起こし・音声・架電エクスポート・受電/架電の通話モニタリング(通話一覧)といったデータを、ダッシュボードを介さずに自システムへ取り込めます。

認証

すべてのエンドポイントは API キー認証が必須です。リクエストヘッダ X-API-Key に発行済みの API キーを指定します。詳細は 認証 (API キー) を参照してください。

権限(スコープ)

API キーには**権限(permission)**を割り当てます。各エンドポイントは特定の権限を要求し、その権限を持たない API キーからのリクエストは拒否されます。

権限は project 単位で評価されます。リクエストの projectId で指定したプロジェクトに対して、その API キーが必要な権限を持っているかどうかが判定されます。

割り当て可能な権限一覧

権限 (x-required-permission)説明カテゴリ
call-log:read通話ログの閲覧通話履歴
call-log:export通話ログの CSV エクスポート通話履歴
call-log:statistics通話ログの統計閲覧通話履歴
call-log:transcript-read通話の文字起こし閲覧通話履歴
call-log:transcript-export文字起こしの CSV エクスポート通話履歴
call-log:audio-read通話の音声再生通話履歴
inbound-call:read受電プロジェクトの通話モニタリング閲覧受電-通話モニタリング
outbound-call:read架電プロジェクトの架電リクエスト・通話モニタリング閲覧架電-通話モニタリング

各エンドポイントが要求する権限は、自動生成リファレンスの各エンドポイント詳細ページ(説明欄の「必要な権限」)で確認できます。

エンドポイント一覧

利用可能なエンドポイントの一覧・パラメータ・レスポンス構造は、左サイドバーの自動生成「API リファレンス」を参照してください。OpenAPI 仕様から自動生成されており、常に最新の公開仕様を反映します。