Google Assistant服务

更新时间：2018-09-12 17:00:56

Google Assistant服务

提供一组对接Google Smart Home Action接口。

查询设备列表

定义描述

path 版本 描述 是否需要用户身份的鉴权
/device/querybygooglehome 1.0.0 Google Home获取用户设备 否

请求参数

参数 类型 必填 描述
accessToken String 是 Oauth2.0 accessToken
oauthOrigin String 是 oauth来源，目前支持OPEN_ACCOUNT

返回参数

参数 类型 必有 描述
deviceList List 否 设备列表信息

deviceList列表结构

参数 类型 描述
traits ​List 设备能力
name ​JSON 描述
deviceInfoDTO JSON 设备信息
id ​Integer ​设备iotId
type ​String ​设备类型
willReportState ​Boolean 是否支持状态查询
customData JSON 拓展信息

name结构

参数 类型 描述
defaultNames ​List 默认名称
name ​String 名称
nicknames ​List 昵称

deviceInfoDTO结构

参数 类型 描述
manufacturer ​String ​服务厂商
model ​String 型号
hwVersion ​String ​固件版本
swVersion ​String ​软件版本

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0"
    },
    "params": {
        "accessToken" : "0bc19fa515354264450105920d45d2",
       "oauthOrigin" : "OPEN_ACCOUNT"
    }
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": "123",
            "type": "action.devices.types.OUTLET",
            "traits": [
                "action.devices.traits.OnOff"
            ],
            "name": {
                "defaultNames": [
                    "MyOutlet1234"
                ],
                "name": "Nightlight",
                "nicknames": [
                    "wallplug"
                ]
            },
            "willReportState": false,
            "deviceInfo": {
                "manufacturer": "lights-out-inc",
                "model": "hs1234",
                "hwVersion": "3.2",
                "swVersion": "11.4"
            },
            "customData": {
                "fooValue": 74,
                "barValue": true,
                "bazValue": "foo"
            }
        }
    ]
}

错误码

请参考公共错误码

查询设备状态

定义描述

path 版本 描述 是否需要用户身份的鉴权
/device/status/querybygooglehome 1.0.0 查询设备状态 否

请求参数

参数 类型 必填 描述
accessToken String 是 Oauth2.0 accessToken
oauthOrigin String 是 oauth来源，目前支持OPEN_ACCOUNT
devices List 是 设备列表

devices列表结构

参数 类型 描述
id ​String 设备iotId

返回参数

参数 类型 必有 描述
statusMap JSON 否 设备属性信息，key是传入的设备列表的iotId，value是对应设备的属性详情，key是属性名，value是属性值

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0"
    },
    "params": {
        "devices": [{
            "id": "123"
        }],
        "accessToken": "0bc19fa515354264450105920d45d2",
        "oauthOrigin": "OPEN_ACCOUNT"
    }
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "123": {
            "on": true,
            "online": true,
            "brightness": 80,
            "color": {
                "name": "cerulean",
                "spectrumRGB": 31655
            }
        }
    }
}

错误码

请参考公共错误码

控制设备

定义描述

path 版本 描述 是否需要用户身份的鉴权
/device/controlbygooglehome 1.0.0 控制设备 否

请求参数

参数 类型 必填 描述
accessToken String 是 Oauth2.0 accessToken
oauthOrigin String 是 oauth来源，目前支持OPEN_ACCOUNT
command String 是 指令
devices List 是 设备列表
params JSON 是 详细控制参数，key为属性名，value为属性值

devices列表结构

参数 类型 描述
id ​String 设备iotId

返回参数

参数 类型 必有 描述

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0"
    },
    "params": {
        "devices": [{
            "id": "123"
        }],
        "accessToken": "0bc19fa515354264450105920d45d2",
        "oauthOrigin": "OPEN_ACCOUNT",
        "params": {
            "brightness": 50
        },
        "command": "action.devices.commands.BrightnessAbsolute"
    }
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "123": {
            "isSuccess": true,
            "message": "success",
            "localizedMsg": ""
        }
    }
}

错误码

请参考公共错误码

results matching ""

    No results matching ""