Skip to main content

Send Mail Template

Request address

  • API address(requestURI): /openapi/v1/mail/sendTemplate

Request parameters

Parameter nameTypeRequirementDescription
receiverStringRRecipient's email address, required, length cannot exceed 64
subjectStringRSubject, required, cannot exceed 60
templateIdStringRTemplate ID, required, and cannot exceed 20
paramsMap< String, String >OTemplate 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 nameTypeRequirementDescription
recordIdStringOSend Record ID
sendStatusintOSending status, [0: To be sent, 1: Sending, 2: Sending successful, 3: Sending failed]
messageStringOSend result

Sample response

{
"code": 200,
"msg": "success",
"data": {
"recordId": "20220408123456789",
"sendStatus": "2",
"message": "Sent successfully"
}
}