Перейти к содержимому

Authentication

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

Вкладка API-ключей в настройках с кнопкой создания ключа

https://api.recordmeeting.com/v1

Пути эндпоинтов в этом справочнике указаны с префиксом /v1, например GET /v1/recordings. Добавляйте их к https://api.recordmeeting.com.

Передавайте 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_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Ошибка на стороне сервера
  • Recordings: список, чтение, обновление и удаление записей, чтение транскриптов, создание ссылок для общего доступа
  • Organizations: организации, папки и участники
  • Эндпоинты API Keys: создание, просмотр списка и отзыв ключей