コンテンツにスキップ
Documentation

RTC サーバー APIリファレンス

ベースURL: https://api.rtc.champrep.com

このリファレンスでは、RTC プロジェクトAPIキーでサポートされている統合ルートについて説明しています。 コンソールへのサインイン、組織の設定、キーの管理、およびプラットフォーム管理 操作は、サーバーキーによる統合ルートには該当しません。これらについては、 ブラウザのセッショントークンをスクリプトにコピーするのではなく、適切な UI を通じて管理してください。

送信 Authorization: Bearer YOUR_RTC_API_KEY 、また、JSON ボディの場合は、 Content-Type: application/json。例ではプレースホルダーが使用されており、実際の認証情報は決して使用されません。 キーへのアクセスは、そのプロジェクトおよび現在のプランのアクセス権の範囲内に制限されます。

リクエストおよびレスポンスの規約

Section titled “リクエストおよびレスポンスの規約”
  • ID は UUID 文字列です。表示名ではなく、RTC から返された ID を使用してください。
  • 名前は先頭・末尾が切り詰められ、1~80文字まで入力可能です。
  • JSON ボディは 64 KiB に制限されており、未知のフィールドは拒否されます。
  • リストエンドポイントは、最新のものを先頭にJSON配列を返します。 ?limit (1-200) は ページサイズを設定します。項目がこれより多い場合は、 X-Next-Cursor レスポンスヘッダーには、 戻すためのカーソルが格納されています。 ?cursor.
  • 文書化されていないレスポンスフィールドに依存したり、メディアやストレージのURLを独自に構築したりしないでください。
  • ミューテーションには、一般的な冪等性キーの契約は提供されません。タイムアウトや接続切断の後に再試行を行う際は、 結果を照合してください。

メソッドとパス必要なスコープ結果
GET /v1/projects有効なプロジェクトキーであればどれでもプロジェクトでフィルタリングされた配列
GET /v1/roomsrooms:readルームの配列
POST /v1/roomsrooms:write201、作成されたルーム
POST /v1/rooms/{roomId}/endrooms:write{ "ended": true }
POST /v1/rooms/{roomId}/tokenstokens:write参加者の認証情報セット
GET /v1/recordingsrecordings:read録画の配列
POST /v1/recordingsrecordings:write202、キューに入れられた録画
POST /v1/recordings/{recordingId}/stoprecordings:write{ "stopping": true }
POST /v1/recordings/{recordingId}/tracks/{trackId}/downloadrecordings:read一時的なダウンロードURL
POST /v1/recordings/{recordingId}/transcriptrecordings:write202、トランスクリプトがリクエストされます(文字起こし)
GET /v1/recordings/{recordingId}/transcriptrecordings:readJSON形式のトランスクリプト、または ?format=vtt, srt または txt
GET /v1/transcriptsrecordings:readトランスクリプトとそのステータス(テキストなし)
GET /v1/usage有効なプロジェクトキーであればどれでも完了した利用状況と利用枠
GET /v1/webhooks/endpoints, GET /v1/webhooks/deliverieswebhooks:readエンドポイントと配信ログ(Webhook)
POST, PATCH /v1/webhooks/endpoints…、再生およびテストwebhooks:writeエンドポイントの管理(Webhook)
POST /v1/joinなし(参加トークン)参加者の認証情報セット (参加トークン)
GET /v1/error-codesなしこの エラーコード一覧

成功したレスポンスでは、 200 特に断りがない限り。名前付きスコープのない 両方の読み取りルートにおいても、有効で有効期限が切れていないプロジェクトキーとサービスへのアクセス権が必要です。

GET /v1/projects は、そのキーに関連付けられたプロジェクトのみを返します。プロジェクトの 作成はコンソールで行われます。

について POST /v1/rooms、送信:

{
"projectId": "00000000-0000-4000-8000-000000000001",
"name": "Customer conversation",
"maxParticipants": 4
}

projectId および name が必要です。 maxParticipants はオプションで、デフォルトは 8 ですが、ご利用のプランの許容範囲内で 2 以上の整数である必要があります。プランでデフォルト値が許可されていない場合は、 明示的に小さい値を設定してください。応答には 新しいルームの id, projectId, name, maxParticipants, status (open)、および createdAt.

GET /v1/rooms は、キーのプロジェクトルームを一覧表示します。ルームを終了するには、 POST /v1/rooms/{roomId}/end、本文なしです。終了すると、新しい参加がブロックされ、 アクティブなセッションが切断されます。また、アクティブな録画ジョブの停止も要求されます。 終了したルームに対してこの操作を繰り返すと、 404;これは冪等性のない 成功レスポンスです。現在、ルームの名称変更、再開、削除を行うメソッドは存在しません。

POST /v1/rooms/{roomId}/tokens は、オプションの JSON オブジェクトを受け付けます:

{ "canPublish": false }

canPublish のデフォルト値は true。これを false 受信専用クライアントの場合は、を使用してください。 ルームは開いており、キーのプロジェクト内にある必要があります。応答には以下が含まれます:

フィールド意味
token機密性が高く、有効期間が短い参加者トークン
participantIdこの参加に割り当てられた識別子
expiresIn参加資格情報の有効期間(秒単位)。現在は 300 です。
urlクライアント用のシグナリングURL
iceServersICEの設定(一時的な中継認証情報を含む)

参加および再接続のたびに、新しい認証情報をリクエストしてください。トークンの発行をもって 参加が成功したと推測しないでください。参加時には、ルームの状態、収容人数、および認証も 確認されます。詳しくは 完全なクライアントフロー.

まず、 POST /v1/recordings および { "roomId": "ROOM_UUID" }。 202 レスポンスには録画データが含まれます id および status: "queued";これは、 ダウンロード可能なファイルがすでに存在することを意味するものではありません。同じ ルームに対して重複するアクティブな録画がある場合は、 409.

GET /v1/recordings は、プロジェクトでフィルタリングされたジョブを返します。これには、それらの id, roomId, status、および tracks。トラックのメタデータには以下が含まれます id, kind, source, participantId、および bytes。RTCから返されるトラックIDを使用してください。

キューに登録されたジョブまたは録画中のジョブを停止するには、 POST /v1/recordings/{recordingId}/stop、本文なし。リストをポーリングするか、 recording.ready 完了を判断するための Webhook。すでに 処理中、準備完了、または失敗しているジョブは、アクティブな停止対象ではなく、 404.

レディ状態のトラックに対しては、そのトラックにPOSTリクエストを送信してください /download ルート。応答は { "url": "TEMPORARY_DOWNLOAD_URL", "expiresIn": 300 }。返された URLをそのまま取得して、添付ファイルのデータをダウンロードしてください。URL自体は有効期限までアクセスを許可する ものですので、認証情報と同様に扱ってください。これは 使用しない 公開の永続リンク。 参照 記録のセキュリティと形式.

GET /v1/usage 返される内容:

フィールド意味
participantSeconds対象範囲内の完了した参加者セッションの合計期間
sessions対象範囲内の完了した接続数
periodall-time これらのアクティビティカウンターについて
billingStatus一元管理された課金を示します
quotasワークスペースの RTC 機能に関する現在の権限決定

参加者の秒数を60で割ると、参加者の分数が表示されます。これらのアクティビティ カウンターは、請求書やリアルタイムの参加者数ではありません。プロジェクトキーは アクティビティをそのプロジェクトにフィルタリングしますが、許容量は所有するワークスペースに属します。 課金使用量は非同期で更新される場合があります。サブスクリプション および請求書情報については、中央の課金システムをご利用ください。

エラーが発生した場合は、JSONが返されます error 文字列および安定した code、これも X-Error-Code ヘッダー。送信 RTC-Version: 2026-11-01 構造化されたエラー エンベロープについては、以下を参照してください。 エラー シェイプおよびコードカタログについては、 レート制限 for 429、および バージョン管理 以下の 変更の可能性について /v1。メッセージの正確な文言に依存しないでください。

ステータス確認またはアクション
400必須フィールド、UUID、不明なフィールド、または入力範囲
401認証情報が欠落している、無効である、取り消されている、または有効期限が切れている
403キーのスコープ、プロジェクトへのアクセス、プランの権限、または割り当て
404リソースが存在しない、範囲外である、または必要な状態になっていない
409アクティブな記録など、競合する操作
413リクエスト本文がサイズ制限を超えています
429レート制限;バックオフを行い、制限を遵守してください Retry-After 提供された場合
5xx一時的なサービス障害です。バックオフを適用して読み取りを再試行し、書き込みを調整してください

アクセス拒否とリソースの不在を区別するために、他の顧客のリソースを調査してはいけません。 以下の手順に従ってください。 トラブルシューティングのガイダンス.