UniOS文档中心

# 闹钟

# 闹钟列表

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

参数 类型 必填 描述
appkey String Y 产品KEY
deviceId String Y 设备标识
deviceToken String Y 设备令牌
userId String Y 用户ID
pageNo Integer N 页码
pageSize Integer N 数量

返回值

参数 类型 必填
 描述
errorCode String Y 响应code，成功为0，具体见错误码定义
errorMsg String Y 响应描述
result Object Y 返回的结果数据
└pageSize Integer Y 数量
└pageNo Integer Y 页数
└total Integer Y 数据总数
└data array Y 数据集合
└└alarmDate String Y 闹钟日期，单次闹钟为响铃日期，如： "2020-03-27"，循环闹钟为响铃描述，如："每周一10点"
└└alarmId String Y 闹钟 id
└└alarmType String Y 闹钟类型，单次：single，循环为：repeat
└└appKey String Y service，形如：cn.usk.music
└└content String Y 闹钟的内容，如："起床"
└└deviceId String Y 设备 id
└└gmtCreate String Y 创建时间
└└gmtModified String Y 修改时间
└└status Integer Y 闹钟状态（1.打开 0.关闭）
└└time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
└└url String Y 闹钟响铃地址
└└repeatType String N 循环类型: DAILY(每日), WEEKLY(每周), MONTHLY(每月), YEARLY(每年), WEEKDAY(周一至周五), WEEKEND(周末),WORKDAY(工作日), RESTDAY(休息日)
└└repeatWeekdays String N WEEKLY 循环闹钟时存在
└└repeatDateNumber Integer N MONTHLY 循环闹钟时存在
└└repeatDate String N YEARLY 循环闹钟时存在

返回结果示例：

{
    "errorCode": "0",
    "errorMsg": "请求成功",
    "result": {
        "data": [
            {
                "alarmDate": "2020-04-09",
                "alarmId": "1136606eeab34968a5e5f82248a10ad3",
                "alarmType": "single",
                "appKey": "bxqbxvrdzrih5cfeoybh7itgz47hzcbw2zujw3i2",
                "content": "111",
                "deviceId": "udid03",
                "gmtCreate": "2020-04-09 10:38:06",
                "gmtModified": "2020-04-09 10:38:06",
                "status": 1,
                "time": "10:56:00",
                "url": "http://ring.unios.com/ring.mp3"
            },
            {
                "alarmDate": "2020-04-09",
                "alarmId": "7de0d6a427304e8ba40094c2802a88a1",
                "alarmType": "repeat",
                "appKey": "bxqbxvrdzrih5cfeoybh7itgz47hzcbw2zujw3i2",
                "content": "111",
                "deviceId": "udid03",
                "gmtCreate": "2020-04-09 14:30:27",
                "gmtModified": "2020-04-09 14:30:27",
                "repeatDate": "08-01",
                "repeatType": "YEARLY",
                "repeatWeekdays": "null",
                "status": 1,
                "time": "10:56:00",
                "url": "http://ring.unios.com/ring.mp3"
            }
        ],
        "pageNo": 1,
        "pageSize": 10,
        "total": 13
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# 添加闹钟

HTTP Method：POST
请求地址：https://uvs-biz.hivoice.cn/rest/v1/alert/create
单次闹钟参数：

参数 类型 必填 描述
appkey String Y 产品KEY
deviceId String Y 设备标识
deviceToken String Y 设备令牌
userId String Y 用户ID
alarmType String Y 闹钟类型，单次：single
alarmDate String Y 日期格式 闹钟响铃日期 如 "2020-03-27"
time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
content String Y 闹钟的内容，如："起床"
url String N 铃声地址，如：http://ring.unios.com/ring.mp3

循环闹钟参数：

参数 类型 必填
 描述
appkey String Y 产品KEY
deviceId String Y 设备标识
deviceToken String Y 设备令牌
userId String Y 用户ID
alarmType String Y 闹钟类型, 循环为：repeat
alarmDate String Y 日期格式 闹钟响铃日期 如 "2020-03-27"
time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
content String Y 闹钟的内容，如："起床"
url String N 铃声地址，如：http://ring.unios.com/ring.mp3
repeatType String N 循环类型: DAILY(每日), WEEKLY(每周), MONTHLY(每月), YEARLY(每年), WEEKDAY(周一至周五), WEEKEND(周末),WORKDAY(工作日), RESTDAY(休息日)
repeatWeekdays String N WEEKLY 循环闹钟时存在,如：1,2,3,4
repeatDateNumber Integer N MONTHLY 循环闹钟时存在，如：20
repeatDate String N YEARLY 循环闹钟时存在，如："08-01"

返回值

参数 类型 必填
 描述
errorCode String Y 响应code，成功为0，具体见错误码定义
errorMsg String Y 响应描述
result Object Y 返回的结果数据
└alarmDate String Y 闹钟日期，单次闹钟为响铃日期，如： "2020-03-27"，循环闹钟为响铃描述，如："每周一10点"
└alarmId String Y 闹钟 id
└alarmType String Y 闹钟类型，单次：single，循环为：repeat
└appKey String Y service，形如：cn.usk.music
└content String Y 闹钟的内容，如："起床"
└deviceId String Y 设备 id
└gmtCreate String Y 创建时间
└gmtModified String Y 修改时间
└status Integer Y 闹钟状态（1.打开 0.关闭）
└time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
└url String Y 闹钟响铃地址
└repeatType String N 循环类型: DAILY(每日), WEEKLY(每周), MONTHLY(每月), YEARLY(每年), WEEKDAY(周一至周五), WEEKEND(周末),WORKDAY(工作日), RESTDAY(休息日)
└repeatWeekdays String N WEEKLY 循环闹钟时存在
└repeatDateNumber Integer N MONTHLY 循环闹钟时存在
└repeatDate String N YEARLY 循环闹钟时存在

返回结果示例：

{
    "errorCode": "0",
    "errorMsg": "请求成功",
    "result": [
        {
            "alarmDate": "2020-04-12",
            "alarmId": "7c03e9dcf9b24a52aa28f23363c9f78a",
            "alarmType": "single",
            "appKey": "bxqbxvrdzrih5cfeoybh7itgz47hzcbw2zujw3i2",
            "content": "111",
            "deviceId": "udid03",
            "gmtCreate": "2020-04-11 19:25:25",
            "gmtModified": "2020-04-11 19:25:25",
            "status": 1,
            "time": "10:56:00",
            "timestamp": 1586660160,
            "url": "http://ring.unios.com/ring.mp3"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 编辑闹钟

HTTP Method：POST
请求地址：https://uvs-biz.hivoice.cn/rest/v1/alert/edit
单次闹钟参数：

参数 类型 必填 描述
appkey String Y 产品KEY
deviceId String Y 设备标识
deviceToken String Y 设备令牌
userId String Y 用户ID
alarmId String Y 闹钟 id
alarmType String Y 闹钟类型，单次：single
alarmDate String Y 日期格式 闹钟响铃日期 如 "2020-03-27"
time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
content String Y 闹钟的内容，如："起床"
url String N 铃声地址，如：http://ring.unios.com/ring.mp3

循环闹钟参数：

参数 类型 必填
 描述
appkey String Y 产品KEY
deviceId String Y 设备标识
deviceToken String Y 设备令牌
userId String Y 用户ID
alarmId String Y 闹钟 id
alarmType String Y 闹钟类型, 循环为：repeat
alarmDate String Y 日期格式 闹钟响铃日期 如 "2020-03-27"
time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
content String Y 闹钟的内容，如："起床"
url String N 铃声地址，如：http://ring.unios.com/ring.mp3
repeatType String N 循环类型: DAILY(每日), WEEKLY(每周), MONTHLY(每月), YEARLY(每年), WEEKDAY(周一至周五), WEEKEND(周末),WORKDAY(工作日), RESTDAY(休息日)
repeatWeekdays String N WEEKLY 循环闹钟时存在,如：1,2,3,4
repeatDateNumber Integer N MONTHLY 循环闹钟时存在，如：20
repeatDate String N YEARLY 循环闹钟时存在，如："08-01"

返回值

参数 类型 必填
 描述
errorCode String Y 响应code，成功为0，具体见错误码定义
errorMsg String Y 响应描述
result Object Y 返回的结果数据
└alarmDate String Y 闹钟日期，单次闹钟为响铃日期，如： "2020-03-27"，循环闹钟为响铃描述，如："每周一10点"
└alarmId String Y 闹钟 id
└alarmType String Y 闹钟类型，单次：single，循环为：repeat
└appKey String Y service，形如：cn.usk.music
└content String Y 闹钟的内容，如："起床"
└deviceId String Y 设备 id
└gmtCreate String Y 创建时间
└gmtModified String Y 修改时间
└status Integer Y 闹钟状态（1.打开 0.关闭）
└time String Y 时间, 格式{hh}:{mm}:{ss}，如："08:10:15"
└url String Y 闹钟响铃地址
└repeatType String N 循环类型: DAILY(每日), WEEKLY(每周), MONTHLY(每月), YEARLY(每年), WEEKDAY(周一至周五), WEEKEND(周末),WORKDAY(工作日), RESTDAY(休息日)
└repeatWeekdays String N WEEKLY 循环闹钟时存在
└repeatDateNumber Integer N MONTHLY 循环闹钟时存在
└repeatDate String N YEARLY 循环闹钟时存在

返回结果示例：

{
    "errorCode": "0",
    "errorMsg": "请求成功",
    "result": [
        {
            "alarmDate": "2020-04-12",
            "alarmId": "7c03e9dcf9b24a52aa28f23363c9f78a",
            "alarmType": "single",
            "appKey": "bxqbxvrdzrih5cfeoybh7itgz47hzcbw2zujw3i2",
            "content": "111",
            "deviceId": "udid03",
            "gmtCreate": "2020-04-11 19:25:25",
            "gmtModified": "2020-04-11 19:25:25",
            "status": 1,
            "time": "10:56:00",
            "timestamp": 1586660160,
            "url": "http://ring.unios.com/ring.mp3"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 删除闹钟

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

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

返回值

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

返回结果示例：

{
    "errorCode": "0",
    "errorMsg": "请求成功"
}
1
2
3
4

# 打开/关闭闹钟

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

参数 类型 必填 描述
appkey String Y 产品KEY
deviceId String Y 设备标识
deviceToken String Y 设备令牌
userId String Y 用户ID
alarmId String Y 闹钟 id
status Integer Y 状态（1 打开 0 关闭）

返回值

参数 类型 必填 描述
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 系统异常 联系管理员

← 设备控制 →