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 |
| HTTP Method | GET |
| Supported app types | appType-Internal app |
| Permissions | permission-VideoConference.Conference.Read-Read permission for video conference information |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. To obtain the value, call the Get the access token of an internal app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorUnionId | String | Yes | The unionId of the operator who performs the query. To obtain the value, call the Query user details API. |
| deviceId | String | No | The ID of the device to query. Obtain the value by subscribing to the Device-room binding change event. Specify either deviceId or deviceUnionId. |
| deviceUnionId | String | No | The unionId of the device to query. Obtain the value by subscribing to the Device-room binding change event. Specify either deviceId or deviceUnionId. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| result | Object | The response result. |
| deviceId | String | The device ID. |
| deviceUnionId | String | The device unionId. |
| openRoomId | String | The ID of the room bound to the device. |
| corpId | String | The organization ID. |
| deviceName | String | The device name. |
| shareCode | String | The cast code of the device. |
| deviceSn | String | The serial number of the device. |
| deviceMac | String | The MAC address of the device. |
| deviceType | String | The device type. - touyingyi: Video Meeting device - meetingaccessory: Device controller |
| deviceServiceId | Integer | The service ID assigned when the device was registered. |
| deviceModel | String | The device model. |
| deviceStatus | String | The device status. - idle: Free - projection: Casting - conf_incoming: Meeting ringing - conf_running: In Meeting - white_board: Using Whiteboard - offline: Offline |
| controllers | Array | The list of device controllers. |
| deviceId | String | The controller device ID. |
| deviceUnionId | String | The unionId of the device controller. |
| openRoomId | String | The ID of the room bound to the device controller. |
| corpId | String | The organization ID. |
| shareCode | String | The cast code of the device controller. |
| deviceSn | String | The serial number of the device controller. |
| deviceType | String | The device type: - touyingyi: Video Meeting device - meetingaccessory: Device controller |
| deviceServiceId | Integer | The service ID assigned when the device controller was registered. |
| deviceModel | String | The model of the device controller. |
| deviceName | String | The name of the device controller. |
| deviceStatus | String | The status of the device controller. - idle: Free - projection: Casting - conf_incoming: Meeting ringing - conf_running: In Meeting - white_board: Using Whiteboard - offline: Offline |
| deviceMac | String | The MAC address of the device controller. |
| creatorUnionId | String | The operator who created the device. |
| roomName | String | The name of the room to which the device belongs. |
| firmwareVersion | String | The firmware version of the device. |
| softwareVersion | String | The software version of the device. |
| activeTime | Long | The activation time of the device. |
| devNetType | String | The network type of the device. |
| devNetIp | String | The IP address of the device. |
| devWifiMac | String | The wireless MAC address of the device. |
| devWireMac | String | The wired MAC address of the device. |
| devCamera | String | The camera model. |
| devMic | String | The microphone model. |
| devVoice | String | The speaker model. |
| devMirror | String | The mirroring status. |
| devHdmi | String | The HDMI output status. |
| sipAccountName | String | The SIP account. |
Response body example
Error codes
If an error occurs when calling this API, look up the solution by the error message in the Global error codes document.| 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. |