跳转到内容

认证

发往 Record Meeting API 的每个请求都需要一个 API 密钥。你可以在应用的 Settings ➤ API keys 中创建密钥。

Settings 的 API keys 标签页,带有 Create key 按钮

https://api.recordmeeting.com/v1

本参考文档中的端点路径都带有 /v1 前缀,例如 GET /v1/recordings。请将它们拼接在 https://api.recordmeeting.com 之后。

在 Authorization 请求头中发送你的 API 密钥。密钥以 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服务端错误
  • 录制:列出、读取、更新和删除录制,读取转录,创建分享链接
  • 组织:组织、文件夹和成员
  • API 密钥端点:创建、列出和吊销密钥