跳转到内容

短信模板

通过可复用模板实现短信内容的标准化创建,支持动态变量和多语言功能,确保品牌一致性并提升运营效率


查询短信模板列表

GET
/api/v1/sms/template

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
code
类型string
name
类型string
thirdCode
类型string
language
类型string
枚举
"en""zh_CN"
channelId
类型integer
format"int64"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方法

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

筛选条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

筛选条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

筛选条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询短信模板详情

GET
/api/v1/sms/template/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

短信模板ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

更新短信模板

PATCH
/api/v1/sms/template/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

短信模板ID

类型integer
必填
format"int64"

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布