Send an Email Verification Code for 2FA Login

Send a verification code to the email address of the current user for 2FA login.

Request URL

POST {base_url}/uc-auth/api/v1/public/mfa/email-code

Request parameters

Query parameters
Parameter Required Type Description
ticket Yes String The pre-authentication ticket issued after the user's credentials are verified in the first step of the login process.
Note: You can obtain the ticket using the Get an Access Token interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Result> The result of the verification code sending operation.
Result
Parameter Type Description
maskedEmail String The masked email address to which the verification code is sent.
resendIntervalSeconds Integer The minimum interval between verification code sending attempts.

Unit: Second
remainingSeconds Integer The remaining time before another verification code can be sent again.

Unit: Second

Note: A value of 0 indicates that another code can be sent immediately.

Example

Request example

POST /uc-auth/api/v1/public/mfa/email-code?ticket=VRgZbmFFmSsI1WaBgtyCBZt3rntoMam94W568oazw2E HTTP/1.1
Host: api.cn.novoone.com

Response example

HTTP/1.1 200 OK
{
    "result": {
        "maskedEmail": "b***y@yeastar.com",
        "resendIntervalSeconds": 120,
        "remainingSeconds": 119
    },
    "requestId": "a1488519299a9cc5d4c35c936ae80879",
    "code": "200",
    "message": "SUCCESS"
}