Skip to content

SendOTPMessageRequestParameters

Used by
Source code in docs_src/capo_pinpoint/types/send_otp_message_request_parameters.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class SendOTPMessageRequestParameters(TypedDict, closed=True):
    allowed_attempts: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The attempts allowed to validate an OTP.</p>"""
    brand_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.</p>"""
    channel: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>Channel type for the OTP message. Supported values: [SMS].</p>"""
    code_length: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The number of characters in the generated OTP.</p>"""
    destination_identity: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The destination identity to send OTP to.</p>"""
    entity_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>A unique Entity ID received from DLT after entity registration is approved.</p>"""
    language: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The language to be used for the outgoing message body containing the OTP.</p>"""
    origination_identity: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The origination identity used to send OTP from.</p>"""
    reference_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>Developer-specified reference identifier. Required to match during OTP verification.</p>"""
    template_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>A unique Template ID received from DLT after entity registration is approved.</p>"""
    validity_period: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The time in minutes before the OTP is no longer valid.</p>"""

allowed_attempts instance-attribute 

allowed_attempts: NotRequired[__integer]

The attempts allowed to validate an OTP.

brand_name instance-attribute 

brand_name: NotRequired[__string]

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

channel instance-attribute 

channel: NotRequired[__string]

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

code_length instance-attribute 

code_length: NotRequired[__integer]

The number of characters in the generated OTP.

destination_identity instance-attribute 

destination_identity: NotRequired[__string]

The destination identity to send OTP to.

entity_id instance-attribute 

entity_id: NotRequired[__string]

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

language instance-attribute 

language: NotRequired[__string]

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

origination_identity instance-attribute 

origination_identity: NotRequired[__string]

The origination identity used to send OTP from.

reference_id instance-attribute 

reference_id: NotRequired[__string]

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

template_id instance-attribute 

template_id: NotRequired[__string]

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

validity_period instance-attribute 

validity_period: NotRequired[__integer]

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