Skip to content

List scenes ​

GET /clip/v2/resource/scene

List scenes on the gateway. To filter by room, pass the room UUID in room_uuid, as shown in the request body below.

Example request

json
{
  "room_uuid": "string"
}

Parameters ​

FieldLocationTypeRequiredDescription
room_uuidbodystringYesRoom ID

Example response

json
{
  "code": 0,
  "data": {
    "arr": [
      {
        "id": "3EBD2DB5-B946-4BBA-B678-C7B7C6BA4D0F",
        "type": "scene",
        "parent_id": "2F84620F-C289-4AA3-8A1E-D6DE9C33D1F5",
        "parent_type": "group_light",
        "name": "端午龙舟",
        "scene_type": 2,
        "is_active": 1,
        "picture_id": "E423E110-0398-4FFB-9E3D-E8E3A1CEEEEB",
        "picture_type": "file",
        "picture_url": "http://192.168.41.110:8000/20240829_173416_E423E110-0398-4FFB-9E3D-E8E3A1CEEEEB.png",
        "icon": "",
        "background": "",
        "sequence": 0,
        "colors": [
          4293551661,
          4292219417,
          4293890993,
          4283345655,
          4288215906
        ]
      }
    ],
    "len": 1,
    "obj": {}
  },
  "msg": "success"
}

Responses ​

Status codeMeaning
200OK

Response fields ​

HTTP 200 OK

FieldTypeRequiredDescription
codeintegerYesResult code.
msgstringYesResponse message.
dataobjectYesResponse payload.
data.arrobject[]YesReturned resources.
data.arr[].idstringYesScene ID
data.arr[].typestringYesAlways scene.
data.arr[].parent_idstringYesParent resource
data.arr[].parent_typestringYesAlways group_light.
data.arr[].namestringYesName
data.arr[].scene_typeintegerYes1 for a color scene; 2 for an image scene.
data.arr[].is_activeintegerYes1 if active; otherwise 0.
data.arr[].picture_idstringYesImage. Used for image scenes.
data.arr[].picture_typestringYesAlways file.
data.arr[].picture_urlstringYesImage URL
data.arr[].iconstringYesFor BweeApp use only.
data.arr[].backgroundstringYesFor BweeApp use only.
data.arr[].sequenceintegerYesFor BweeApp use only.
data.arr[].colorsinteger[]YesFor BweeApp use only.