# 自定义设备唤醒词

# 唤醒词评分

HTTP Method：POST
请求地址：https://uvs-biz.hivoice.cn/rest/v1/wake_words/check

参数	类型	必填	描述
appkey	String	Y	产品KEY
deviceId	String	Y	设备标识
deviceToken	String	Y	设备令牌
userId	String	Y	用户ID
wakeupWord	String	Y	唤醒词

返回值

参数	类型	必填	描述
errorCode	String	Y	响应code，成功为0，具体见错误码定义
errorMsg	String	Y	响应描述
score	String	Y	评分结果
valid	Boolean	Y	是否达到构建标准

返回结果示例：

{
  "errorCode": "0",
  "errorMsg": "请求成功",
  "result": {
    "valid": true,
    "score": 8
  }
}

1
2
3
4
5
6
7
8

# 唤醒词列表

HTTP Method：GET
请求地址：https://uvs-biz.hivoice.cn/rest/v1/wake_words/list

参数	类型	必填	描述
appkey	String	Y	产品KEY
deviceId	String	Y	设备标识
deviceToken	String	Y	设备令牌
userId	String	Y	用户ID

返回值

参数	类型	必填	描述
errorCode	String	Y	响应code，成功为0，具体见错误码定义
errorMsg	String	Y	响应描述
result	Array	Y	返回结果
└name	String	Y	唤醒词
└score	String	Y	唤醒词分数
└status	String	Y	构建状态
└isEnable	Integer	Y	是否使用中（1：是 0：否）

返回结果示例：

{
  "errorCode": "0",
  "errorMsg": "请求成功",
  "result": [
    {
      "appKey": "123",
      "deviceId": "123",
      "isEnable": 1,
      "name": "你好小伙",
      "score": "8",
      "status": "success"
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 添加并设置唤醒词

HTTP Method：POST
请求地址：https://uvs-biz.hivoice.cn/rest/v1/wake_words/save

参数	类型	必填	描述
appkey	String	Y	产品KEY
deviceId	String	Y	设备标识
deviceToken	String	Y	设备令牌
userId	String	Y	用户ID
wakeupMap	json	Y	唤醒词，分数文本，格式：{"唤醒词1":"分数1","唤醒词2":"分数2"}

返回值

参数	类型	必填	描述
errorCode	String	Y	响应code，成功为0，具体见错误码定义
errorMsg	String	Y	响应描述

返回结果示例：

{
  "errorCode": "0",
  "errorMsg": "请求成功"
}

1
2
3
4

# 错误码定义及描述

errorCode	errorMsg	描述
0	请求成功	成功
8400001	必填参数不能为空	必填参数不能为空
8400002	请求参数不合法	请求参数格式不正确，或者参数不满足需要的条件
8400003	设备token无效	设备token无效
8400005	未发现需要更新的唤醒词	上传的唤醒词都在使用中
8400006	未发现设备sdk版本
8401001	唤醒词打分异常	唤醒词打分异常
8401002	唤醒词正在制作中	唤醒词正在制作中
8404444	调用第三方服务异常	调用第三方服务异常
8409999	系统异常	联系管理员