Send Mail Template
Request address
- API address(requestURI): /openapi/v1/mail/sendTemplate
Request parameters
Parameter name | Type | Requirement | Description |
---|---|---|---|
receiver | String | R | Recipient's email address, required, length cannot exceed 64 |
subject | String | R | Subject, required, cannot exceed 60 |
templateId | String | R | Template ID, required, and cannot exceed 20 |
params | Map< String, String > | O | Template parameters, format: key is the name of the variable in the template, value is the value of the variable |
Sample request
{
"receiver": "123456@gmail.com",
"subject": "subject",
"templateId": "1233",
"params": {
"name": "Tom",
"code": "123456"
}
}
Response parameters
Parameter name | Type | Requirement | Description |
---|---|---|---|
recordId | String | O | Send Record ID |
sendStatus | int | O | Sending status, [0: To be sent, 1: Sending, 2: Sending successful, 3: Sending failed] |
message | String | O | Send result |
Sample response
{
"code": 200,
"msg": "success",
"data": {
"recordId": "20220408123456789",
"sendStatus": "2",
"message": "Sent successfully"
}
}