SendOTPMessageRequestParameters

import type { SendOTPMessageRequestParameters } from "https://aws-api.deno.dev/v0.4/services/pinpoint.ts?docs=full";

Send OTP message request parameters.

interface SendOTPMessageRequestParameters {

AllowedAttempts?: number | null;

BrandName: string;

Channel: string;

CodeLength?: number | null;

DestinationIdentity: string;

EntityId?: string | null;

Language?: string | null;

OriginationIdentity: string;

ReferenceId: string;

TemplateId?: string | null;

ValidityPeriod?: number | null;

}

§Properties

AllowedAttempts?: number | null

The attempts allowed to validate an OTP.

BrandName: string

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

Channel: string

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

CodeLength?: number | null

The number of characters in the generated OTP.

DestinationIdentity: string

The destination identity to send OTP to.

EntityId?: string | null

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

Language?: string | null

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

OriginationIdentity: string

The origination identity used to send OTP from.

ReferenceId: string

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

TemplateId?: string | null

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

ValidityPeriod?: number | null

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