itd-api / AccountPhoneResource
Interface: AccountPhoneResource
Defined in: resources/account/phone.ts:46
Привязка и смена номера текущего аккаунта.
Extends
BaseResource
Methods
attach()
attach(input, options?): Promise<PhoneFlowStart>;Defined in: resources/account/phone.ts:69
Запрашивает подтверждение номера для привязки.
Передайте номер в международном формате с +. Если токен капчи не передан в вызов, SDK использует настроенный источник капчи. Для исходящего звонка передайте method: PhoneVerificationMethod.Reverse.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneFlowStart>
параметры доставки и flowToken для verifyAttach
Example
const { flowToken } = await itd.account.phone.attach({ phone });
await itd.account.phone.verifyAttach({ phone, flowToken, otp: await getOtp() });resendOtp()
resendOtp(input, options?): Promise<PhoneDelivery>;Defined in: resources/account/phone.ts:116
Повторно запрашивает код для того же номера. Передайте flowToken из первого запроса.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneDelivery>
актуальные канал, длину кода и паузу до повтора в секундах
reverseAttachComplete()
reverseAttachComplete(input, options?): Promise<ContactActionResult>;Defined in: resources/account/phone.ts:153
Завершает привязку номера после исходящего звонка.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<ContactActionResult>
reverseChangeComplete()
reverseChangeComplete(input, options?): Promise<ContactChange>;Defined in: resources/account/phone.ts:166
Подтверждает новый номер звонком и возвращает варианты завершения смены.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<ContactChange>
reverseOptions()
reverseOptions(input, options?): Promise<PhoneReverseOptions>;Defined in: resources/account/phone.ts:126
Возвращает доступность исходящего звонка для привязки или смены номера.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneReverseOptions>
reverseStart()
reverseStart(input, options?): Promise<PhoneReverseStatus>;Defined in: resources/account/phone.ts:138
Подготавливает номер, на который должен позвонить пользователь.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneReverseStatus>
состояние попытки, номер для звонка и срок действия в секундах
reverseStatus()
reverseStatus(input, options?): Promise<PhoneReverseStatus>;Defined in: resources/account/phone.ts:148
Читает состояние исходящего звонка.
После подтверждения вызовите reverseAttachComplete при привязке или reverseChangeComplete при смене номера.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneReverseStatus>
startChange()
startChange(input, options?): Promise<PhoneFlowStart>;Defined in: resources/account/phone.ts:80
Запрашивает подтверждение нового номера для смены.
Формат номера, источник капчи и выбор способа подтверждения такие же, как у attach.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PhoneFlowStart>
параметры доставки и flowToken для verifyChange
sync()
sync(options?): Promise<ContactActionResult>;Defined in: resources/account/phone.ts:121
Синхронизирует привязанный номер с профилем.
Parameters
options?
RequestOptions = {}
Returns
Promise<ContactActionResult>
verifyAttach()
verifyAttach(input, options?): Promise<ContactActionResult>;Defined in: resources/account/phone.ts:92
Завершает привязку номера кодом.
Передайте номер и flowToken из attach.
Parameters
input
PhoneFlowInput & object
options?
RequestOptions = {}
Returns
Promise<ContactActionResult>
verifyChange()
verifyChange(input, options?): Promise<ContactChange>;Defined in: resources/account/phone.ts:104
Подтверждает код нового номера, запрошенный через startChange.
Parameters
input
PhoneFlowInput & object
options?
RequestOptions = {}
Returns
Promise<ContactChange>
changeToken и способы завершить смену через itd.account.changes