Skip to content

自定义个性提醒

自定义提醒.png

添加

  1. 请求链接: /api/lockVoiceShortcuts/add

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
lock_idIntY123456锁ID
typeIntY10语音类型 10:智能提醒 20:事件警告语 30:快捷回复语
timbre_typeIntY1音色类型 1:系统 2:自定义上传 3:自定义音色
nameStringY"小仙女生日"语音名称
voice_urlStringN"https://example.com/voice.mp3"语音URL timbre_type=2时必填
langStringN"zh_CN"语种 timbre_type=1时必传 请通过/user/getSupportedLangs接口获取数据
timbreStringN"zh-CN-XiaoxiaoNeural"音色 timbre_type=1,3时必传 请通过/user/getSupportedLangs或/customTimbre/getAvailableCustomTimbres接口获取数据
datesArrayN["2025-09-22","2025-09-22"]语音日期范围 type=10时必传
contentStringN"test"语音内容 timbre_type=1 时必传
blessing_voice_idIntN1祝福语音ID type=10时可传 请通过获取祝福语音列表接口获取
open_modeIntN1开门方式 type=10时必传 1:电子钥匙 2:密码 3:IC卡 4:指纹 5:人脸 6:掌静脉 7:遥控
user_noIntN1开门方式userNo type=10时必传
event_typeIntN1事件类型 type=20时必传
  1. 返回参数及示例:
参数类型描述
errorCodeInt错误码
descriptionString描述信息
errorMsgString错误信息
dataObject返回数据
  voice_urlString语音URL
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "voice_url": "https://lock.xie.star-lock.cn/storage/star_voice_shortcut/1/1e03751b-0f47-4738-8c89-91599a8eafd5.mp3"
  }
}

列表

  1. 请求链接: /api/lockVoiceShortcuts/list

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
lock_idIntY123456锁ID
typeIntY10语音类型 10:智能提醒 20:事件警告语 30:快捷回复语
page_noIntN1页码
page_sizeIntN10每页数量
  1. 返回参数及示例:
参数类型描述
errorCodeInt错误码
descriptionString描述信息
errorMsgString错误信息
dataObject返回数据
  listArray语音列表
    voice_idInt语音ID
    nameString语音名称
    voice_urlString语音URL
    langString语种
    timbreString音色
    timbre_typeInt音色类型 1:系统 2:自定义上传 3:自定义音色
    typeInt语音类型 10:智能提醒 20:事件警告语 30:快捷回复语
    contentString语音内容
    datesArray语音日期范围
    blessing_voice_idInt祝福语音ID
    blessing_voice_urlString祝福语音URL
    open_modeInt开门方式 1:电子钥匙 2:密码 3:IC卡 4:指纹 5:人脸 6:掌静脉 7:遥控
    user_noInt开门方式userNo
    event_typeInt事件类型
  totalInt总数
  page_noInt页码
  page_sizeInt每页数量
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "list": [
      {
        "voice_id": 2,
        "name": "小仙女生日",
        "voice_url": "https://lock.xie.star-lock.cn/storage/star_voice_shortcut/1/1e03751b-0f47-4738-8c89-91599a8eafd5.mp3",
        "lang": "zh_CN",
        "timbre": "zh-CN-XiaoxiaoNeural",
        "timbre_type": 1,
        "type": 10,
        "content": "test",
        "dates": [
          "2025-09-22"
        ],
        "blessing_voice_id": 0,
        "blessing_voice_url": "",
        "open_mode": 1,
        "user_no": 1,
        "event_type": 0
      },
      {
        "voice_id": 1,
        "name": "小仙女生日",
        "voice_url": "https://lock.xie.star-lock.cn/storage/star_voice_shortcut/1/c16c6e81-a9be-439e-921f-0742db32722f.mp3",
        "lang": "zh_CN",
        "timbre": "zh-CN-XiaoxiaoNeural",
        "timbre_type": 1,
        "type": 10,
        "content": "test",
        "dates": [
          "2025-09-22"
        ],
        "blessing_voice_id": 0,
        "blessing_voice_url": "",
        "open_mode": 1,
        "user_no": 1,
        "event_type": 0
      }
    ],
    "total": 2,
    "page_no": 1,
    "page_size": 10
  }
}

删除

  1. 请求链接: /api/lockVoiceShortcuts/delete

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
voice_idIntY1语音ID
  1. 返回参数及示例:
参数类型描述
errorCodeInt错误码
descriptionString描述信息
errorMsgString错误信息
dataObject返回数据
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {}
}

鑫泓佳智能硬件通信协议文档