调用该接口查询配网引导信息。

路径 /awss/enrollee/guide/get
版本号 1.1.6
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
productKey String 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

dnGuideIcon String

配网引导图标。

dnCopywriting String

配网文案。

buttonCopywriting String

按钮文案。

helpTitle String

帮助标题。

helpIcon String

帮助图标。

helpCopywriting String

帮助文案。

productKey String

产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

strategy String

配网策略。

order Int

配网优先级,优先级从0开始递减。

alertMessage String

提醒用户,同意进行下一步的提示文案。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.1.6",
		"iotToken": "token"
	},
	"params":{
		"productKey": "value0"
	}
}

正常返回示例

JSON 格式

{
    "code": 200,
    "data": [{
        "gmtModified": 1517476367000,
        "creator": "755ED7CxxxxxxxxC48BF0247",
        "helpTitle": "指示灯没有闪烁?",
        "dnGuideIcon": "http://iotx-ilop.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a12xxxxQfi/networkConfig/1517476344732/timg.jpg",
        "helpCopywriting": "请长按重置3-5秒,确保看到指示灯闪烁后松开",
        "modifier": "755ED7CxxxxxxxxBC48BF0247",
        "buttonCopywriting": "我确认在闪烁",
        "gmtCreate": 1517476347000,
        "productKey": "a1xxxxW",
        "id": 87,
        "dnCopywriting": "接通电源,确认指示灯闪烁",
        "helpIcon": "http://iotx-****.oss-cn-hangzhou.aliyuncs.com/iotx-ilop-portal/p/a12xxxxfi/networkConfig/1517476333895/timg (1).jpg",
        "rbacTenantId": "755ED7C7810B4255BA026BBC4****247"
    }],
    "id": "e6d8bd5e-b79b-xxxx-xxxx-b3f9c65cdd2b"
}

异常返回示例

JSON 格式

{}