itd-api / PhoneAuthResource
Interface: PhoneAuthResource
Defined in: resources/auth/phone.ts:50
Телефонный вход и регистрация. Доступен как itd.auth.phone.
Extends
BaseResource
Methods
config()
config(options?): Promise<PhoneConfig>;Defined in: resources/auth/phone.ts:59
Разрешённые регионы, примеры номеров и доступные способы подтверждения.
Parameters
options?
RequestOptions = {}
Returns
Promise<PhoneConfig>
consent()
consent(options?): Promise<PhoneConsent>;Defined in: resources/auth/phone.ts:69
Загружает контекст phone_entry вместе с текстом и редакциями документов.
До start() покажите документы пользователю. Истёкший контекст и новые редакции библиотека не заменяет автоматически.
Parameters
options?
RequestOptions = {}
Returns
Promise<PhoneConsent>
password()
password(input, options?): Promise<string>;Defined in: resources/auth/phone.ts:160
Завершает вход облачным паролем после step: 'password'.
Передайте flowToken из этого шага. Полученный access token и cookies сохраняются автоматически, если владелец сессии не сменился во время запроса.
Parameters
input
PhoneFlowInput & object
options?
RequestOptions = {}
Returns
Promise<string>
resend()
resend(input, options?): Promise<PhoneDelivery>;Defined in: resources/auth/phone.ts:150
Запрашивает повторную доставку без изменения авторизации.
Используйте новый channel/codeLength из результата: способ доставки может измениться. retryIn — секунды до следующего запроса.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneDelivery>
resetPassword()
resetPassword(input, options?): Promise<string>;Defined in: resources/auth/phone.ts:168
Устанавливает новый пароль после подтверждения номера и сохраняет сессию.
Parameters
input
PhoneFlowInput & object
options?
RequestOptions = {}
Returns
Promise<string>
resume()
resume(__namedParameters, options?): Promise<PhoneFlowResume>;Defined in: resources/auth/phone.ts:116
Возобновляет незавершённую проверку номера.
Передайте номер и flowToken из start. Для следующих шагов используйте тот же токен и параметры доставки из ответа.
Parameters
__namedParameters
options?
RequestOptions = {}
Returns
Promise<PhoneFlowResume>
reverseComplete()
reverseComplete(input, options?): Promise<PhoneLoginResult>;Defined in: resources/auth/phone.ts:199
Завершает подтверждённый звонок; сервер может потребовать облачный пароль.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneLoginResult>
reverseOptions()
reverseOptions(input, options?): Promise<PhoneReverseOptions>;Defined in: resources/auth/phone.ts:176
Проверяет, доступен ли исходящий звонок для подтверждения номера.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneReverseOptions>
reverseStart()
reverseStart(input, options?): Promise<PhoneReverseStatus>;Defined in: resources/auth/phone.ts:189
Подготавливает номер, на который пользователь должен позвонить.
Может выделить новую попытку; не повторяется после сетевых ошибок и 5xx. Номер и срок его действия возвращаются в phone и expiresIn.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneReverseStatus>
reverseStatus()
reverseStatus(input, options?): Promise<PhoneReverseStatus>;Defined in: resources/auth/phone.ts:194
Читает состояние звонка через POST, без завершения входа и смены сессии.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneReverseStatus>
start()
start(input, options?): Promise<PhoneFlowStart>;Defined in: resources/auth/phone.ts:85
Запрашивает подтверждение номера для входа или регистрации.
Токен капчи отправляется объектом { provider, token }.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneFlowStart>
flowToken для продолжения входа, канал доставки, длина кода и пауза повтора в секундах
verify()
verify(input, options?): Promise<PhoneLoginResult>;Defined in: resources/auth/phone.ts:137
Подтверждает код без email и пароля.
При accessToken сохраняет новую сессию; при step: 'password' возвращает секрет для password().
Parameters
input
PhoneFlowInput & object
options?
RequestOptions = {}
Returns
Promise<PhoneLoginResult>