{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-send-otp-message-request-parameters-schema.json", "title": "SendOTPMessageRequestParameters", "description": "Send OTP message request parameters.", "type": "object", "properties": { "AllowedAttempts": { "allOf": [ { "$ref": "#/components/schemas/__integer" }, { "description": "The attempts allowed to validate an OTP." } ] }, "BrandName": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account." } ] }, "Channel": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "Channel type for the OTP message. Supported values: [SMS]." } ] }, "CodeLength": { "allOf": [ { "$ref": "#/components/schemas/__integer" }, { "description": "The number of characters in the generated OTP." } ] }, "DestinationIdentity": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The destination identity to send OTP to." } ] }, "EntityId": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "A unique Entity ID received from DLT after entity registration is approved." } ] }, "Language": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The language to be used for the outgoing message body containing the OTP." } ] }, "OriginationIdentity": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "The origination identity used to send OTP from." } ] }, "ReferenceId": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "Developer-specified reference identifier. Required to match during OTP verification." } ] }, "TemplateId": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "description": "A unique Template ID received from DLT after entity registration is approved." } ] }, "ValidityPeriod": { "allOf": [ { "$ref": "#/components/schemas/__integer" }, { "description": "The time in minutes before the OTP is no longer valid." } ] } }, "required": [ "BrandName", "ReferenceId", "Channel", "DestinationIdentity", "OriginationIdentity" ] }