Appearance
语音包模块
获取语音包列表(精简版)
- 接口地址
POST /api/v1/voice/list- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 123 | 锁ID |
- 返回
返回结果中 data 包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| data | array | 语音包列表 |
| name | string | 语音包名称 |
| label | string | 语音包标签 |
| updated_at | int | 语音包更新时间 |
- 返回示例
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- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| vendor | string | Y | "XL" | 厂商 |
| model | string | Y | "JL-BLE-01" | 型号 |
- 返回
返回结果中 data 包含:
| 参数 | 类型 | 描述 |
|---|---|---|
| status | Int | 状态码 |
| statusText | String | 提示信息 |
| content | String | 返回数据 |
| errorCode | Int | 错误码 |
| errorMsg | String | 错误信息 |
| description | String | 描述 |
| data | Array | 返回数据 |
| lang | String | 语言代码 |
| timbres | Array | 音色列表 |
| isFemale | Int | 0:男声 1:女声 |
| timbre | String | 音色标识 |
| name | String | 音色名称 |
| timbrePackUrl | String | 语音包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- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 123 | 锁ID |
| name | string | Y | "zh_CN@default" | 语音包名称 |
- 返回
返回结果中 data 包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| name | string | 语音包名称 |
| label | string | 语音包标签 |
| updated_at | int | 语音包更新时间 |
| timbrePackUrl | string | 语音包URL |
| fileSize | int | 语音包大小 |
| fileMd5 | string | 语音包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- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | int | Y | 1001 | 锁ID |
| currentVoiceTimbre | object | Y | 当前选择的语音 |
currentVoiceTimbre 格式说明:
- lang: 语言代码(如:zh_CN、en_US)
- timbre: 音色标识(如:xiaoyun、xiaogang、zhixiaomei)
json
{
"currentVoiceTimbre": {
"lang": "zh_CN",
"timbre": "xiaoyun"
}
}- 返回参数及示例:
| 参数 | 类型 | 描述 |
|---|---|---|
| status | Int | 状态码 |
| statusText | String | 提示信息 |
| content | String | 返回数据 |
| errorCode | Int | 错误码 |
| description | String | 描述 |
| errorMsg | String | 错误信息 |
json
{
"errorCode": 0,
"description": "表示成功或是。",
"errorMsg": "success or means yes"
}