Формат ошибки

Все ошибки возвращаются в виде JSON-объекта с полем detail:
При сбоях валидации запроса (статус 422) поле detail представляет собой массив ошибок на уровне отдельных полей:

HTTP-коды статуса


Ошибки валидации воркфлоу

При валидации воркфлоу (или создании воркфлоу с некорректными узлами) API возвращает структурированные ошибки, которые ссылаются на конкретные узлы, рёбра или поля:

Ошибки телефонии

Операции телефонии могут завершиться одним из следующих именованных типов ошибок, возвращаемых в поле detail:

Советы по обработке ошибок

  • Повторяйте запрос при 500 с экспоненциальной задержкой — временные ошибки сервера могут исчезнуть при повторной попытке.
  • Не повторяйте запрос при 4xx — это указывает на проблемы в самом запросе, которые не исчезнут сами по себе.
  • Внимательно проверяйте detail при 422 — массив loc точно указывает, какое поле не прошло валидацию.
  • Храните API-ключи в безопасности401 для ранее работавшего ключа, скорее всего, означает, что ключ был архивирован.