pinpoint/aws.sdk.kotlin.services.pinpoint.model/SendOtpMessageRequestParameters

SendOtpMessageRequestParameters

class SendOtpMessageRequestParameters

Send OTP message request parameters.

Types

Builder

class Builder

Companion

object Companion

Properties

allowedAttempts

val allowedAttempts: Int?

The attempts allowed to validate an OTP.

brandName

val brandName: String?

The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.

channel

val channel: String?

Channel type for the OTP message. Supported values: [SMS].

codeLength

val codeLength: Int?

The number of characters in the generated OTP.

destinationIdentity

val destinationIdentity: String?

The destination identity to send OTP to.

entityId

val entityId: String?

A unique Entity ID received from DLT after entity registration is approved.

language

val language: String?

The language to be used for the outgoing message body containing the OTP.

originationIdentity

val originationIdentity: String?

The origination identity used to send OTP from.

referenceId

val referenceId: String?

Developer-specified reference identifier. Required to match during OTP verification.

templateId

val templateId: String?

A unique Template ID received from DLT after entity registration is approved.

validityPeriod

val validityPeriod: Int?

The time in minutes before the OTP is no longer valid.

Functions

copy

inline fun copy(block: SendOtpMessageRequestParameters.Builder.() -> Unit = {}): SendOtpMessageRequestParameters

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String