Package com.sinch.sdk.domains.verification.models.v1.start.request

Interface VerificationStartRequestSms

All Superinterfaces:
VerificationStartRequest
public interface VerificationStartRequestSms extends VerificationStartRequest
VerificationStartRequestSms

  • Method Details

    • getIdentity

      Identity getIdentity()
      Get identity
      Specified by:
      getIdentity in interface VerificationStartRequest
      Returns:
      identity

    • getReference

      String getReference()
      Used to pass your own reference in the request for tracking purposes.
      Specified by:
      getReference in interface VerificationStartRequest
      Returns:
      reference

    • getCustom

      String getCustom()
      Can be used to pass custom data in the request.
      Specified by:
      getCustom in interface VerificationStartRequest
      Returns:
      custom

    • getExpiry

      String getExpiry()
      The expiration time for a verification process is represented in the format HH:MM:SS .
      Returns:
      expiry

    • getCodeType

      VerificationStartRequestSms.CodeTypeEnum getCodeType()
      Accepted values for the type of code to be generated are Numeric, Alpha, and Alphanumeric.
      Returns:
      codeType

    • getTemplate

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

    • getAcceptLanguage

      String getAcceptLanguage()
      In SMS Verification, value of Accept-Language header is used to determine the language of an SMS message.
      Returns:
      acceptLanguage

    • getExtraOption

      Object getExtraOption(String key)
      Return the additional "smsOptions" with the specified name.
      Parameters:
      key - the name of the property
      Returns:
      the additional property with the specified name

    • builder

      static VerificationStartRequestSms.Builder builder()
      Getting builder
      Returns:
      New Builder instance