Send a verification email to the specified email address, which includes a verification link. The user completes the email verification by clicking the link.
Points to note
- The API uses the POST method and requires data to be submitted in application/ format
- The API is used to send a verification email to a specified email address
- The email contains a verification link, the user clicks to complete the verification
- Supports various verification scenarios (email verification, password reset, etc.)
- A valid email address and verification status must be provided
- The email will send a success message after being sent, but it is not guaranteed that the user will receive the email
Request address
{ๅๅๅฐๅ}/api/verify/email
Description:{ๅๅๅฐๅ}Replace it with your domain name, such ashttps://en.anqicms.com/api/verify/email
After calling this interface, the system will send an email to the specified email address, which contains a verification code. The user can complete the email verification by clicking the link in the email.
Request Syntax
POST /api/verify/email
Content-Type: application/json
Request Headers
This interface involves only public request headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Request parameters
| Field name | Type | Required | Description |
|---|---|---|---|
| string | No | Email address | |
| State | string | No | state value, verify = verify email address is valid, reset = reset password, other values are not judged, exist = check if email exists |
Response header
This interface only involves common response headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field name | Type | Description |
|---|---|---|
| code | int | Error code |
| msg | string | Error description |
Usage Example
Request example
POST /api/verify/email HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json
{
"email": "[email protected]",
"state": "verify"
}
Response Example
{
"code": 0,
"msg": "ๅทฒๅ้้ฎไปถ"
}
Error code
| Error code | Description |
|---|---|
| 0 | OK |
| -1 | Error, the reason is indicated in msg |
| 1001 | Not logged in |
| 1002 | Not authorized |
| 200 | API request OK |