控制家居

更新时间:2023-06-20 12:39:04下载pdf

本文介绍控制家居的 API。

接口描述

通过意图文本控制智能家居。

接口地址

POST: /v1.0/iot-01/voice/homes/{home_id}/dm

请求参数

参数名 类型 参数位置 是否必填 说明
text String true 意图文本
lang String false 语言,默认为 zh 中文,
  • zh:中文
  • en:英文
    session_Id String false 会话 ID,用于多轮对话时,使用首次返回会话 ID
    request_id String false 请求唯一标示,按通用 UUID 规范生成,参见获取设备支持指令集-全屋获取设备支持的指令集-行业

    返回参数

    参数名 类型 说明
    result Object 返回结果
    success Boolean 判断请求是否成功。 true:成功,false:失败
    t Long 返回时间 13 位时间戳
    code Integer 响应码,成功时不显示
    msg String 请求失败的信息,成功时不显示

    result 说明

    参数名 类型 说明
    request_id String 请求唯一标示
    session_id String 会话 ID
    keep_session String 是否保持会话
    nlg String 播报文本
    nlu Object 意图识别结果
    skill Object 技能结果

    请求示例

    POST: /v1.0/iot-01/voice/homes/31426304/dm
    { "text": "关闭台灯" }

    返回示例

    { "result": { "nlg": "好的,已为您关闭客厅台灯了!,若想同时控制全部的灯,可以对我说关闭全部的灯", "session_id": "c3d27d8860b8b282b194fcebb1b3c0cd", "keep_session": false, "request_id": "f854b94194454cc6a5033e653df39bea_1627973468573" }, "t": 1627973470247, "success": true }

    错误码

    参考 错误码