短信模板列表条件查询接口
# 1、接口描述
功能说明: 通过此接口可以按条件筛选获取用户所属的所有审核通过的短信模板信息
请求地址: https://open-api.soboten.com/apiOpen/v1/customerSms/listSmsTemplate?startDate=xxx&endDate=xxx&pageNum=xxx&pageSize=xxx&smsChannelId=xxx&smsTemplateIdSet=xxx
请求方法: GET
# 2、请求头
请求头参数获取详见权限认证
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| appkey | String | 是 | ISV账号信息里获取 |
| timestamp | Long | 是 | 生成验签字段时使用的时间戳 |
| signature | String | 是 | 验签字段,获取方法详见权限认证 |
# 3、输入参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| startDate | LocalDate | 否 | 筛选创建起始时间 | 2020-07-07 |
| endDate | LocalDate | 否 | 筛选创建结束时间 | 2020-08-08 |
| smsChannelId | Long | 否 | 短信通道ID | 123 |
| pageNum | Integer | 是 | 页数 | 1 |
| pageSize | Integer | 是 | 页面内最大数据条数,最大值100 | 20 |
| smsTemplateIdSet | Set | 否 | 模板id | [25847] |
# 4、输出参数
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | Integer | 相应状态码 | 200 |
| data | Object | 返回的数据 | |
| +number | Integer | 当前页 | 1 |
| +pageSize | Integer | 每页的数量 | 20 |
| +totalElements | Integer | 总记录数 | 1 |
| +pages | Integer | 总页数 | 1 |
| +content | JsonArray | ||
| ++smsTemplateId | Long | 短信模板Id | 25847 |
| ++name | String | 模板名称 | test |
| ++text | String | 模板内容 | hello,${姓名} |
| ++smsType | String | 短信类型 | SMS |
| ++smsSignatureName | String | 短信签名 | test |
| ++createTime | LocalDateTime | 创建时间 | 2023-05-04 10:11:10 |
| ++tenantId | Long | 租户id | 61987 |
| ++vars | Set | 短信模板中的变量集合 | ["姓名"] |
| requestId | String | 请求id | |
| resultMsg | String | 响应说明 | |
| host | String | 业务主机名 | prod-web-7 |
| errorStackTrace | String | 异常堆栈 | null |
# 5、示例
输出示例:
{
"code": 200,
"data": {
"number": 1,
"pageSize": 20,
"totalElements": 1,
"pages": 1,
"content": [
{
"smsTemplateId": 25847,
"name": "test",
"text": "hello,${姓名}",
"smsSignatureName": "test",
"smsType": "SMS",
"createTime": "2023-05-04 10:11:10",
"tenantId": 61987,
"vars": ["姓名"]
}
]
},
"requestId": "8F3hAI98",
"resultMsg": "获取成功",
"host": "prod-web-7",
"errorStackTrace": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
上次更新: 2026/8/4 16:21:40