Stytch Android/com.stytch.sdk.consumer.otp/OTP/SmsOTP

SmsOTP

interface SmsOTP

Provides all possible ways to call SMS OTP endpoints

Types

Link copied to clipboard
data class Parameters(val phoneNumber: String, val expirationMinutes: UInt = DEFAULT_OTP_EXPIRATION_TIME_MINUTES) : Parcelable

Data class used for wrapping parameters used with SMS OTP

Functions

Link copied to clipboard
abstract suspend fun loginOrCreate(parameters: OTP.SmsOTP.Parameters): LoginOrCreateOTPResponse
abstract fun loginOrCreate(parameters: OTP.SmsOTP.Parameters, callback: (LoginOrCreateOTPResponse) -> Unit)

Send a one-time passcode (OTP) to a user using their phone number via SMS. If the phone number is not associated with a user already, a user will be created.

Link copied to clipboard
abstract suspend fun send(parameters: OTP.SmsOTP.Parameters): OTPSendResponse
abstract fun send(parameters: OTP.SmsOTP.Parameters, callback: (OTPSendResponse) -> Unit)

Send a one-time passcode (OTP) to a user's phone number via SMS. If you'd like to create a user and send them a passcode with one request, use our loginOrCreate method.