コンテンツにスキップ

認証

Record Meeting API へのすべてのリクエストには API キーが必要です。キーはアプリの Settings ➤ API keys で作成します。

Create key ボタンがある Settings の API keys タブ

https://api.recordmeeting.com/v1

このリファレンスのエンドポイントパスは /v1 プレフィックス付きで記載されています。たとえば GET /v1/recordings です。これらを https://api.recordmeeting.com に追加してください。

API キーは Authorization ヘッダーで送信します。キーは sk_rm_ で始まります。

Authorization: Bearer sk_rm_your_key

キーを作成するには、ユーザーガイド ➤ API キー を参照してください。キーはアカウントと同じアクセス権を持ちます。自分のレコーディングと、閲覧を許可されている組織のレコーディングにアクセスできます。

Terminal window
curl "https://api.recordmeeting.com/v1/recordings" \
-H "Authorization: Bearer sk_rm_your_key"

成功時のレスポンスは JSON で、結果は data の下に格納されます。結果をページングするリスト系エンドポイントは pagination オブジェクトを追加します。レスポンスによっては "success": true も含まれます。

PATCH と DELETE リクエストは、成功すると空のボディで 204 No Content を返します。

すべてのエラーは次の形式です。

{
"error": {
"code": "ERROR_CODE",
"message": "Human readable description"
}
}

有効な Authorization ヘッダーのないリクエストには 401 が返ります。

コードHTTP ステータス意味
INVALID_API_KEY401キーが存在しないか、失効しています
API_KEY_EXPIRED401キーの有効期限が切れています
USER_NOT_FOUND401キーが属するアカウントがすでに存在しません
AUTH_ERROR401認証に失敗しました
コードHTTP ステータス意味
VALIDATION_ERROR400リクエストパラメータが無効、または不足しています
RECORDING_NOT_READY400レコーディングはまだ共有できません
ORGANIZATION_SUBSCRIPTION_EXPIRED402レコーディングを所有する組織に有効な Enterprise サブスクリプションがありません
FORBIDDEN403組織のメンバーではないか、要求した内容を閲覧する権限がありません
RECORDING_LOCKED403レコーディングはロックされています。開くにはアップグレードしてください
SUBSCRIPTION_REQUIRED403この操作には有料プランが必要です
TRANSCRIPT_NOT_AVAILABLE403組織またはメンバーで文字起こしが無効になっています
SHARING_DISABLED403組織またはメンバーで共有が無効になっています
RECORDING_NOT_FOUND404レコーディングが存在しないか、アクセスできません
INTERNAL_ERROR500サーバー側のエラー