增值服务

获取增值服务用户余量包

请求链接: /v2/service/getUserPackage
请求方式: POST
参数说明:

无参数

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
email_count	Int	邮箱余量单位（条）
sms_count	Int	短信余量单位（条）
cloudauth_count	Int	实名认证余量单位（次）
vip_status	Int	是否开通高级功能 0否 10是 20否
vip_lock_count	Int	购买锁数量
vip_expire_at	String	vip到期时间

json

{
  "email_count": 0,
  "sms_count": 0,
  "cloudauth_count": 0,
  "vip_status": 0,
  "vip_lock_count": 0,
  "vip_expire_at": "1970-01-01 00:00:00"
}

增值服务套餐购包链接

请求链接: /v2/service/getPackageUrl
请求方式: POST
参数说明:

无参数

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
sms_buy_url	String	短信购买URL
email_buy_url	String	邮件购买URL
vip_buy_url	String	VIP购买URL
cloudauth_buy_url	String	实名认证购买URL
shopList	String	商城列表URL

json

{
  "sms_buy_url": "http://local.mall.star-lock.cn/quick_login?mallUrl=%2Fproducts%2F65&id=379&key=8ff35a414cb4ef2d641418314469fc63",
  "email_buy_url": "http://local.mall.star-lock.cn/quick_login?mallUrl=%2Fproducts%2F66&id=379&key=8ff35a414cb4ef2d641418314469fc63",
  "vip_buy_url": "http://local.mall.star-lock.cn/quick_login?mallUrl=%2Fproducts%2F64&id=379&key=8ff35a414cb4ef2d641418314469fc63",
  "cloudauth_buy_url": "http://local.mall.star-lock.cn/quick_login?mallUrl=%2Fproducts%2F67&id=379&key=8ff35a414cb4ef2d641418314469fc63",
  "shopList": "http://local.mall.star-lock.cn/quick_login?id=379&key=8ff35a414cb4ef2d641418314469fc63"
}

自定义模板

添加自定义模板

请求链接: /v2/service/addTemplate
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
channelType	int	Y	1	1短信 2邮件
name	String	Y	"模板名称"	模板名称
langType	int	Y	1	模板语言：通过获取默认模板接口获得
templateType	int	Y	1	模板类型：通过获取默认模板接口获得
regards	String	N	"你好！"	模板内容-头
tips	String	N	"请注意查收！"	模板内容-尾

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据对象

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

更新自定义模板

请求链接: /v2/service/updateTemplate
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
id	int	Y	1	模板ID
name	String	N	"模板名称"	模板名称
regards	String	N	"你好！"	模板内容-头
tips	String	N	"请注意查收！"	模板内容-尾

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据对象

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

获取已添加模板列表

请求链接: /v2/service/listTemplate
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
channelType	int	Y	1	1短信 2邮件
pageNo	int	N	1	分页页码
pageSize	int	N	10	分页大小

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
channelType	Int	渠道类型
list	Array	模板列表
id	Int	模板ID
name	String	模板名称
regards	String	模板内容-头
tips	String	模板内容-尾
template	String	完整模板内容
templateType	Int	模板类型
langType	Int	语言类型
created_at	String	创建时间
updated_at	String	更新时间
pageNo	Int	当前页码
pageSize	Int	分页大小
pages	Int	总页数
total	Int	总记录数

json

{
  "channelType": 1,
  "list": [
    {
      "id": 39,
      "channelType": 1,
      "templateType": 2,
      "name": "国际-密码",
      "regards": "Hello!",
      "tips": "Please contact the staff if you have any questions",
      "created_at": "2024-07-04T10:07:46.000000Z",
      "updated_at": "2024-07-05T01:58:03.000000Z",
      "langType": 2,
      "template": "Hello!Your room: {LOCKALIAS}, the door password is: {PASSWORD}. {DATENAME}Please contact the staff if you have any questions"
    },
    {
      "id": 37,
      "channelType": 1,
      "templateType": 2,
      "name": "国内-密码",
      "regards": "你好！",
      "tips": "如有疑问请联系工作人员",
      "created_at": "2024-07-04T10:07:23.000000Z",
      "updated_at": "2024-07-05T01:57:20.000000Z",
      "langType": 1,
      "template": "你好！你的房间：{房间名}，开门密码是：{密码}。{有效期}如有疑问请联系工作人员"
    }
  ],
  "pageNo": 1,
  "pageSize": 10,
  "pages": 1,
  "total": 2
}

删除模板

请求链接: /v2/service/deleteTemplate
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
id	int	Y	1	模板ID

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据对象

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

获取默认模板列表

请求链接: /v2/service/getDefaultTemplate
请求方式: POST
参数说明:

无参数

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
langType	Int	语言类型
langName	String	语言名称
templates	Array	模板列表
templateType	Int	模板类型
templateName	String	模板名称
template	String	模板内容
templatePreviewCode	Object	模板预览代码

json

[
  {
    "langType": 1,
    "langName": "国内模板",
    "templates": [
      {
        "templateType": 1,
        "templateName": "电子钥匙",
        "template": "你收到一把电子钥匙，请使用APP来开门。https://pre.lock.star-lock.cn:8093/apps",
        "templatePreviewCode": {
          "{下载地址}": "http://www.baidu.com"
        }
      },
      {
        "templateType": 2,
        "templateName": "密码",
        "template": "你的房间：{房间名}，开门密码是：{密码}。{有效期}",
        "templatePreviewCode": {
          "{房间名}": "201",
          "{密码}": "332211",
          "{有效期}": "2021-12-11 12:00 - 2021-12-12 13:00"
        }
      }
    ]
  },
  {
    "langType": 2,
    "langName": "国际模板",
    "templates": [
      {
        "templateType": 1,
        "templateName": "电子钥匙",
        "template": "You received an electronic key, please use the APP to open the door.https://pre.lock.star-lock.cn:8093/apps",
        "templatePreviewCode": {
          "{APPLINK}": "http://www.baidu.com"
        }
      },
      {
        "templateType": 2,
        "templateName": "密码",
        "template": "Your room: {LOCKALIAS}, the door password is: {PASSWORD}. {DATENAME}",
        "templatePreviewCode": {
          "{LOCKALIAS}": "201",
          "{PASSWORD}": "332211",
          "{DATENAME}": "2021-12-11 12:00 - 2021-12-12 13:00"
        }
      }
    ]
  }
]

设置实名认证频次

请求链接: /v2/service/setFaceAuthentication
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
face_auth_frequence	int	Y	1	认证频次：1仅首次，2每日一次，3每周一次，4每月一次

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息
data	Object	返回数据对象

json

{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

获取购买记录列表

请求链接: /v2/service/getBuyRecordList
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
type	String	Y	"sms"	日志类型：vip/email/sms/cloudauth
record_type	int	Y	10	记录类型：10充值
pageNo	int	N	1	分页页码
pageSize	int	N	10	分页大小

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
pageNo	Int	当前页码
pageSize	Int	分页大小
total	Int	总记录数
list	Array	记录列表
id	Int	记录ID
user_id	Int	用户ID
order_number	String	订单号
type	String	类型
record_type	Int	记录类型
sms_count	Int	购买短信数量
email_count	Int	购买邮件数量
cloudauth_count	Int	购买实名认证数量
vip_lock_count	Int	VIP锁数量
vip_year	Int	VIP年数
is_apply	Int	是否已应用
money	String	购买花费金额
created_at	String	创建时间
updated_at	String	更新时间

json

{
  "pageNo": 1,
  "pageSize": 10,
  "total": 1,
  "list": [
    {
      "id": 5,
      "user_id": 379,
      "order_number": "2024032664983",
      "type": "sms",
      "record_type": 10,
      "sms_count": 2,
      "email_count": 0,
      "cloudauth_count": 0,
      "vip_lock_count": 0,
      "vip_year": 0,
      "is_apply": 1,
      "money": "0.00",
      "created_at": "2024-04-15T02:56:30.000000Z",
      "updated_at": "2024-04-15T02:56:30.000000Z"
    }
  ]
}

获取使用记录列表

请求链接: /v2/service/getUseRecordList
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
type	String	Y	"sms"	日志类型：vip/email/sms/cloudauth
pageNo	int	N	1	分页页码
pageSize	int	N	10	分页大小

返回参数及示例:

参数	类型	描述
status	Int	状态码
statusText	String	提示信息
content	String	返回数据
pageNo	Int	当前页码
pageSize	Int	分页大小
total	Int	总记录数
list	Array	记录列表

json

{
  "pageNo": 1,
  "pageSize": 10,
  "total": 0,
  "list": []
}

增值服务特权详情页

请求链接: /value-added/vip-intro
请求方式: GET
参数说明:

无参数

上报增值服务购买请求

请求链接: /service/reportBuyRequest
请求方式: POST
参数说明:

名称	类型	是否必需	示例	描述
type	String	Y	"cloud_storage"	请求类型：cloud_storage（云存储）
lockId	int	N/Y	1	锁ID，当type为cloud_storage时必填

返回参数及示例:

参数	类型	描述
errorCode	Int	错误码
description	String	描述
errorMsg	String	错误信息

json

{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

已废弃接口

以下接口已废弃，请使用上述新接口替代。

获取短信模板列表（已废弃）

请使用"获取已添加模板列表"接口替代

原请求链接: /v2/service/listTemplate (参数 type=1)

获取邮件模板列表（已废弃）

请使用"获取已添加模板列表"接口替代

原请求链接: /v2/service/listTemplate (参数 type=2)

添加短信模板（已废弃）

请使用"添加自定义模板"接口替代

原请求链接: /v2/service/addTemplate

添加邮件模板（已废弃）

请使用"添加自定义模板"接口替代

原请求链接: /v2/service/addTemplate

更新模板信息（已废弃）

请使用"更新自定义模板"接口替代

原请求链接: /v2/service/update

删除模板（已废弃）

请使用"删除模板"接口替代

原请求链接: /v2/service/delete

获取默认模板（已废弃）

请使用"获取默认模板列表"接口替代

原请求链接: /v2/service/getDefaultTemplate (参数 type)

增值服务 ​

获取增值服务用户余量包 ​

增值服务套餐购包链接 ​

自定义模板 ​

添加自定义模板 ​

更新自定义模板 ​

获取已添加模板列表 ​

删除模板 ​

获取默认模板列表 ​

设置实名认证频次 ​

获取购买记录列表 ​

获取使用记录列表 ​

增值服务特权详情页 ​

上报增值服务购买请求 ​

已废弃接口 ​

获取短信模板列表（已废弃） ​

获取邮件模板列表（已废弃） ​

添加短信模板（已废弃） ​

添加邮件模板（已废弃） ​

更新模板信息（已废弃） ​

删除模板（已废弃） ​

获取默认模板（已废弃） ​

增值服务

获取增值服务用户余量包

增值服务套餐购包链接

自定义模板

添加自定义模板

更新自定义模板

获取已添加模板列表

删除模板

获取默认模板列表

设置实名认证频次

获取购买记录列表

获取使用记录列表

增值服务特权详情页

上报增值服务购买请求

已废弃接口

获取短信模板列表（已废弃）

获取邮件模板列表（已废弃）

添加短信模板（已废弃）

添加邮件模板（已废弃）

更新模板信息（已废弃）

删除模板（已废弃）

获取默认模板（已废弃）