监听配置API
获取监听配置
接口地址
POST /api/v1.0/invoke/open-ability/method/user-commands
请求参数
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 内容类型，值为application/json |
| Accept | String | Header | 是 | 接受类型，值为application/json |
| Authorization | String | Header | 是 | Bearer认证，访问令牌 |
| command | String | Body | 是 | 命令名称 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令参数 |
param说明
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| residence_id | String | Body | 是 | 住宅ID |
返回参数
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| Content-Type | String | Header | 内容类型，值为application/json |
| success | Boolean | Body | 判断请求是否成功 true：成功 false：失败 |
| timestamp | Integer | Body | 时间戳 |
| result | Object<result> | Body | 返回结果 |
result说明
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| listen_list | []String | Body | 监听列表 family：家庭监听通知 account：账号监听通知 device：设备监听通知 space：空间监听通知 scene：场景监听通知 communication：沟通监听通知 maintenance：报修监听通知 booking：预约监听通知 message：消息监听通知 |
请求示例
POST /api/v1.0/invoke/open-ability/method/user-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r8b5a73f8dd84abaa94dcs248be49b0db"
}
}
成功返回示例
状态码：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {
"listen_list": [
"account",
"device"
]
}
}
失败返回示例
见 接口失败返回
开启监听配置
接口地址
POST /api/v1.0/invoke/open-ability/method/user-commands
请求参数
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 内容类型，值为application/json |
| Accept | String | Header | 是 | 接受类型，值为application/json |
| Authorization | String | Header | 是 | Bearer认证，访问令牌 |
| command | String | Body | 是 | 命令名称 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令参数 |
param说明
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| listen_list | []String | Body | 是 | 开启监听列表 family：家庭监听通知 account：账号监听通知 device：设备监听通知 space：空间监听通知 scene：场景监听通知 communication：沟通监听通知 maintenance：报修监听通知 booking：预约监听通知 message：消息监听通知 |
| residence_id | String | Body | 是 | 住宅ID |
返回参数
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| Content-Type | String | Header | 内容类型，值为application/json |
| success | Boolean | Body | 判断请求是否成功 true：成功 false：失败 |
| timestamp | Integer | Body | 时间戳 |
| result | Object | Body | 返回结果 |
请求示例
POST /api/v1.0/invoke/open-ability/method/user-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "turn_on_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
"listen_list": [
"account",
"device"
]
}
}
成功返回示例
状态码：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
失败返回示例
见 接口失败返回
关闭监听配置
接口地址
POST /api/v1.0/invoke/open-ability/method/user-commands
请求参数
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 内容类型，值为application/json |
| Accept | String | Header | 是 | 接受类型，值为application/json |
| Authorization | String | Header | 是 | Bearer认证，访问令牌 |
| command | String | Body | 是 | 命令名称 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令参数 |
param说明
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| listen_list | []String | Body | 是 | 关闭监听列表 family：家庭监听通知 account：账号监听通知 device：设备监听通知 space：空间监听通知 scene：场景监听通知 communication：沟通监听通知 maintenance：报修监听通知 booking：预约监听通知 message：消息监听通知 |
| residence_id | String | Body | 是 | 住宅ID |
返回参数
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| Content-Type | String | Header | 内容类型，值为application/json |
| success | Boolean | Body | 判断请求是否成功 true：成功 false：失败 |
| timestamp | Integer | Body | 时间戳 |
| result | Object | Body | 返回结果 |
请求示例
POST /api/v1.0/invoke/open-ability/method/user-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "turn_off_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
"listen_list": [
"account",
"device"
]
}
}
成功返回示例
状态码：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
失败返回示例
见 接口失败返回