Skip to content

语音包模块

获取语音包列表(精简版)

  • 接口地址
POST /api/v1/voice/list
  • 参数说明
名称类型是否必需示例描述
lockIdintY123锁ID
  • 返回

返回结果中 data 包含:

名称类型描述
dataarray语音包列表
  namestring语音包名称
  labelstring语音包标签
  updated_atint语音包更新时间
  • 返回示例
json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": [
    {
      "name": "zh_CN@default",
      "label": "简体中文-默认",
      "updated_at": 1675209600
    },
    {
      "name": "en_US@default",
      "label": "English-默认",
      "updated_at": 1675209600
    }
  ]
}

获取语音列表(完整版)

POST /api/v1/voice/packs
  • 参数说明
名称类型是否必需示例描述
vendorstringY"XL"厂商
modelstringY"JL-BLE-01"型号
  • 返回

返回结果中 data 包含:

参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
errorMsgString错误信息
descriptionString描述
dataArray返回数据
langString语言代码
timbresArray音色列表
isFemaleInt0:男声 1:女声
timbreString音色标识
nameString音色名称
timbrePackUrlString语音包URL
json
{
  "errorCode": 0,
  "errorMsg": "none error message",
  "description": "",
  "data": [
    {
      "lang": "zh_CN",
      "timbres": [
        {
          "isFemale": 0,
          "timbre": "xiaoyun",
          "name": "默认音色",
          "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/4/dir_story"
        },
        {
          "timbre": "xiaogang",
          "name": "普通话男声",
          "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/5/dir_story"
        },
        {
          "timbre": "zhixiaomei",
          "name": "普通话女声",
          "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/6/dir_story"
        }
      ]
    },
    {
      "lang": "en_US",
      "timbres": [
        {
          "timbre": "xiaoyun",
          "name": "默认音色",
          "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/7/dir_story"
        },
        {
          "timbre": "harry",
          "name": "英音男声",
          "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/8/dir_story"
        },
        {
          "timbre": "emily",
          "name": "英音女声",
          "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/9/dir_story"
        }
      ]
    }
  ]
}

获取语音包详情

  • 接口地址
POST /api/v1/voice/detail
  • 参数说明
名称类型是否必需示例描述
lockIdintY123锁ID
namestringY"zh_CN@default"语音包名称
  • 返回

返回结果中 data 包含:

名称类型描述
namestring语音包名称
labelstring语音包标签
updated_atint语音包更新时间
timbrePackUrlstring语音包URL
fileSizeint语音包大小
fileMd5string语音包MD5值
  • 返回示例
json
{
  "errcode": 0,
  "errmsg": "none error message",
  "description": "",
  "data": {
    "name": "zh_CN@default",
    "label": "简体中文-默认",
    "updated_at": 1675209600,
    "timbrePackUrl": "https://company.dev.star-lock.cn/storage/voice/4/dir_story",
    "fileSize": 1024,
    "fileMd5": "8A96B26C36DFF9E6D043E7427DA8E3CE"
  }
}

设置语音

  • 接口地址
POST /api/v1/lockSetting/updateLockSetting
  • 参数说明
名称类型是否必需示例描述
lockIdintY1001锁ID
currentVoiceTimbreobjectY当前选择的语音

currentVoiceTimbre 格式说明:

  • lang: 语言代码(如:zh_CN、en_US)
  • timbre: 音色标识(如:xiaoyun、xiaogang、zhixiaomei)
json
{
  "currentVoiceTimbre": {
    "lang": "zh_CN",
    "timbre": "xiaoyun"
  }
}
  1. 返回参数及示例:
参数类型描述
statusInt状态码
statusTextString提示信息
contentString返回数据
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
json
{
  "errorCode": 0,
  "description": "表示成功或是。",
  "errorMsg": "success or means yes"
}

物联网设备通信协议文档