Interface SmsOptions

An optional object for SMS Verification, with default values assumed for all contained values if not provided.

interface SmsOptions {
    codeType?: CodeType;
    expiry?: string | Date;
    locale?: string;
    template?: string;
}

Properties

codeType?: CodeType

Accepted values for the type of code to be generated are Numeric, Alpha, and Alphanumeric. Default is Numeric.

expiry?: string | Date

The expiration time for a verification process is represented in the format HH:MM:SS.

locale?: string

A language-region identifier according to IANA. Only a subset of those identifiers is accepted.

template?: string

The SMS template must include a placeholder {{CODE}} where the verification code will be inserted, and it can otherwise be customized as desired.