查询视频会议设备属性信息

POST

/v1.0/rooms/devices/properties/query

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，查询视频会议设备属性信息。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	视频会议应用会议读权限	API Explorer
第三方企业应用	暂不支持	视频会议应用会议读权限	暂不支持
第三方个人应用	暂不支持	视频会议应用会议读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	device.not.found	device not found	设备不存在
400	param.error	param error	operatorUnionId参数为空
403	no.permission	no permission	无查询权限
500	system.error	system error	系统错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/rooms/devices/properties/query?operatorUnionId=String&deviceId=String&deviceUnionId=String' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "propertyNames" : [ "String" ]
}'

响应示例

{
  "result": [
    {
      "propertyName": "string",
      "propertyValue": "string"
    }
  ]
}

请求参数

Query 参数

operatorUnionId

string

必需

操作查询的人员unionId，可调用查询用户详情接口获取。

示例值:

String

deviceId

string

可选

需要查询的设备ID，该参数可从订阅设备绑定会议室变更事件中获取。

示例值:

String

deviceUnionId

string

可选

需要查询的设备unionId，该参数可从订阅设备绑定会议室变更事件中获取。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

propertyNames

array[string]

可选

设备属性名称列表，最大值10。 dev_code：投屏码 dev_model：设备型号 dev_app_status：设备状态 dev_net_ip：设备ip dev_net_type：设备网络类型 dev_wifi_mac：设备无线mac地址 dev_wire_mac：设备有线mac地址 dev_firmware_v：设备固件版本 dev_software_v：设备软件版本 dev_hdmi：设备外接显示器

示例

返回响应

🟢200成功

application/json

Body

result

array [object {2}]

响应结果信息列表。

必需

propertyName

string

可选

设备属性名称。 dev_code：投屏码 dev_model：设备型号 dev_app_status：设备状态 dev_net_ip：设备ip dev_net_type：设备网络类型，该属性有以下值： net_wired：有线网络 net_offline：离线具体的ssid：Wi-Fi dev_wifi_mac：设备无线mac地址 dev_wire_mac：设备有线mac地址 dev_firmware_v：设备固件版本 dev_software_v：设备软件版本 dev_hdmi：设备外接显示器

propertyValue

string

设备属性值。

可选

修改于 2024-01-16 08:28:17

查询视频会议设备信息

创建会议室分组

查询视频会议设备属性信息

权限#

错误码#

请求参数

返回响应

权限

错误码