ビデオ会議デバイス情報の照会

本 API を呼び出して、ビデオ会議デバイス情報を照会します。

API 呼び出し説明

本 API を呼び出す前に、イベントサブスクリプションを導入し、デバイスと会議室のバインド変更イベントをサブスクライブする必要があります。

リクエスト

基本情報

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

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	本 API を呼び出すためのアクセス認証情報。社内アプリの access_token を取得する API を呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
operatorUnionId	String	必須	操作を行うメンバーの unionId。ユーザー詳細の照会 API を呼び出して取得します。
deviceId	String	任意	照会対象のデバイス ID。本パラメータはデバイスと会議室のバインド変更イベントのサブスクリプションから取得します。 `deviceId` フィールドと `deviceUnionId` フィールドは、いずれか一方を必ず指定してください。
deviceUnionId	String	任意	照会対象のデバイス unionId。本パラメータはデバイスと会議室のバインド変更イベントのサブスクリプションから取得します。 `deviceId` フィールドと `deviceUnionId` フィールドは、いずれか一方を必ず指定してください。

リクエスト例

HTTP

GET /v1.0/rooms/devices?operatorUnionId=lmvxxxxx&deviceId=1234&deviceUnionId=lmvUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化します
     * @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.QueryMeetingRoomDeviceHeaders queryMeetingRoomDeviceHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceHeaders();
        queryMeetingRoomDeviceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceRequest queryMeetingRoomDeviceRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceRequest()
                .setOperatorUnionId("lmvxxxxx")
                .setDeviceId("1234")
                .setDeviceUnionId("lmvUxxxxx");
        try {
            client.queryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }

        } 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
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:
        """
        トークンを使用してアカウント Client を初期化します
        @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_meeting_room_device_headers = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceHeaders()
        query_meeting_room_device_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_device_request = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceRequest(
            operator_union_id='lmvxxxxx',
            device_id='1234',
            device_union_id='lmvUxxxxx'
        )
        try:
            client.query_meeting_room_device_with_options(query_meeting_room_device_request, query_meeting_room_device_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_meeting_room_device_headers = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceHeaders()
        query_meeting_room_device_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_device_request = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceRequest(
            operator_union_id='lmvxxxxx',
            device_id='1234',
            device_union_id='lmvUxxxxx'
        )
        try:
            await client.query_meeting_room_device_with_options_async(query_meeting_room_device_request, query_meeting_room_device_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                pass

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

PHP

<?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\QueryMeetingRoomDeviceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomDeviceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント Client を初期化します
     * @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();
        $queryMeetingRoomDeviceHeaders = new QueryMeetingRoomDeviceHeaders([]);
        $queryMeetingRoomDeviceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryMeetingRoomDeviceRequest = new QueryMeetingRoomDeviceRequest([
            "operatorUnionId" => "lmvxxxxx",
            "deviceId" => "1234",
            "deviceUnionId" => "lmvUxxxxx"
        ]);
        try {
            $client->queryMeetingRoomDeviceWithOptions($queryMeetingRoomDeviceRequest, $queryMeetingRoomDeviceHeaders, 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

// 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"
)

/**
 * トークンを使用してアカウント Client を初期化します
 * @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
  }

  queryMeetingRoomDeviceHeaders := &dingtalkrooms_1_0.QueryMeetingRoomDeviceHeaders{}
  queryMeetingRoomDeviceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryMeetingRoomDeviceRequest := &dingtalkrooms_1_0.QueryMeetingRoomDeviceRequest{
    OperatorUnionId: tea.String("lmvxxxxx"),
    DeviceId: tea.String("1234"),
    DeviceUnionId: tea.String("lmvUxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, &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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
    }

  }
  return _err
}

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

Node.js

// 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 {

  /**
   * トークンを使用してアカウント Client を初期化します
   * @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 queryMeetingRoomDeviceHeaders = new $dingtalkrooms_1_0.QueryMeetingRoomDeviceHeaders({ });
    queryMeetingRoomDeviceHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryMeetingRoomDeviceRequest = new $dingtalkrooms_1_0.QueryMeetingRoomDeviceRequest({
      operatorUnionId: "lmvxxxxx",
      deviceId: "1234",
      deviceUnionId: "lmvUxxxxx",
    });
    try {
      await client.queryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
      }

    }    
  }

}

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

// 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 
    {

        /**
         * トークンを使用してアカウント Client を初期化します
         * @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.QueryMeetingRoomDeviceHeaders queryMeetingRoomDeviceHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceHeaders();
            queryMeetingRoomDeviceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceRequest queryMeetingRoomDeviceRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceRequest
            {
                OperatorUnionId = "lmvxxxxx",
                DeviceId = "1234",
                DeviceUnionId = "lmvUxxxxx",
            };
            try
            {
                client.QueryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
            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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
result	Object	レスポンス結果。
deviceId	String	デバイス ID。
deviceUnionId	String	デバイス unionId。
openRoomId	String	デバイスにバインドされている会議室 ID。
corpId	String	所属企業の組織 ID。
deviceName	String	デバイス名。
shareCode	String	デバイスの画面ミラーリングコード。
deviceSn	String	デバイスの SN コード。
deviceMac	String	デバイスの MAC アドレス。
deviceType	String	デバイスタイプ。 - touyingyi：ビデオ会議デバイス - meetingaccessory：デバイスコントローラー
deviceServiceId	Integer	デバイス登録 serviceId。
deviceModel	String	デバイス型番。
deviceStatus	String	デバイスステータス。 - idle：空き - projection：画面ミラーリング中 - conf_incoming：会議呼び出し中 - conf_running：会議中 - white_board：ホワイトボード使用中 - offline：オフライン
controllers	Array	デバイスコントローラー情報リスト。
deviceId	String	コントローラーのデバイス ID。
deviceUnionId	String	デバイスコントローラーの unionId。
openRoomId	String	デバイスコントローラーにバインドされている会議室 ID。
corpId	String	所属企業の組織 ID。
shareCode	String	デバイスコントローラーの画面ミラーリングコード。
deviceSn	String	デバイスコントローラーの SN コード。
deviceType	String	デバイスタイプ： - touyingyi：ビデオ会議デバイス - meetingaccessory：デバイスコントローラー
deviceServiceId	Integer	デバイスコントローラー登録 serviceId。
deviceModel	String	デバイスコントローラーの型番。
deviceName	String	デバイスコントローラー名。
deviceStatus	String	デバイスコントローラーのステータス。 - idle：空き - projection：画面ミラーリング中 - conf_incoming：会議呼び出し中 - conf_running：会議中 - white_board：ホワイトボード使用中 - offline：オフライン
deviceMac	String	デバイスコントローラーの MAC アドレス。
creatorUnionId	String	作成操作者。
roomName	String	所属する会議室の名前。
firmwareVersion	String	デバイスファームウェアバージョン。
softwareVersion	String	デバイスソフトウェアバージョン。
activeTime	Long	デバイスのアクティベーション日時。
devNetType	String	デバイスのネットワークタイプ。
devNetIp	String	デバイスの IP。
devWifiMac	String	デバイスの無線 MAC アドレス。
devWireMac	String	デバイスの有線 MAC アドレス。
devCamera	String	カメラ型番。
devMic	String	マイク型番。
devVoice	String	スピーカー型番。
devMirror	String	ミラーステータス。
devHdmi	String	HDMI 出力ステータス。
sipAccountName	String	SIP アカウント。

レスポンスボディ例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : {
    "deviceId" : "1234",
    "deviceUnionId" : "lmvUxxxxx",
    "openRoomId" : "7263xxxxx",
    "corpId" : "ding99xxxxx",
    "deviceName" : "DingTalk会議デバイス_xxxx",
    "shareCode" : "123456",
    "deviceSn" : "02caxxxxx",
    "deviceMac" : "14:85:7f:xx:xx:xx",
    "deviceType" : "touyingyi",
    "deviceServiceId" : 1204,
    "deviceModel" : "winbox",
    "deviceStatus" : "offline",
    "controllers" : [ {
      "deviceId" : "2345",
      "deviceUnionId" : "lmvUxxxxx",
      "openRoomId" : "7263xxxxx",
      "corpId" : "ding99xxxxx",
      "shareCode" : "234567",
      "deviceSn" : "02caxxxxx",
      "deviceType" : "touyingyi",
      "deviceServiceId" : 1190,
      "deviceModel" : "AILABS_S3_T1",
      "deviceName" : "会議コントロールタブレット_xxxx",
      "deviceStatus" : "white_board",
      "deviceMac" : "d8:2f:e6:xx:xx:xx"
    } ],
    "creatorUnionId" : "lPHhSZDLXXXXXXpBlC9lxLwiEiE",
    "roomName" : "テスト会議室",
    "firmwareVersion" : "LMVXXX.20XX0818",
    "softwareVersion" : "7.14.1",
    "activeTime" : 1697198045000,
    "devNetType" : "net_wired",
    "devNetIp" : "127.0.0.10",
    "devWifiMac" : "d4:aa:ee:e8:4d:55",
    "devWireMac" : "d4:3a:ee:aa:45:85",
    "devCamera" : "Smart Camera",
    "devMic" : "Microphone (2- Built-in Audio)",
    "devVoice" : "Speaker (2- Built-in Audio)",
    "devMirror" : "false",
    "devHdmi" : "false",
    "sipAccountName" : "sip13492"
  }
}

エラーコード

本 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策をご確認ください。

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

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ビデオ会議デバイス情報の照会

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード