Формат ошибок
Любая ошибка приходит в одном виде. code — для программы, он не меняется. message — для человека, по-русски. request_id — номер запроса для поддержки, он же в заголовке X-Request-Id.
Ответ 422
{
"error": {
"code": "validation_error",
"message": "Поле message обязательно.",
"details": { "field": "message" },
"request_id": "req_3f9c2a7d1e6b4a8c0d2e5f71"
}
}Коды
HTTP |
| Что случилось и что делать |
|---|---|---|
400 |
| Неверный параметр: курсор, |
400 |
| Тело — не JSON-объект. Проверьте |
401 |
| Нет ключа в заголовке |
401 |
| Ключ или токен не найден, отозван, сотрудник отключён |
401 |
| Срок ключа или токена истёк. Токен OAuth — обновите по |
402 |
| Лицензия компании закончилась. Первые три дня работает только чтение |
403 |
| У ключа нет права, оно — в |
403 |
| У сотрудника ключа нет права в кабинете |
404 |
| Объекта нет или он чужой — ответ одинаковый |
409 |
| Дубль клиента, подписка выключена, лимит подписок |
409 |
| Запрос с этим |
413 |
| Тело больше 256 КБ |
422 |
| Поле не прошло проверку, оно — в |
422 |
|
|
423 |
| Компания запросила удаление — новые действия остановлены |
429 |
| Лимит запросов, ждите |
500 |
| Сбой у нас. Повторите позже; если повторяется — напишите с |
Что повторять
Повторяйте
429послеRetry-After,5xxи обрывы сети — с тем жеIdempotency-Keyу POST (подробнее).Не повторяйте
4xx, кроме409 idempotency_in_progress: ответ не изменится, пока не исправите запрос.
Ошибки OAuth-эндпоинтов /api/oauth/token и /api/oauth/revoke — в формате RFC 6749: { "error", "error_description" } (токены).
