/communication/templates
分页查询当前租户的消息模板列表。支持按发送渠道(sms/email/push)、激活状态、关键词(模板名称/编码)进行筛选。参考:ePrivacy Directive 2002/58/EC、CAN-SPAM Act。
Request Parameters
| Name | In | Type | Required | Default | Example | Constraints | Description |
|---|---|---|---|---|---|---|---|
channel |
query |
string |
No | 渠道筛选:sms/email/push | |||
is_active |
query |
boolean |
No | 是否激活筛选:true/false | |||
keyword |
query |
string |
No | 关键词搜索(匹配模板名称或编码) | |||
page |
query |
integer |
No | 页码,从1开始(默认1) | |||
page_size |
query |
integer |
No | 每页条数(默认20) |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 查询成功,返回模板列表 | dto.TemplateListResponse |
| 400 | 请求参数错误 | dto.SimpleResponse |
| 401 | 未认证或令牌无效 | dto.SimpleResponse |
| 403 | 无权访问该资源 | dto.SimpleResponse |
| 500 | 服务内部错误 | dto.SimpleResponse |
Referenced Schemas
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 |
dto.SimpleResponse
| Field | Type | Required | Example | Constraints | Description |
|---|---|---|---|---|---|
code |
integer |
No | |||
message |
string |
No | |||
timestamp |
string |
No |
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 |
|---|---|---|---|---|---|
channel |
string |
No | sms |
||
code |
string |
No | verify_code |
||
content |
string |
No | 您的验证码是{code},5分钟内有效 |
||
content_type |
string |
No | text |
||
created_at |
string |
No | 2026-04-15T10:00:00Z |
||
description |
string |
No | 用于发送登录验证码 |
||
id |
string |
No | tpl_abc123 |
||
is_active |
boolean |
No | True |
||
name |
string |
No | 验证码模板 |
||
subject |
string |
No | 验证码通知 |
||
tenant_id |
string |
No | tnt_xyz789 |
||
updated_at |
string |
No | 2026-04-15T10:00:00Z |
||
variables |
array of string |
No | ['["code"]'] |
||
version |
integer |
No | 1 |