Get Room Device List

Last Updated on : 2025-05-28 10:15:30download

Based on the unique identifier (ID) of a room, get the device information of the specific device type under the room, such as locks and card issuers.

API address

GET: /v1.0/osaas/rooms/{room_id}/card-issue-devices

Request parameter

Parameter name	Type	IN	Required	Description
room_id	String	uri	true	The unique ID of a specified room.
request	LockCardDevicePageRequest		false	The request of getting a list of devices under a specified room.

Description of request

Parameter name	Type	Required	Description
page_no	Integer	false	The page number. The page number must be greater than `0`. Default value: `1`.
page_size	Integer	false	The number of items returned on each page. `0` < `page_size` < `1000`. Default value: `20`.
device_type	String	true	The product type. Valid values: `FKQ`: card issuer. `CARD_LOCK`: door lock that can be locked and unlocked with the card.

Return parameter

Parameter name	Type	Description
result	DeviceAbilityPageResponse	The returned list of devices on pages.

Description of result

Parameter name	Type	Description
devices	List	The list of devices.
total	Integer	The total number of returned items.
page_no	Integer	The page number.
page_size	Integer	The number of items returned on each page.

Description of devices

Parameter name	Type	Description
device_id	String	The unique ID of a specified device.
product_id	String	The unique ID of a specified product.
device_custom_name	String	The custom name of a specified device.
active_time	Long	The 13-digit timestamp of the activation time.
gmt_create	Long	The 13-digit timestamp of the creation time.
online	Boolean	The online status of a specified device.
room_id	String	The unique ID of a specified room.
project_id	String	The unique ID of a specified project.

Request example

GET: /v1.0/osaas/rooms/150188910571223***/card-issue-devices

Return example

{
    "tid": "bc9997990e3d11ed8a61ba62b***",
    "result": {
        "devices": [
            {
                "gmt_create": 1658454190642,
                "room_id": "15492738413169***",
                "device_id": "6c470253258246b9***",
                "project_id": "150188910571***",
                "product_id": "esddz***",
                "device_custom_name": "Zigbee lock for hotel use",
                "online": true,
                "position": "Bedroom"
            }
        ],
        "page_no": 1,
        "total": 2,
        "page_size": 20
    },
    "t": 1658989384437,
    "success": true
}

Error code

For more information, see error code.