> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ビデオ会議デバイスの属性情報を照会

> ビデオ会議デバイスの機種、ステータス、IPアドレス、ファームウェアなどを取得します

デバイスの属性を照会します。

## API 呼び出し説明

本 API を呼び出す前に、[イベントサブスクリプション](https://open.dingtalk.com/document/development/event-subscription-overview#)を導入し、[デバイスと会議室バインディングの変更](https://open.dingtalk.com/document/development/org-event-overview#)イベントを購読する必要があります。

## リクエスト

### 基本情報

| フィールド       | 値                                                                                                                          |
| ----------- | -------------------------------------------------------------------------------------------------------------------------- |
| HTTP URL    | [https://api.dingtalk.io/v1.0/rooms/devices/properties/query](https://api.dingtalk.io/v1.0/rooms/devices/properties/query) |
| HTTP Method | POST                                                                                                                       |
| 対応アプリタイプ    | appType-社内アプリ                                                                                                              |
| 必要な権限       | permission-VideoConference.Conference.Read-ビデオ会議情報の読み取り権限                                                                  |

### リクエストヘッダー

| 名前                          | タイプ    | 必須 | 説明                                                                                                                               |
| --------------------------- | ------ | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | 必須 | この API を呼び出すためのアクセス認証情報です。[社内アプリのアクセストークンを取得](/ja/open/development/obtain-the-access-token-of-an-internal-app#) API を呼び出して取得します。 |

### クエリパラメータ

| 名前              | タイプ    | 必須 | 説明                                                                                                                            |
| --------------- | ------ | -- | ----------------------------------------------------------------------------------------------------------------------------- |
| operatorUnionId | String | 必須 | 照会操作を行うメンバーの unionId です。[ユーザー詳細を照会](/ja/open/development/query-user-details#) API を呼び出して取得します。                                |
| deviceId        | String | 任意 | 照会対象のデバイス ID です。[デバイスと会議室バインディングの変更](https://open.dingtalk.com/document/development/org-event-overview#)イベントの購読により取得します。      |
| deviceUnionId   | String | 任意 | 照会対象のデバイス unionId です。[デバイスと会議室バインディングの変更](https://open.dingtalk.com/document/development/org-event-overview#)イベントの購読により取得します。 |

### リクエストボディ

| 名前            | タイプ             | 必須 | 説明                                                                                                                                                                                                                                                                                                                         |
| ------------- | --------------- | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| propertyNames | Array of 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：デバイス外付けディスプレイ |

### リクエスト例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/rooms/devices/properties/query?operatorUnionId=lmvUxxxxx&deviceId=1234&deviceUnionId=lRkpxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "propertyNames" : [ "dev_wifi_mac" ]
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client using a token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkrooms_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkrooms_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkrooms_1_0.models.QueryDevicePropertiesHeaders queryDevicePropertiesHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryDevicePropertiesHeaders();
        queryDevicePropertiesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.QueryDevicePropertiesRequest queryDevicePropertiesRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryDevicePropertiesRequest()
                .setOperatorUnionId("lmvUxxxxx")
                .setDeviceId("1234")
                .setDeviceUnionId("lRkpxxxxx")
                .setPropertyNames(java.util.Arrays.asList(
                    "dev_wifi_mac"
                ));
        try {
            client.queryDevicePropertiesWithOptions(queryDevicePropertiesRequest, queryDevicePropertiesHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help locate the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.rooms_1_0.client import Client as dingtalkrooms_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.rooms_1_0 import models as dingtalkrooms__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkrooms_1_0Client:
        """
        Initialize the account Client using a token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkrooms_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_device_properties_headers = dingtalkrooms__1__0_models.QueryDevicePropertiesHeaders()
        query_device_properties_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_device_properties_request = dingtalkrooms__1__0_models.QueryDevicePropertiesRequest(
            operator_union_id='lmvUxxxxx',
            device_id='1234',
            device_union_id='lRkpxxxxx',
            property_names=[
                'dev_wifi_mac'
            ]
        )
        try:
            client.query_device_properties_with_options(query_device_properties_request, query_device_properties_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_device_properties_headers = dingtalkrooms__1__0_models.QueryDevicePropertiesHeaders()
        query_device_properties_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_device_properties_request = dingtalkrooms__1__0_models.QueryDevicePropertiesRequest(
            operator_union_id='lmvUxxxxx',
            device_id='1234',
            device_union_id='lRkpxxxxx',
            property_names=[
                'dev_wifi_mac'
            ]
        )
        try:
            await client.query_device_properties_with_options_async(query_device_properties_request, query_device_properties_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryDevicePropertiesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryDevicePropertiesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $queryDevicePropertiesHeaders = new QueryDevicePropertiesHeaders([]);
        $queryDevicePropertiesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryDevicePropertiesRequest = new QueryDevicePropertiesRequest([
            "operatorUnionId" => "lmvUxxxxx",
            "deviceId" => "1234",
            "deviceUnionId" => "lRkpxxxxx",
            "propertyNames" => [
                "dev_wifi_mac"
            ]
        ]);
        try {
            $client->queryDevicePropertiesWithOptions($queryDevicePropertiesRequest, $queryDevicePropertiesHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message properties to help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkrooms_1_0  "github.com/alibabacloud-go/dingtalk/rooms_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client using a token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkrooms_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkrooms_1_0.Client{}
  _result, _err = dingtalkrooms_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  queryDevicePropertiesHeaders := &dingtalkrooms_1_0.QueryDevicePropertiesHeaders{}
  queryDevicePropertiesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryDevicePropertiesRequest := &dingtalkrooms_1_0.QueryDevicePropertiesRequest{
    OperatorUnionId: tea.String("lmvUxxxxx"),
    DeviceId: tea.String("1234"),
    DeviceUnionId: tea.String("lRkpxxxxx"),
    PropertyNames: []*string{tea.String("dev_wifi_mac")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryDevicePropertiesWithOptions(queryDevicePropertiesRequest, queryDevicePropertiesHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message properties to help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkrooms_1_0, * as $dingtalkrooms_1_0 from '@alicloud/dingtalk/rooms_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client using a token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkrooms_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkrooms_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let queryDevicePropertiesHeaders = new $dingtalkrooms_1_0.QueryDevicePropertiesHeaders({ });
    queryDevicePropertiesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryDevicePropertiesRequest = new $dingtalkrooms_1_0.QueryDevicePropertiesRequest({
      operatorUnionId: "lmvUxxxxx",
      deviceId: "1234",
      deviceUnionId: "lRkpxxxxx",
      propertyNames: [
        "dev_wifi_mac"
      ],
    });
    try {
      await client.queryDevicePropertiesWithOptions(queryDevicePropertiesRequest, queryDevicePropertiesHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties to help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /**
         * Initialize the account Client using a token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkrooms_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkrooms_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryDevicePropertiesHeaders queryDevicePropertiesHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryDevicePropertiesHeaders();
            queryDevicePropertiesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryDevicePropertiesRequest queryDevicePropertiesRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryDevicePropertiesRequest
            {
                OperatorUnionId = "lmvUxxxxx",
                DeviceId = "1234",
                DeviceUnionId = "lRkpxxxxx",
                PropertyNames = new List<string>
                {
                    "dev_wifi_mac"
                },
            };
            try
            {
                client.QueryDevicePropertiesWithOptions(queryDevicePropertiesRequest, queryDevicePropertiesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate the issue
                }
            }
        }

    }
}
```

## レスポンス

### レスポンスボディ

| 名前            | タイプ    | 説明                                                                                                                                                                                                                                                                                                                                                                                           |
| ------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| result        | Array  | レスポンス結果情報のリスト。                                                                                                                                                                                                                                                                                                                                                                               |
| 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 | デバイス属性値。                                                                                                                                                                                                                                                                                                                                                                                     |

### レスポンスボディ例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : [ {
    "propertyName" : "dev_app_status",
    "propertyValue" : "idle"
  } ]
}
```

### エラーコード

API 呼び出し時にエラーが発生した場合、エラーメッセージをもとに[グローバルエラーコード](/ja/open/development/server-api-error-codes-1)ドキュメントから解決方法を検索してください。

| HttpCode | エラーコード           | エラーメッセージ         | 説明                        |
| -------- | ---------------- | ---------------- | ------------------------- |
| 400      | device.not.found | device not found | デバイスが存在しません               |
| 400      | param.error      | param error      | operatorUnionId パラメータが空です |
| 403      | no.permission    | no permission    | 照会権限がありません                |
| 500      | system.error     | system error     | システムエラー                   |
