Get Device Instruction Copy

Developing

GET

/devices/{meeting_space_id}/device-instruction

Retrieve the current status, health, and specific device metrics.

Request

Path Params

meeting_space_id

string

required

Header Params

X-API-Key

string

required

API key for authentication.

Example:

your-api-key

Body Params application/json

device_type

string

required

Example:

lock

Example

{"device_type": "lock"}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/devices//device-instruction' \
--header 'X-API-Key: your-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{"device_type": "lock"}'

Responses

🟢200OK

application/json

Successfully retrieved device status.

Body

response

object

optional

Details about the lock status.

device_instruction

object

optional

Example:

{"device":"lock","instructions":"device instructions"}

Example

{
    "response": {
        "device_instruction": {
            "device": "lock",
            "instructions": "device instructions"
        }
    }
}

🟠404Record Not Found

🔴500Server Error

Modified at 2 months ago

Fetch Associated Device Types

Check-in Operation