Коды ответа
Успешный запрос
- Если запрос был обработан без ошибок, ваш API должен отвечать кодом 200 OK.
Если во время выполнения запроса произошла ошибка, связанная с устройствами, ваш API должен отвечать HTTP-кодом 200 ОК и одним из поддерживаемых кодов. Код передавайте в параметре
error_code
, а описание ошибки — в параметреerror_message
.
Код ошибки | Краткое описание | Текст ошибки в приложении | Фраза Алисы | Пример возникновения ошибки |
---|---|---|---|---|
DOOR_OPEN | Открыта дверца | Не забудьте закрыть дверцу. | Ой, кажется, открыта дверца. Закройте её и повторите команду. | Запуск стирки при неплотно закрытой дверце стиральной машинки |
LID_OPEN | Открыта крышка | Не забудьте закрыть крышку. | Упс, кажется, вы забыли закрыть крышку. Закройте её и повторите команду. | Запуск программы приготовления на мультиварке с открытой крышкой |
REMOTE_CONTROL_DISABLED | Удаленное управление устройством отключено | Сначала нужно спросить разрешения у самого устройства: проверьте, на нём должна быть специальная кнопка. | Сначала нужно спросить разрешения у самого устройства: проверьте, на нём должна быть специальная кнопка. | Управление устройством, у которого отключена функция удаленного управления |
NOT_ENOUGH_WATER | Недостаточно воды | Попробуйте долить воды. | Ой, недостаточно воды. Долейте её и повторите команду. | Запуск чайника или увлажнителя без воды |
LOW_CHARGE_LEVEL | Низкий уровень заряда | Устройство нужно зарядить. | Кажется, устройство разрядилось. Пожалуйста, повторите после зарядки. | Запуск робота-пылесоса с разряженной батареей |
CONTAINER_FULL | Контейнер полон | Сначала нужно очистить контейнер. | Кажется, контейнер переполнился. Очистите его и повторите команду. | Запуск робота-пылесоса с переполненным контейнером для пыли. Запуск кофеварки с переполненным контейнером для отработанного кофе |
CONTAINER_EMPTY | Контейнер пуст | В контейнер нужно что-нибудь положить. | Ой, кажется, вы забыли положить кофе — контейнер пуст. Наполните его и повторите команду. | Запуск кофеварки с пустым контейнером для зерен |
DRIP_TRAY_FULL | Сливной поддон полон | Нужно очистить поддон. | Заполнился сливной поддон. Очистите и повторите команду. | Запуск кофеварки с переполненным сливным поддоном |
DEVICE_STUCK | Устройство застряло | Кажется, на пути препятствие, его нужно убрать. | Аларм, возникло препятствие! Пожалуйста, устраните его. | Команда застрявшему роботу-пылесосу |
DEVICE_OFF | Устройство выключено | Сначала нужно включить устройство. | Ой, не получается. Сначала включите устройство. | Команда выключенному устройству. Если устройство отключено от электричества или от сети интернет, используйте код ошибки DEVICE_UNREACHABLE |
FIRMWARE_OUT_OF_DATE | Прошивка устарела | Нужно обновить прошивку устройства, которым хотите управлять. | Не могу запустить без обновления. Пожалуйста, обновите прошивку вашему устройству (речь не обо мне). | Команда устройству с устаревшей версией прошивки, которая не позволяет выполнить указанную команду |
NOT_ENOUGH_DETERGENT | Недостаточно моющего средства | Добавьте моющее средство. | Я бы рада, да закончилось моющее средство. Добавьте его и повторите команду. | Запуск посудомоечной машины без моющего средства |
HUMAN_INVOLVEMENT_NEEDED | Требуется вмешательство человека | Что-то не так с устройством: пожалуйста, осмотрите его. | Кажется, что-то пошло не так. Для устранения ошибки нужна ваша помощь. | Запуск стиральной машины с перегруженным барабаном. |
DEVICE_UNREACHABLE | Устройство недоступно | Устройство не отвечает. Проверьте, вдруг оно выключено или пропал интернет. | Не вижу устройства, проверьте, пожалуйста, его подключение. | Запуск устройства, отключенного от электричества или от сети интернет |
DEVICE_BUSY | Устройство занято | Устройство уже работает. Подождите, пока оно закончит. | Прямо сейчас устройство занято, попробуйте позднее. | Команда стиральной машине, которая уже выполняет программу стирки |
INTERNAL_ERROR | Неизвестная внутренняя ошибка | Случилось что-то непонятное. Подождите немного и попробуйте ещё раз. | Что-то пошло не так. Подождите немного и попробуйте снова. | Любая неклассифицируемая ошибка на стороне платформы партнера |
INVALID_ACTION | Недопустимое действие | Это устройство так не умеет. Попробуйте что-нибудь другое. | Устройство сообщает мне, что оно этого не умеет. | Команда изменения яркости света на стиральной машине без соответствующего умения |
INVALID_VALUE | Недопустимое значение | Какое-то незнакомое значение. Попробуйте другое. | Не нахожу такой возможности, увы. | Команда на установку значения вне допустимого диапазона — включение 150-го канала на телевизоре при доступных 100 |
NOT_SUPPORTED_IN_CURRENT_MODE | Не поддерживается в текущем режиме работы устройства | В этом режиме такая команда не работает. | В текущем режиме это невозможно. | Команда на изменение температуры кондиционера, находящегося в режиме вентиляции (в данном режиме охлаждение или нагрев воздуха не происходит) |
ACCOUNT_LINKING_ERROR | Ошибка в OAuth2 токене пользователя | Попробуйте привязать устройство заново, а то оно отвязалось. | Устройство отвязалось, необходимо снова связать аккаунты в приложении Яндекса. | Попытка управлять устройством с просроченным или инвалидированным OAuth2 токеном |
DEVICE_NOT_FOUND | Устройство не найдено | Данное устройство вам не принадлежит. | Не могу найти такое устройство. | Пользователь удалил устройство в приложении производителя |
Код ошибки | Краткое описание | Текст ошибки в приложении | Фраза Алисы | Пример возникновения ошибки |
---|---|---|---|---|
DOOR_OPEN | Открыта дверца | Не забудьте закрыть дверцу. | Ой, кажется, открыта дверца. Закройте её и повторите команду. | Запуск стирки при неплотно закрытой дверце стиральной машинки |
LID_OPEN | Открыта крышка | Не забудьте закрыть крышку. | Упс, кажется, вы забыли закрыть крышку. Закройте её и повторите команду. | Запуск программы приготовления на мультиварке с открытой крышкой |
REMOTE_CONTROL_DISABLED | Удаленное управление устройством отключено | Сначала нужно спросить разрешения у самого устройства: проверьте, на нём должна быть специальная кнопка. | Сначала нужно спросить разрешения у самого устройства: проверьте, на нём должна быть специальная кнопка. | Управление устройством, у которого отключена функция удаленного управления |
NOT_ENOUGH_WATER | Недостаточно воды | Попробуйте долить воды. | Ой, недостаточно воды. Долейте её и повторите команду. | Запуск чайника или увлажнителя без воды |
LOW_CHARGE_LEVEL | Низкий уровень заряда | Устройство нужно зарядить. | Кажется, устройство разрядилось. Пожалуйста, повторите после зарядки. | Запуск робота-пылесоса с разряженной батареей |
CONTAINER_FULL | Контейнер полон | Сначала нужно очистить контейнер. | Кажется, контейнер переполнился. Очистите его и повторите команду. | Запуск робота-пылесоса с переполненным контейнером для пыли. Запуск кофеварки с переполненным контейнером для отработанного кофе |
CONTAINER_EMPTY | Контейнер пуст | В контейнер нужно что-нибудь положить. | Ой, кажется, вы забыли положить кофе — контейнер пуст. Наполните его и повторите команду. | Запуск кофеварки с пустым контейнером для зерен |
DRIP_TRAY_FULL | Сливной поддон полон | Нужно очистить поддон. | Заполнился сливной поддон. Очистите и повторите команду. | Запуск кофеварки с переполненным сливным поддоном |
DEVICE_STUCK | Устройство застряло | Кажется, на пути препятствие, его нужно убрать. | Аларм, возникло препятствие! Пожалуйста, устраните его. | Команда застрявшему роботу-пылесосу |
DEVICE_OFF | Устройство выключено | Сначала нужно включить устройство. | Ой, не получается. Сначала включите устройство. | Команда выключенному устройству. Если устройство отключено от электричества или от сети интернет, используйте код ошибки DEVICE_UNREACHABLE |
FIRMWARE_OUT_OF_DATE | Прошивка устарела | Нужно обновить прошивку устройства, которым хотите управлять. | Не могу запустить без обновления. Пожалуйста, обновите прошивку вашему устройству (речь не обо мне). | Команда устройству с устаревшей версией прошивки, которая не позволяет выполнить указанную команду |
NOT_ENOUGH_DETERGENT | Недостаточно моющего средства | Добавьте моющее средство. | Я бы рада, да закончилось моющее средство. Добавьте его и повторите команду. | Запуск посудомоечной машины без моющего средства |
HUMAN_INVOLVEMENT_NEEDED | Требуется вмешательство человека | Что-то не так с устройством: пожалуйста, осмотрите его. | Кажется, что-то пошло не так. Для устранения ошибки нужна ваша помощь. | Запуск стиральной машины с перегруженным барабаном. |
DEVICE_UNREACHABLE | Устройство недоступно | Устройство не отвечает. Проверьте, вдруг оно выключено или пропал интернет. | Не вижу устройства, проверьте, пожалуйста, его подключение. | Запуск устройства, отключенного от электричества или от сети интернет |
DEVICE_BUSY | Устройство занято | Устройство уже работает. Подождите, пока оно закончит. | Прямо сейчас устройство занято, попробуйте позднее. | Команда стиральной машине, которая уже выполняет программу стирки |
INTERNAL_ERROR | Неизвестная внутренняя ошибка | Случилось что-то непонятное. Подождите немного и попробуйте ещё раз. | Что-то пошло не так. Подождите немного и попробуйте снова. | Любая неклассифицируемая ошибка на стороне платформы партнера |
INVALID_ACTION | Недопустимое действие | Это устройство так не умеет. Попробуйте что-нибудь другое. | Устройство сообщает мне, что оно этого не умеет. | Команда изменения яркости света на стиральной машине без соответствующего умения |
INVALID_VALUE | Недопустимое значение | Какое-то незнакомое значение. Попробуйте другое. | Не нахожу такой возможности, увы. | Команда на установку значения вне допустимого диапазона — включение 150-го канала на телевизоре при доступных 100 |
NOT_SUPPORTED_IN_CURRENT_MODE | Не поддерживается в текущем режиме работы устройства | В этом режиме такая команда не работает. | В текущем режиме это невозможно. | Команда на изменение температуры кондиционера, находящегося в режиме вентиляции (в данном режиме охлаждение или нагрев воздуха не происходит) |
ACCOUNT_LINKING_ERROR | Ошибка в OAuth2 токене пользователя | Попробуйте привязать устройство заново, а то оно отвязалось. | Устройство отвязалось, необходимо снова связать аккаунты в приложении Яндекса. | Попытка управлять устройством с просроченным или инвалидированным OAuth2 токеном |
DEVICE_NOT_FOUND | Устройство не найдено | Данное устройство вам не принадлежит. | Не могу найти такое устройство. | Пользователь удалил устройство в приложении производителя |
Запрос с ошибкой
Платформа умного дома работает по протоколу HTTP и поддерживает все стандартные коды состояний. В отдельных случаях, рекомендуется использовать коды, описанные в таблице ниже.
Код ошибки | Описание | Пояснение |
---|---|---|
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Не передан авторизационный токен. |
403 | Forbidden |
|
404 | Not Found | Ресурс по указанному пути не найден. |
500 | Internal Server Error | Внутренняя ошибка сервера. |
Код ошибки | Описание | Пояснение |
---|---|---|
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Не передан авторизационный токен. |
403 | Forbidden |
|
404 | Not Found | Ресурс по указанному пути не найден. |
500 | Internal Server Error | Внутренняя ошибка сервера. |