API call description
Before calling this API, subscribe to the Device-Room binding change event through event subscription.Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/rooms/devices/properties/query |
| HTTP Method | POST |
| Supported app type | appType-Internal app |
| Required permission | permission-VideoConference.Conference.Read-Read permission for Video Meeting information |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it by calling the Get the access token of an internal app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorUnionId | String | Yes | The unionId of the operator performing the query. Obtain it by calling the Query user details API. |
| deviceId | String | No | The ID of the device to query. Obtain this parameter from the subscribed Device-Room binding change event. |
| deviceUnionId | String | No | The unionId of the device to query. Obtain this parameter from the subscribed Device-Room binding change event. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| propertyNames | Array of String | No | The list of device property names. Maximum: 10. - dev_code: Cast code - dev_model: Device model - dev_app_status: Device status - dev_net_ip: Device IP address - dev_net_type: Device network type - dev_wifi_mac: Device wireless MAC address - dev_wire_mac: Device wired MAC address - dev_firmware_v: Device firmware version - dev_software_v: Device software version - dev_hdmi: Device external display |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| result | Array | The list of response result information. |
| propertyName | String | The device property name. - dev_code: Cast code - dev_model: Device model - dev_app_status: Device status - dev_net_ip: Device IP address - dev_net_type: Device network type. Possible values: - net_wired: Wired network - net_offline: Offline - A specific SSID: Wi-Fi - dev_wifi_mac: Device wireless MAC address - dev_wire_mac: Device wired MAC address - dev_firmware_v: Device firmware version - dev_software_v: Device software version - dev_hdmi: Device external display |
| propertyValue | String | The device property value. |
Response body example
Error codes
If an error occurs when calling this API, refer to the Global error codes document for solutions based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | device.not.found | device not found | The device does not exist. |
| 400 | param.error | param error | The operatorUnionId parameter is empty. |
| 403 | no.permission | no permission | No query permission. |
| 500 | system.error | system error | System error. |