Contact Us
Log In

Query the details of the email template

Last Updated on : 2022-01-17 09:30:38download

Query the details of the email template.

API address

GET: /v1.0/iot-03/msg-templates/mails/{template_id}

Request parameter

Parameter name Type IN Required Description
template_id String uri true Template ID.

Return parameter

Parameter name Type Description
result MailTemplateDetailRes

Description of result

Parameter name Type Description
name String The template name with 1 to 30 characters.
title String The template title with 1 to 50 characters.
sender_name String The sender name with 1 to 30 characters. For example, set the sender to Jack, and the sender’s email address to test@example.com. The receiver will see the sender’s address as “Jack” test@example.com.
content String The template content in the format of HTML and text. The maximum capacity is 28 KB.
type Integer The email type. 0: verification code. 1: email notification. 2: promotional email.
status Integer The review status of the template. 0: The review is in progress. 1: Passed the review. 2: Failed to pass the review. View the reasons for failure in verify_reason.
verify_code Integer The review code. For more information, see the list of review codes.
verify_reason String Describe the reason why the review is not passed.

Request example

GET: /v1.0/iot-03/msg-templates/mails/MAIL_12313****

Return example

{ "result": { "sender_name": "Jack", "verify_code": 100, "title": "Verification Code", "type": 0, "content": "You are registering with your email address. The verification code is: ${code}, valid for 5 minutes.", "verify_reason": "Illegal words", "name": "The template of the email verification code", "status": 2 }, "t": 1586153261345, "success": true }

Error code

For more information, see error code.