API接口——睡眠带开放能力

本文介绍睡眠带相关接口。

API 列表

请求方法	API	描述
GET	/v1.0/devices/{device_id}/sleep/daily-reports	获取日睡眠报告。
GET	/v1.0/devices/{device_id}/sleep/monthly-reports	获取月睡眠报告。
GET	/v1.0/devices/{device_id}/sleep/24h-reports	获取 24 小时睡眠报告。
GET	/v1.0/devices/{device_id}/sleep/preview/reports	预览睡眠报告状态。
PUT	/v1.0/devices/{device_id}/sleep/reports/{report_id}	更新报告状态。

获取日睡眠报告

功能描述

获取日睡眠报告。

接口地址

GET /v1.0/devices/{device_id}/sleep/daily-reports

请求参数

参数名	类型	参数类型	说明	必填
device_id	String	URI	设备 ID。	是
report_time	Long	URL	获取设备所在时区报告的时间戳（精确到秒）。	是

返回参数

参数名	参数类型	描述
success	Boolean	是否成功： true：成功 false：失败
status	String	状态
t	Long	13 位标准时间戳
result	List	返回结果

Result

参数名	参数类型	描述
reports	List	睡眠报告

Reports

参数名	参数类型	描述
report_id	Long	报告 ID。
data_date	Long	报告时间，精确到秒。
start_time	Long	睡眠起始时间，精确到秒。
duration	Int	睡觉总时长，单位秒。
wake	Int	清醒总时间，单位秒。
out_of_bed_duration	Int	离床时长，单位秒。
sleep_status	Int	睡眠状态： 0：设备未连接 1：不在床 2：清醒 3：睡着
avg_breath_rate	Int	平均呼吸率。
avg_heart_rate	Int	平均心率。
snore_number	Int	鼾声次数。
snore_duration	Int	鼾声总时长。
snore_high_proportion	Int	鼾声程度为高的比例。
snore_mid_proportion	Int	鼾声程度为中的比例。
snore_low_proportion	Int	鼾声程度为低的比例。
snore_non_proportion	Int	鼾声程度为无的比例。

请求示例

GET /v1.0/devices/vedeo887723I****/sleep/daily-reports?report_time=1594887507

返回示例

{
    "result": {
        "reports": [
            {
                "avg_breath_rate": 15,
                "avg_heart_rate": 56,
                "data_date": 1596577259,
                "duration": 238,
                "out_of_bed_duration": 528,
                "start_time": 1596477259,
                "wake": 205
            }
        ]
    },
    "success": true,
    "t": 1597115614003
}

错误码

以下为该接口常见的业务异常，更多的异常错误，参见全局错误码。

错误码	说明
500	系统错误

获取月睡眠报告

功能描述

获取月睡眠报告。

接口地址

GET /v1.0/devices/{device_id}/sleep/monthly-reports

请求参数

参数名	类型	参数类型	说明	必填
device_id	String	URI	设备 ID。	是
report_time	Long	URL	获取设备所在时区报告的时间戳（精确到秒）。	是

返回参数

参数名	参数类型	描述
success	Boolean	是否成功： true：成功 false：失败
status	String	状态
t	Long	13 位标准时间戳
result	List	返回结果

Result

参数名	参数类型	描述
reports	List	睡眠报告

Reports

参数名	参数类型	描述
reportId	String	报告 ID。
time	Integer	时间。
pos	Integer	周或月在指定年份的位置。例如&#