Email verification code API
Protocol description
Based on the http protocol, data is exchanged through http post, and token and code are used for mailbox verification.
Character Encoding
Server requests and returns are encoded in UTF-8
request URL
The verification code is valid for 10 minutes, please do not request frequently, the frequency will be limited
https:
Send verification code request format
message parameters |
Is it required |
describe |
type |
yes |
API function code, "send" means sending |
email |
yes |
Email to be verified |
Validation example
POST https://email.e.vg/api_post.php
{
"type": "send",
"email": "[email protected]",
}
Example of sending and returning message
message parameters |
type |
describe |
code |
Int |
Send status code, 0, send successfully, 1, send failed, 2, rate limit 3,Email is blacklisted 4,Email Domain Blacklist
|
message |
String |
send status message |
email |
String |
Email to be verified |
data |
object |
send status message |
{
"code": 0,
"message": "request succeeded",
"email": "[email protected]",
"data": {}
}
Validation example
message parameters |
Is it required |
describe |
type |
yes |
API function code, "verify" is verification |
email |
String |
Email to be verified |
code |
yes |
User verification code |
Validation example
POST https://email.e.vg/api_post.php
{
"type": "verify",
"email": "[email protected]",
"code": "907643",
}
Example of verification return message
message parameters |
type |
describe |
code |
Int |
Verification result, 0, verification code is correct, 1, verification code is incorrect, 2, rate limit |
message |
Boolean |
Validation Status Message |
email |
String |
Verify email |
data |
object |
other information |
Example of verification return message
{
"code": 0,
"message": true,
"email": "[email protected]",
"data": null
}
Document update time: 2022-05-20 22:09 Author: EVG