public static final class SendSmsVerifyCodeRequest.Builder extends Object
| 限定符和类型 | 方法和说明 |
|---|---|
SendSmsVerifyCodeRequest.Builder |
autoRetry(Long autoRetry)
AutoRetry.
|
SendSmsVerifyCodeRequest |
build() |
SendSmsVerifyCodeRequest.Builder |
codeLength(Long codeLength)
The length of the verification code.
|
SendSmsVerifyCodeRequest.Builder |
codeType(Long codeType)
The type of the generated verification code.
|
SendSmsVerifyCodeRequest.Builder |
countryCode(String countryCode)
The country code of the phone number.
|
SendSmsVerifyCodeRequest.Builder |
duplicatePolicy(Long duplicatePolicy)
Specifies how to handle the verification codes received earlier in a case where verification codes are sent to the same phone number for the same scenario within the validity period.
|
SendSmsVerifyCodeRequest.Builder |
interval(Long interval)
The time interval.
|
SendSmsVerifyCodeRequest.Builder |
outId(String outId)
The external ID.
|
SendSmsVerifyCodeRequest.Builder |
ownerId(Long ownerId)
OwnerId.
|
SendSmsVerifyCodeRequest.Builder |
phoneNumber(String phoneNumber)
The phone number.
|
SendSmsVerifyCodeRequest.Builder |
resourceOwnerAccount(String resourceOwnerAccount)
ResourceOwnerAccount.
|
SendSmsVerifyCodeRequest.Builder |
resourceOwnerId(Long resourceOwnerId)
ResourceOwnerId.
|
SendSmsVerifyCodeRequest.Builder |
returnVerifyCode(Boolean returnVerifyCode)
Specifies whether to return a verification code.
|
SendSmsVerifyCodeRequest.Builder |
schemeName(String schemeName)
The verification service name.
|
SendSmsVerifyCodeRequest.Builder |
signName(String signName)
The signature.
|
SendSmsVerifyCodeRequest.Builder |
smsUpExtendCode(String smsUpExtendCode)
The extension code of the upstream text message.
|
SendSmsVerifyCodeRequest.Builder |
templateCode(String templateCode)
The code of the text message template.
|
SendSmsVerifyCodeRequest.Builder |
templateParam(String templateParam)
The value of the variable in the text message template.
|
SendSmsVerifyCodeRequest.Builder |
validTime(Long validTime)
The validity period of the verification code.
|
public SendSmsVerifyCodeRequest.Builder autoRetry(Long autoRetry)
public SendSmsVerifyCodeRequest.Builder codeLength(Long codeLength)
The length of the verification code. Default value: 4. Valid values: 4 to 8.
example:4
public SendSmsVerifyCodeRequest.Builder codeType(Long codeType)
The type of the generated verification code. Default value: 1. Valid values:
1
public SendSmsVerifyCodeRequest.Builder countryCode(String countryCode)
The country code of the phone number. SMS verification codes can be sent only by using phone numbers in the Chinese mainland. Default value: 86.
example:86
public SendSmsVerifyCodeRequest.Builder duplicatePolicy(Long duplicatePolicy)
Specifies how to handle the verification codes received earlier in a case where verification codes are sent to the same phone number for the same scenario within the validity period.
1
public SendSmsVerifyCodeRequest.Builder interval(Long interval)
The time interval. Unit: seconds. Default value: 60. This parameter specifies how often you can send a verification code.
example:60
public SendSmsVerifyCodeRequest.Builder outId(String outId)
The external ID.
example:12358794Aqzaq
public SendSmsVerifyCodeRequest.Builder ownerId(Long ownerId)
public SendSmsVerifyCodeRequest.Builder phoneNumber(String phoneNumber)
The phone number.
This parameter is required.
example:86130****0000
public SendSmsVerifyCodeRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
public SendSmsVerifyCodeRequest.Builder resourceOwnerId(Long resourceOwnerId)
public SendSmsVerifyCodeRequest.Builder returnVerifyCode(Boolean returnVerifyCode)
Specifies whether to return a verification code.
false
public SendSmsVerifyCodeRequest.Builder schemeName(String schemeName)
The verification service name. If this parameter is not specified, the default service is used. The name can be up to 20 characters in length.
example:Aliyun
public SendSmsVerifyCodeRequest.Builder signName(String signName)
The signature.
This parameter is required.
example:Aliyun Test
public SendSmsVerifyCodeRequest.Builder smsUpExtendCode(String smsUpExtendCode)
The extension code of the upstream text message. Upstream text messages are text messages sent to the communication service provider. Upstream text messages are used to customize a service, complete an inquiry, or send a request. You are charged for sending upstream text messages based on the billing standards of the service provider.
example:The extension code is automatically generated by the system when the signature is generated. You do not need to specify the extension code. You can skip this parameter based on your business requirements. If you want to use custom extension codes, contact your account manager.
1213123
public SendSmsVerifyCodeRequest.Builder templateCode(String templateCode)
The code of the text message template.
Log on to the SMS console. In the left-side navigation pane, click Go China or Go Globe. You can view the text message template code in the Template Code column on the Message Templates tab.
The text message templates must be created on the Go Globe page and approved.
This parameter is required.
example:azsq_*****
public SendSmsVerifyCodeRequest.Builder templateParam(String templateParam)
The value of the variable in the text message template. The verification code is replaced with "##code##".
Example 1: For a system-defined template that contains variables, if the template content is "Your verification code is ${code} and valid for 5 minutes. Do not disclose the verification code to others.", specify the value of this parameter as {"code":"##code##"}
Example 2: For a custom template, if the template content is ${content}, specify the value of this parameter as {"content":"Your verification code is ##code## and must be used within 5 minutes."}.
If line breaks are required in JSON-formatted data, they must meet the relevant requirements that are specified in the standard JSON protocol.
For more information about template variables, see SMS template specifications.
This parameter is required.
example:{"code":"##code##"}
public SendSmsVerifyCodeRequest.Builder validTime(Long validTime)
The validity period of the verification code. Unit: seconds. Default value: 300.
example:300
public SendSmsVerifyCodeRequest build()
Copyright © 2025. All rights reserved.