Skip to content

SmsTemplate

Standardizes sms content creation through reusable templates with dynamic variables and multi-language support, maintaining brand consistency and operational efficiency


Query the detail of sms template

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sms template id

类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
变量

示例

cURL
JavaScript
PHP
Python

Update sms template

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sms template id

类型integer
必填
format"int64"

请求体

application/json
JSON
{
"name": "string",
"content": "content",
"verificationCode": true,
"verificationCodeValidSecond": "Validity of verification code, in seconds",
"thirdCode": "string",
"language": "string"
}

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Query the list of sms template

GET
/api/v1/sms/template

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

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

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

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

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
变量

示例

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.