Authentication
Каждый запрос к Record Meeting API требует API-ключа. Ключи создаются в приложении в разделе Настройки ➤ API-ключи.

Базовый URL
Заголовок раздела «Базовый URL»https://api.recordmeeting.com/v1Пути эндпоинтов в этом справочнике указаны с префиксом /v1, например GET /v1/recordings. Добавляйте их к https://api.recordmeeting.com.
Аутентификация по API-ключу
Заголовок раздела «Аутентификация по API-ключу»Передавайте API-ключ в заголовке Authorization. Ключи начинаются с sk_rm_.
Authorization: Bearer sk_rm_your_keyО том, как создать ключ, см. в разделе Руководство пользователя ➤ API-ключи. Ключ имеет те же права доступа, что и ваш аккаунт: ваши собственные записи и записи организации, которые вам разрешено видеть.
Пример запроса
Заголовок раздела «Пример запроса»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_KEY | 401 | Ключ не существует или был отозван |
API_KEY_EXPIRED | 401 | Срок действия ключа истёк |
USER_NOT_FOUND | 401 | Аккаунт, которому принадлежит ключ, больше не существует |
AUTH_ERROR | 401 | Не удалось пройти аутентификацию |
Общие коды ошибок
Заголовок раздела «Общие коды ошибок»| Код | HTTP-статус | Значение |
|---|---|---|
VALIDATION_ERROR | 400 | Недопустимые или отсутствующие параметры запроса |
RECORDING_NOT_READY | 400 | Запись пока нельзя сделать общей |
ORGANIZATION_SUBSCRIPTION_EXPIRED | 402 | У организации, владеющей записью, больше нет активной подписки Enterprise |
FORBIDDEN | 403 | Вы не являетесь участником организации или не имеете доступа к запрошенному |
RECORDING_LOCKED | 403 | Запись заблокирована. Обновите план, чтобы открыть её |
SUBSCRIPTION_REQUIRED | 403 | Для этого действия нужен платный план |
TRANSCRIPT_NOT_AVAILABLE | 403 | Транскрипция отключена для организации или участника |
SHARING_DISABLED | 403 | Общий доступ отключён для организации или участника |
RECORDING_NOT_FOUND | 404 | Запись не существует или у вас нет к ней доступа |
INTERNAL_ERROR | 500 | Ошибка на стороне сервера |
Эндпоинты
Заголовок раздела «Эндпоинты»- Recordings: список, чтение, обновление и удаление записей, чтение транскриптов, создание ссылок для общего доступа
- Organizations: организации, папки и участники
- Эндпоинты API Keys: создание, просмотр списка и отзыв ключей