AWSPinpointTargetingSendOTPMessageRequestParameters

Objective-C

@interface AWSPinpointTargetingSendOTPMessageRequestParameters

Swift

class AWSPinpointTargetingSendOTPMessageRequestParameters

Send OTP message request parameters.

Required parameters: [BrandName, ReferenceId, Channel, DestinationIdentity, OriginationIdentity]

  • The attempts allowed to validate an OTP.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable allowedAttempts;

    Swift

    var allowedAttempts: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable brandName;

    Swift

    var brandName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable channel;

    Swift

    var channel: String? { get set }

  • The number of characters in the generated OTP.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable codeLength;

    Swift

    var codeLength: NSNumber? { get set }

  • The destination identity to send OTP to.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable destinationIdentity;

    Swift

    var destinationIdentity: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable entityId;

    Swift

    var entityId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable language;

    Swift

    var language: String? { get set }

  • The origination identity used to send OTP from.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable originationIdentity;

    Swift

    var originationIdentity: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable referenceId;

    Swift

    var referenceId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable templateId;

    Swift

    var templateId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable validityPeriod;

    Swift

    var validityPeriod: NSNumber? { get set }