跳到主要内容
版本：V4.0

场景管理API

获取场景列表​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
page_sizeIntegerBody是每页数量
page_indexIntegerBody是当前页数

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
result[]Object<result>Body返回结果

result说明​

参数名类型位置说明
scene_idStringBody场景ID
scene_nameStringBody场景名称
enable_autoBooleanBody判断是否启用自动化
true：启用
false：禁用

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_scene_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db",
      "scene_name": "my scene",
      "enable_auto": true
    }
  ]
}

失败返回示例​

见 接口失败返回


获取场景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
scene_idStringBody是场景ID

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明​

参数名类型位置说明
scene_nameStringBody场景名称
triggers[]Object<trigger>Body触发器信息
actions[]Object<action>Body动作信息

trigger说明​

参数名类型位置说明
trigger_configStringBody触发器配置，见 场景触发器配置
trigger_typeStringBody触发器类型，见 场景触发器配置
room_tag_idStringBody房间标签ID

action说明​

参数名类型位置说明
action_configStringBody动作配置，见 场景动作配置
ability_typeStringBody能力类型
action_typeStringBody动作类型，见 场景动作配置
attributeObjectBody附加属性，见 标准物模型

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "scene_name": "my scene",
      "triggers": [
        {
          "trigger_config": "hotel",
          "trigger_type": "check_in",
          "room_tag_id": ""
        }
      ],
      "actions": [
        {
          "action_config": "device",
          "ability_type": "light",
          "action_type": "turn_all_on"
        }
      ]
    }
  ]
}

失败返回示例​

见 接口失败返回


创建场景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
scene_nameStringBody是场景名称
triggers[]Object<trigger>Body是触发器信息
actions[]Object<action>Body是动作信息

trigger说明​

参数名类型位置必填说明
trigger_configStringBody是触发器配置，见 场景触发器配置
trigger_typeStringBody是触发器类型，见 场景触发器配置
room_tag_idStringBody否房间标签ID

action说明​

参数名类型位置必填说明
action_configStringBody是动作配置，见 场景动作配置
ability_typeStringBody是能力类型
action_typeStringBody是动作类型，见 场景动作配置
attributeObjectBody否附加属性，见 标准物模型

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明​

参数名类型位置说明
scene_idStringBody场景ID

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_name": "test",
    "triggers": [
      {
        "trigger_config": "hotel",
        "trigger_type": "check_in"
      }
    ],
    "actions": [
      {
        "action_config": "device",
        "ability_type": "light",
        "action_type": "turn_all_on"
      }
    ]
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "scene_id": "sr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

失败返回示例​

见 接口失败返回


更新场景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
scene_idStringBody是场景ID
scene_nameStringBody是场景名称
triggers[]Object<trigger>Body是触发器信息
actions[]Object<action>Body是动作信息

trigger说明​

参数名类型位置必填说明
trigger_configStringBody是触发器配置，见 场景触发器配置
trigger_typeStringBody是触发器类型，见 场景触发器配置
room_tag_idStringBody否房间标签ID

action说明​

参数名类型位置必填说明
action_configStringBody是动作配置，见 场景动作配置
ability_typeStringBody是能力类型
action_typeStringBody是动作类型，见 场景动作配置
attributeObjectBody否附加属性，见 标准物模型

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "sr31adc223cc4b3bedb6bd4742dedcfa5",
    "scene_name": "test",
    "triggers": [
      {
        "trigger_config": "hotel",
        "trigger_type": "check_in"
      }
    ],
    "actions": [
      {
        "action_config": "device",
        "ability_type": "light",
        "action_type": "turn_all_on"
      }
    ]
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例​

见 接口失败返回


删除场景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
scene_idStringBody是场景ID

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例​

见 接口失败返回


手动触发场景​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
scene_idStringBody是场景ID
residences[]Object<residence>Body是住宅信息

residence说明​

参数名类型位置必填说明
residence_idStringBody是住宅ID

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "manual_trigger_scene",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s3b5a73f8dd84abaa94dcs248be49b0db",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例​

见 接口失败返回


启用自动化场景​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
scene_idStringBody是场景ID
enable_autoBooleanBody是判断是否启用自动化
true：启用
false：禁用

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "enable_auto_scene",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s3b5a73f8dd84abaa94dcs248be49b0db",
    "enable_auto": true
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例​

见 接口失败返回


获取场景历史记录​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数​

参数名类型位置必填说明
Content-TypeStringHeader是内容类型，值为application/json
AcceptStringHeader是接受类型，值为application/json
AuthorizationStringHeader是Bearer认证，访问令牌
commandStringBody是命令名称
idStringBody是命令ID
paramObject<param>Body是命令参数

param说明​

参数名类型位置必填说明
page_sizeIntegerBody是每页数量
page_indexIntegerBody是当前页数

返回参数​

参数名类型位置说明
Content-TypeStringHeader内容类型，值为application/json
successBooleanBody判断请求是否成功
true：成功
false：失败
timestampIntegerBody时间戳
result[]Object<result>Body返回结果

result说明​

参数名类型位置说明
scene_record_idStringBody场景记录ID
scene_idStringBody场景ID
scene_nameStringBody场景名称
trigger_sceneBooleanBody判断场景执行是否成功
true：成功
false：失败
residence_idStringBody住宅ID
detailObject<detail>Body详细信息

detail说明​

参数名类型位置说明
trigger_configStringBody触发器配置，见 场景触发器配置
trigger_typeStringBody触发器类型，见 场景触发器配置
room_tag_idStringBody房间标签ID
manualBooleanBody判断是否是手动触发
true：是
false：否
manual_byStringBody手动执行人

请求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_scene_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例​

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "scene_record_id": "r8b5a73f8dd84abaa94dcs248be49b0d1",
      "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db",
      "scene_name": "my scene",
      "trigger_scene": true,
      "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
      "detail": {
        "trigger_config": "hotel",
        "trigger_type": "check_in",
        "room_tag_id": "",
        "manual": false,
        "manual_by": ""
      }
    }
  ]
}

失败返回示例​

见 接口失败返回