/notifications/templates
获取所有通知模板列表,支持包含已停用模板的选项 参考:CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance。
Request Parameters
| Name | In | Type | Required | Default | Example | Constraints | Description |
|---|---|---|---|---|---|---|---|
include_inactive |
query |
boolean |
No | 包含已停用模板 | |||
type |
query |
string |
No | 通知类型过滤 | |||
page |
query |
integer |
No | 页码(默认1) | |||
page_size |
query |
integer |
No | 每页条数(默认20) |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 模板列表 | dto.TemplateListResponse |
| 400 | 请求参数错误 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 401 | 未认证 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 403 | 权限不足 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 404 | 资源未找到 | gitee_com_linmes_authms_base_dto.SimpleResponse |
| 500 | 服务内部错误 | gitee_com_linmes_authms_base_dto.SimpleResponse |
Referenced Schemas
dto.TemplateListResponse
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
items |
array of |
No | 统一使用 items | ||
message |
string |
No | |||
pagination |
object |
No | 分页信息(嵌套对象) | ||
timestamp |
string |
No | |||
total |
integer |
No | 总条数(平铺,便于直接读取) |
dto.TemplateResponse
通知模板信息
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
content |
string |
No | 亲爱的{{user_name}},欢迎加入{{app_name}}! |
内容 | |
created_at |
string |
No | 2026-01-01T00:00:00Z |
创建时间 | |
name |
string |
No | welcome_notification |
模板名称 | |
subject |
string |
No | 欢迎加入{{app_name}} |
主题 | |
template_id |
string |
No | tpl_abc123 |
模板ID | |
type |
string |
No | system |
类型 | |
variables |
array of string |
No | ['["user_name"', '"app_name"]'] |
变量 |
gitee_com_linmes_authms_base_dto.PageInfo
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
has_next |
boolean |
No | HasNext indicates whether there is a next page | ||
has_prev |
boolean |
No | HasPrev indicates whether there is a previous page | ||
page |
integer |
No | Page is the current page number (1-based) | ||
page_size |
integer |
No | PageSize is the number of items per page | ||
total |
integer |
No | Total is the total number of items across all pages | ||
total_pages |
integer |
No | TotalPages is the total number of pages |
gitee_com_linmes_authms_base_dto.SimpleResponse
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
message |
string |
No | |||
timestamp |
string |
No |