1. 语音池
语音池
1.1. 添加提示语
基础信息
路径: /v1/api/voice/add
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| type | integer | 是 | 类型：1、文件 2、文字 | |
| file | string | 否 | 文件，上传文件存储后的uri，type为1时必须传入 | |
| text | string | 否 | 文字，type为2时必传入 | |
| num | integer | 否 | 语音池序号，可为空，为空的话自动生成 |
Body示例:
{
"type": 2,
"num": 1,
"text": "哈哈"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 | |
| |─num | integer | 否 | 语音池序号 | |
| |─ttsText | string | 否 | 文字提示 | |
| |─ttsUri | string | 否 | 文件uri | |
| |─ttsState | integer | 否 | 状态：1、已生成 2、未生成 |
响应示例:
{
"code":0,
"data":{
"num":1,
"ttsState":1,
"ttsText":"哈哈",
"ttsUri":"Z3NwOi8vd3Vrb25n-98594cb9977e06fde6265cbc85a343bf"
},
"msg":"成功"
}
1.2. 更新提示语
基础信息
路径: /v1/api/voice/update
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| num | integer | 是 | 语音池序号 | |
| type | integer | 是 | 类型：1、文件 2、文字 | |
| file | string | 否 | 文件内容的base64编码，type为1时 必传入 | |
| text | string | 否 | 文字，type为2时 必传入 |
Body示例:
{
"type": 1,
"num": 1,
"file": "Z3NwOi8vd3Vrb25n-98594cb9977e06fde6265cbc85a343bf",
"text": "哈哈2"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 |
响应示例:
{
"code":0,
"msg":"成功"
}
1.3. 提示语列表查询
基础信息
路径: /v1/api/voice/list
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | array | 否 | 具体的返回值 | |
| |─ | object | |||
| |─num | integer | 否 | 语音池序号 | |
| |─ttsText | string | 否 | 文字提示 | |
| |─ttsUri | string | 否 | 文件uri | |
| |─ttsState | integer | 否 | 状态：1、已生成 2、未生成 |
响应示例:
{
"code":0,
"data":[
{
"num":1,
"ttsState":1,
"ttsText":"哈哈2",
"ttsUri":"Z3NwOi8vd3Vrb25n-98594cb9977e06fde6265cbc85a343bf"
}
],
"msg":"成功"
}
1.4. 删除提示语
基础信息
路径: /v1/api/voice/delete
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| num | integer | 是 | 语音池序号 |
Body示例:
{
"num": 1
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 |
响应示例:
{
"code":0,
"msg":"成功"
}
1.5. 上传语音文件
基础信息
路径: /v1/api/voice/upload
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | multipart/form-data | 是 |
表单:
| 名称 | 值 | 必须 | 类型 | 备注 |
|---|---|---|---|---|
| file | 是 | file |
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 | |
| |─uri | string | 否 | uri，base64编码串 | |
| |─url | string | 否 | url，文件URL全路径 |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"uri": "Z3NwOi8vd3Vrb25n-98594cb9977e06fde6265cbc85a343bf",
"url": "http:10.171.5.193/pub/Z3NwOi8vd3Vrb25n-98594cb9977e06fde6265cbc85a343bf"
}
}
1.6. TTS 新增语音规则(V2)
基础信息
路径: /v1/api/voice/tts/rule/add
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| deviceUuid | string | 是 | 设备唯一id | |
| ruleConfig | string | 是 | 语音规则配置 |
Body示例:
{
"deviceUuid": "7ba4f3f9fc5f49b49c5e34b22eee5e19",
"ruleConfig": "{\"rule_list\":[{\"is_in_time\":1,\"person_type\":1,\"schedule_list\":[{\"character\":[{\"content\":\"上午好\",\"type\":1},{\"type\":2}],\"end_time\":\"11:00\",\"sound_play\":[{\"type\":2},{\"name\":\"上午好\",\"number\":0,\"type\":1}],\"start_time\":\"5:00\",\"week_day\":0},{\"character\":[{\"content\":\"中午好\",\"type\":1},{\"type\":2}],\"end_time\":\"13:00\",\"sound_play\":[{\"type\":2},{\"name\":\"中午好\",\"number\":1,\"type\":1}],\"start_time\":\"11:00\",\"week_day\":0},{\"character\":[{\"content\":\"下午好\",\"type\":1},{\"type\":2}],\"end_time\":\"17:00\",\"sound_play\":[{\"type\":2},{\"name\":\"下午好\",\"number\":2,\"type\":1}],\"start_time\":\"13:00\",\"week_day\":0},{\"character\":[{\"content\":\"晚上好\",\"type\":1},{\"type\":2}],\"end_time\":\"23:00\",\"sound_play\":[{\"type\":2},{\"name\":\"晚上好\",\"number\":3,\"type\":1}],\"start_time\":\"17:00\",\"week_day\":0},{\"character\":[{\"content\":\"辛苦了\",\"type\":1},{\"type\":2}],\"end_time\":\"5:00\",\"sound_play\":[{\"type\":2},{\"name\":\"辛苦了\",\"number\":4,\"type\":1}],\"start_time\":\"23:00\",\"week_day\":0}]},{\"is_in_time\":2,\"person_type\":1,\"schedule_list\":[{\"character\":[{\"content\":\"当前时段无权限,请联系管理员\",\"type\":1}],\"sound_play\":[{\"name\":\"当前时段无权限,请联系管理员\",\"number\":10,\"type\":1}],\"week_day\":0}]},{\"is_in_time\":1,\"person_type\":2,\"schedule_list\":[{\"character\":[{\"content\":\"欢迎光临\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"欢迎光临\",\"number\":12,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"is_in_time\":2,\"person_type\":2,\"schedule_list\":[{\"character\":[{\"content\":\"当前时段无权限,请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"当前时段无权限,请联系管理员\",\"number\":101,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"person_type\":4,\"schedule_list\":[{\"character\":[{\"content\":\"无权限，请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"无权限，请联系管理员\",\"number\":9,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"person_type\":3,\"schedule_list\":[{\"character\":[{\"content\":\"无权限，请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"无权限，请联系管理员\",\"number\":100,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]}],\"sound_file_list\":[{\"desc\":\"上午好\",\"sound_file_number\":0,\"sound_uri\":\"\"},{\"desc\":\"中午好\",\"sound_file_number\":1,\"sound_uri\":\"\"},{\"desc\":\"下午好\",\"sound_file_number\":2,\"sound_uri\":\"\"},{\"desc\":\"晚上好\",\"sound_file_number\":3,\"sound_uri\":\"\"},{\"desc\":\"辛苦了\",\"sound_file_number\":4,\"sound_uri\":\"\"},{\"desc\":\"无权限，请联系管理员\",\"sound_file_number\":9,\"sound_uri\":\"\"},{\"desc\":\"当前时段无权限,请联系管理员\",\"sound_file_number\":10,\"sound_uri\":\"\"},{\"desc\":\"欢迎光临\",\"sound_file_number\":12,\"sound_uri\":\"\"},{\"desc\":\"无权限，请联系管理员\",\"sound_file_number\":100,\"sound_uri\":\"\"},{\"desc\":\"当前时段无权限,请联系管理员\",\"sound_file_number\":101,\"sound_uri\":\"\"}],\"update_time\":1620821527707}"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 |
响应示例:
{
"code": 0,
"msg": "成功"
}
1.7. TTS 删除语音规则(V2)
基础信息
路径: /v1/api/voice/tts/rule/delete
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| deviceUuid | string | 是 | 设备uuid |
Body示例:
{
"deviceUuid": "7ba4f3f9fc5f49b49c5e34b22eee5e19"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 |
响应示例:
{
"code": 0,
"msg": "成功"
}
1.8. TTS 查询语音规则列表(V2)
基础信息
路径: /v1/api/voice/tts/rule/list
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| deviceUuids | array | 是 | 设备uuid列表 | |
| |─ | string |
Body示例:
{
"deviceUuids": [
"7ba4f3f9fc5f49b49c5e34b22eee5e19"
]
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | array | 否 | 具体的返回值 | |
| |─ | object | |||
| |─deviceUuid | string | 否 | 设备唯一id | |
| |─ruleConfig | string | 否 | 语音规则配置 |
响应示例:
{
"code": 0,
"msg": "成功",
"data": [
{
"deviceUuid": "7ba4f3f9fc5f49b49c5e34b22eee5e19",
"ruleConfig": "{\"rule_list\":[{\"is_in_time\":1,\"person_type\":1,\"schedule_list\":[{\"character\":[{\"content\":\"上午好\",\"type\":1},{\"type\":2}],\"end_time\":\"11:00\",\"sound_play\":[{\"type\":2},{\"name\":\"上午好\",\"number\":0,\"type\":1}],\"start_time\":\"5:00\",\"week_day\":0},{\"character\":[{\"content\":\"中午好\",\"type\":1},{\"type\":2}],\"end_time\":\"13:00\",\"sound_play\":[{\"type\":2},{\"name\":\"中午好\",\"number\":1,\"type\":1}],\"start_time\":\"11:00\",\"week_day\":0},{\"character\":[{\"content\":\"下午好\",\"type\":1},{\"type\":2}],\"end_time\":\"17:00\",\"sound_play\":[{\"type\":2},{\"name\":\"下午好\",\"number\":2,\"type\":1}],\"start_time\":\"13:00\",\"week_day\":0},{\"character\":[{\"content\":\"晚上好\",\"type\":1},{\"type\":2}],\"end_time\":\"23:00\",\"sound_play\":[{\"type\":2},{\"name\":\"晚上好\",\"number\":3,\"type\":1}],\"start_time\":\"17:00\",\"week_day\":0},{\"character\":[{\"content\":\"辛苦了\",\"type\":1},{\"type\":2}],\"end_time\":\"5:00\",\"sound_play\":[{\"type\":2},{\"name\":\"辛苦了\",\"number\":4,\"type\":1}],\"start_time\":\"23:00\",\"week_day\":0}]},{\"is_in_time\":2,\"person_type\":1,\"schedule_list\":[{\"character\":[{\"content\":\"当前时段无权限,请联系管理员\",\"type\":1}],\"sound_play\":[{\"name\":\"当前时段无权限,请联系管理员\",\"number\":10,\"type\":1}],\"week_day\":0}]},{\"is_in_time\":1,\"person_type\":2,\"schedule_list\":[{\"character\":[{\"content\":\"欢迎光临\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"欢迎光临\",\"number\":12,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"is_in_time\":2,\"person_type\":2,\"schedule_list\":[{\"character\":[{\"content\":\"当前时段无权限,请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"当前时段无权限,请联系管理员\",\"number\":101,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"person_type\":4,\"schedule_list\":[{\"character\":[{\"content\":\"无权限，请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"无权限，请联系管理员\",\"number\":9,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"person_type\":3,\"schedule_list\":[{\"character\":[{\"content\":\"无权限，请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"无权限，请联系管理员\",\"number\":100,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]}],\"sound_file_list\":[{\"desc\":\"上午好\",\"sound_file_number\":0,\"sound_uri\":\"\"},{\"desc\":\"中午好\",\"sound_file_number\":1,\"sound_uri\":\"\"},{\"desc\":\"下午好\",\"sound_file_number\":2,\"sound_uri\":\"\"},{\"desc\":\"晚上好\",\"sound_file_number\":3,\"sound_uri\":\"\"},{\"desc\":\"辛苦了\",\"sound_file_number\":4,\"sound_uri\":\"\"},{\"desc\":\"无权限，请联系管理员\",\"sound_file_number\":9,\"sound_uri\":\"\"},{\"desc\":\"当前时段无权限,请联系管理员\",\"sound_file_number\":10,\"sound_uri\":\"\"},{\"desc\":\"欢迎光临\",\"sound_file_number\":12,\"sound_uri\":\"\"},{\"desc\":\"无权限，请联系管理员\",\"sound_file_number\":100,\"sound_uri\":\"\"},{\"desc\":\"当前时段无权限,请联系管理员\",\"sound_file_number\":101,\"sound_uri\":\"\"}],\"update_time\":1620821527707}"
}
]
}
1.9. TTS 更新语音规则(V2)
基础信息
路径: /v1/api/voice/tts/rule/update
请求方法: POST
请求参数
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| deviceUuid | string | 是 | 设备唯一id | |
| ruleConfig | string | 是 | 语音规则配置 |
Body示例:
{
"deviceUuid": "7ba4f3f9fc5f49b49c5e34b22eee5e19",
"ruleConfig": "{\"rule_list\":[{\"is_in_time\":1,\"person_type\":1,\"schedule_list\":[{\"character\":[{\"content\":\"上午好\",\"type\":1},{\"type\":2}],\"end_time\":\"11:00\",\"sound_play\":[{\"type\":2},{\"name\":\"上午好\",\"number\":0,\"type\":1}],\"start_time\":\"5:00\",\"week_day\":0},{\"character\":[{\"content\":\"中午好\",\"type\":1},{\"type\":2}],\"end_time\":\"13:00\",\"sound_play\":[{\"type\":2},{\"name\":\"中午好\",\"number\":1,\"type\":1}],\"start_time\":\"11:00\",\"week_day\":0},{\"character\":[{\"content\":\"下午好\",\"type\":1},{\"type\":2}],\"end_time\":\"17:00\",\"sound_play\":[{\"type\":2},{\"name\":\"下午好\",\"number\":2,\"type\":1}],\"start_time\":\"13:00\",\"week_day\":0},{\"character\":[{\"content\":\"晚上好\",\"type\":1},{\"type\":2}],\"end_time\":\"23:00\",\"sound_play\":[{\"type\":2},{\"name\":\"晚上好\",\"number\":3,\"type\":1}],\"start_time\":\"17:00\",\"week_day\":0},{\"character\":[{\"content\":\"辛苦了\",\"type\":1},{\"type\":2}],\"end_time\":\"5:00\",\"sound_play\":[{\"type\":2},{\"name\":\"辛苦了\",\"number\":4,\"type\":1}],\"start_time\":\"23:00\",\"week_day\":0}]},{\"is_in_time\":2,\"person_type\":1,\"schedule_list\":[{\"character\":[{\"content\":\"当前时段无权限,请联系管理员\",\"type\":1}],\"sound_play\":[{\"name\":\"当前时段无权限,请联系管理员\",\"number\":10,\"type\":1}],\"week_day\":0}]},{\"is_in_time\":1,\"person_type\":2,\"schedule_list\":[{\"character\":[{\"content\":\"欢迎光临\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"欢迎光临\",\"number\":12,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"is_in_time\":2,\"person_type\":2,\"schedule_list\":[{\"character\":[{\"content\":\"当前时段无权限,请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"当前时段无权限,请联系管理员\",\"number\":101,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"person_type\":4,\"schedule_list\":[{\"character\":[{\"content\":\"无权限，请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"无权限，请联系管理员\",\"number\":9,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]},{\"person_type\":3,\"schedule_list\":[{\"character\":[{\"content\":\"无权限，请联系管理员\",\"type\":1}],\"end_time\":\"23:59\",\"sound_play\":[{\"name\":\"无权限，请联系管理员\",\"number\":100,\"type\":1}],\"start_time\":\"00:00\",\"week_day\":0}]}],\"sound_file_list\":[{\"desc\":\"上午好\",\"sound_file_number\":0,\"sound_uri\":\"\"},{\"desc\":\"中午好\",\"sound_file_number\":1,\"sound_uri\":\"\"},{\"desc\":\"下午好\",\"sound_file_number\":2,\"sound_uri\":\"\"},{\"desc\":\"晚上好\",\"sound_file_number\":3,\"sound_uri\":\"\"},{\"desc\":\"辛苦了\",\"sound_file_number\":4,\"sound_uri\":\"\"},{\"desc\":\"无权限，请联系管理员\",\"sound_file_number\":9,\"sound_uri\":\"\"},{\"desc\":\"当前时段无权限,请联系管理员\",\"sound_file_number\":10,\"sound_uri\":\"\"},{\"desc\":\"欢迎光临\",\"sound_file_number\":12,\"sound_uri\":\"\"},{\"desc\":\"无权限，请联系管理员\",\"sound_file_number\":100,\"sound_uri\":\"\"},{\"desc\":\"当前时段无权限,请联系管理员\",\"sound_file_number\":101,\"sound_uri\":\"\"}],\"update_time\":1620821527707}"
}
返回数据
Headers:
| 名称 | 值 | 必须 | 备注 |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | 否 |
Body:
| 名称 | 类型 | 必须 | 默认值 | 备注 |
|---|---|---|---|---|
| code | integer | 否 | 返回值code | |
| msg | string | 否 | 返回值消息 | |
| data | object | 否 | 具体的返回值 |
响应示例:
{
"code": 0,
"msg": "成功"
}