Fecify-短信模板-获取
接口信息
- 接口地址:
{your-site-url}/api/skill/notice/get-sms-captcha
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/admin
- 请求方式:
GET
- Content-Type:
application/json
- 配对接口: Fecify-短信模板-保存
- 使用流程: 先调用本接口获取当前配置 → 修改各字段 → 调用保存接口提交
- 说明: 获取阿里云短信验证码模版配置,包括验证码过期时间、注册和忘记密码场景的短信签名及模版 CODE。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数
无请求参数。
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/notice/get-sms-captcha' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"captcha_expire_time": "600",
"register": {
"sign_name": "飞猫商城",
"template": "SMS_183760292"
},
"forgot_password": {
"sign_name": "飞猫商城",
"template": "SMS_183760292"
}
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
返回数据 |
data 子字段
| 字段 |
类型 |
说明 |
captcha_expire_time |
String |
短信验证码过期时间,单位:秒 |
register |
Object |
注册账号短信配置,包含 sign_name 和 template |
forgot_password |
Object |
忘记密码短信配置,包含 sign_name 和 template |
register / forgot_password 子字段
| 字段 |
类型 |
说明 |
sign_name |
String |
短信签名名称,需在阿里云短信服务中已审核通过 |
template |
String |
短信模版 CODE,需在阿里云短信服务中已审核通过 |
注意事项
- 本接口返回的是嵌套结构(
register.sign_name、forgot_password.template),但 Fecify-短信模板-保存 使用的是扁平命名(register_sign_name、forgot_password_template),保存时请注意字段名转换。
sign_name 和 template 需先在阿里云短信控制台中创建并通过审核后方可使用。
- 修改配置前先调用本接口获取当前值,编辑后通过 Fecify-短信模板-保存 提交。