Одноразовый код (OTP)¶

Общие правила чтения полей, причины отказа и форматы файлов full/light описаны в обзоре.

Родитель: otp_results[]. Все сохранённые записи подтверждения телефона, от новых к старым. Пустой массив означает отсутствие записей.

Поля элемента otp_results[].

Поля с пометкой «Обязателен» присутствуют всегда внутри этого объекта. Остальные поля — при наличии значения; null исключается из ответа.

Поле	Тип в JSON	Назначение и условия
`phone_number`	string	Обязателен. Телефон подтверждения, до 20 символов.
`provider`	string, enum	Обязателен. Сейчас единственное значение — `telegram`.
`status`	string, enum	Обязателен. Значения ниже.
`result`	boolean	Сохранённый результат технологии: `true` — принята, `false` — отрицательный результат. До расчёта может отсутствовать; учитывайте статус и особенности ниже.
`failure_reason`	object	Причина отказа, если записана; структура.

Значения otp_results[].status.

Не путайте нижний регистр этих статусов с верхним регистром статусов сессии.

Поле	Тип в JSON	Назначение и условия
`pending`	string	Ожидается подтверждение кодом.
`wrong_code`	string	Предоставлен неверный код; это состояние не обязательно исчерпывает возможность повторной попытки.
`verified`	string	Код подтверждён.
`failed`	string	Подтверждение завершилось ошибкой.
`expired`	string	Срок подтверждения истёк.
`cancelled`	string	Подтверждение отменено.

Сам OTP-код, число попыток и идентификатор запроса поставщика не возвращаются. Последующая попытка может изменить существующую запись или добавить новую согласно сценарию.

JSON-примеры¶

Фрагменты корневого объекта ответа, а не целостные ответы. Все значения и ссылки условные. Формат файлов соответствует пояснениям на этой странице.

{
  "otp_results": [
    {
      "phone_number": "+70000000000",
      "provider": "telegram",
      "status": "verified",
      "result": true
    }
  ]
}