Autional API Wiki Autional API Wiki /communication/emailSend an email to a specified email address. Supports templates (predefined) or direct HTML/plain text content, supports CC and BCC, automatically records in send logs. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.
Schema: dto.EmailRequest
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
subject |
string |
Yes | Account activation email |
Subject | |
to |
array of string |
Yes | ['user@example.com'] |
items: 1–None | Recipient |
bcc |
array of string |
No | ['manager@example.com'] |
BCC | |
cancel_key |
string |
No | order-123 |
||
cc |
array of string |
No | ['admin@example.com'] |
CC | |
content |
string |
No | <h1>Welcome!</h1> |
Content | |
is_html |
boolean |
No | False |
HTML format | |
send_at |
string |
No | 2026-06-07T10:00:00Z |
||
template |
string |
No | welcome_email |
Template | |
user_id |
string |
No | usr_abc123 |
User ID | |
variables |
object |
No | extra keys: `string` | Variables |
| Status | Description | Schema |
|---|---|---|
| 200 | Send successful, returns send log details | dto.CommunicationLogDetailResponse |
| 400 | Invalid request parameters | dto.SimpleResponse |
| 401 | Unauthenticated or invalid token | dto.SimpleResponse |
| 403 | Insufficient permissions to access this resource | dto.SimpleResponse |
| 404 | Resource not found | dto.SimpleResponse |
| 500 | Internal server error | dto.SimpleResponse |
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
data |
dto.CommunicationLogResponse |
No | |||
message |
string |
No | |||
timestamp |
string |
No |
Message send log record
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
channel |
string |
No | sms |
||
content |
string |
No | Your verification code is 123456 |
||
created_at |
string |
No | 2026-04-15T10:00:00Z |
||
error |
string |
No | Send timeout |
||
id |
string |
No | log_abc123 |
||
provider |
string |
No | aliyun |
||
recipient |
string |
No | 138****8000 |
||
response |
string |
No | |||
sent_at |
string |
No | 2026-04-15T10:01:00Z |
||
status |
string |
No | delivered |
||
template_id |
string |
No | tpl_abc123 |
||
tenant_id |
string |
No | tnt_xyz789 |
||
updated_at |
string |
No | 2026-04-15T10:00:00Z |
||
user_id |
string |
No | usr_abc123 |
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
message |
string |
No | |||
timestamp |
string |
No |