会議室詳細の照会

本インターフェースを呼び出して、会議室名、収容可能人数、位置情報などの会議室詳細を照会します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/rooms/meetingRooms/{roomId}`
HTTP Method	GET
サポートされるアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-VideoConference.Conference.Read-ビデオ会議情報の読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	当該インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。社内アプリの場合は、社内アプリの access_token を取得するインターフェースを呼び出して取得します。サードパーティ社内アプリの場合は、サードパーティアプリで権限付与された企業の access_token を取得するインターフェースを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
roomId	String	はい	会議室 ID。会議室リストの照会インターフェースを呼び出して取得できます。

クエリパラメータ

名前	タイプ	必須	説明
unionId	String	はい	操作者の unionId。ユーザー詳細の照会インターフェースを呼び出して取得できます。

リクエスト例

HTTP

GET /v1.0/rooms/meetingRooms/0ffb7xxxxx?unionId=2iPOLxxxxx 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 {

    /**
     * <b>description</b> :
     * <p>トークンを使用してアカウント Client を初期化します</p>
     * @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 {
        
        com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomHeaders queryMeetingRoomHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomHeaders();
        queryMeetingRoomHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomRequest queryMeetingRoomRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomRequest()
                .setUnionId("2iPOLxxxxx");
        try {
            client.queryMeetingRoomWithOptions("0ffb7xxxxx", queryMeetingRoomRequest, queryMeetingRoomHeaders, 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_headers = dingtalkrooms__1__0_models.QueryMeetingRoomHeaders()
        query_meeting_room_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_request = dingtalkrooms__1__0_models.QueryMeetingRoomRequest(
            union_id='2iPOLxxxxx'
        )
        try:
            client.query_meeting_room_with_options('0ffb7xxxxx', query_meeting_room_request, query_meeting_room_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_headers = dingtalkrooms__1__0_models.QueryMeetingRoomHeaders()
        query_meeting_room_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_request = dingtalkrooms__1__0_models.QueryMeetingRoomRequest(
            union_id='2iPOLxxxxx'
        )
        try:
            await client.query_meeting_room_with_options_async('0ffb7xxxxx', query_meeting_room_request, query_meeting_room_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\QueryMeetingRoomHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomRequest;
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();
        $queryMeetingRoomHeaders = new QueryMeetingRoomHeaders([]);
        $queryMeetingRoomHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryMeetingRoomRequest = new QueryMeetingRoomRequest([
            "unionId" => "2iPOLxxxxx"
        ]);
        try {
            $client->queryMeetingRoomWithOptions("0ffb7xxxxx", $queryMeetingRoomRequest, $queryMeetingRoomHeaders, 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 (
  "encoding/json"
  "strings"
  "fmt"
  "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"
)

// Description:
// 
// トークンを使用してアカウント 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
  }

  queryMeetingRoomHeaders := &dingtalkrooms_1_0.QueryMeetingRoomHeaders{}
  queryMeetingRoomHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryMeetingRoomRequest := &dingtalkrooms_1_0.QueryMeetingRoomRequest{
    UnionId: tea.String("2iPOLxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryMeetingRoomWithOptions(tea.String("0ffb7xxxxx"), queryMeetingRoomRequest, queryMeetingRoomHeaders, &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

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkrooms_1_0 = require('@alicloud/dingtalk/rooms_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * トークンを使用してアカウント Client を初期化します
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkrooms_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let queryMeetingRoomHeaders = new dingtalkrooms_1_0.QueryMeetingRoomHeaders({ });
    queryMeetingRoomHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let queryMeetingRoomRequest = new dingtalkrooms_1_0.QueryMeetingRoomRequest({
      unionId: '2iPOLxxxxx',
    });
    try {
      await client.queryMeetingRoomWithOptions('0ffb7xxxxx', queryMeetingRoomRequest, queryMeetingRoomHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>トークンを使用してアカウント Client を初期化します</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.QueryMeetingRoomHeaders queryMeetingRoomHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomHeaders();
            queryMeetingRoomHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomRequest queryMeetingRoomRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomRequest
            {
                UnionId = "2iPOLxxxxx",
            };
            try
            {
                client.QueryMeetingRoomWithOptions("0ffb7xxxxx", queryMeetingRoomRequest, queryMeetingRoomHeaders, 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	会議室の詳細。
roomId	String	会議室 ID。
roomStaffId	String	会議室の企業社員 ID。予約フィールドであり、現時点では使用シーンはありません。
corpId	String	会議室が所属する企業の CorpId。
roomName	String	会議室名。
roomStatus	Integer	会議室のステータス： - 0：全員利用可能 - 1：管理者のみ利用可能 - 2：一部権限付与
roomLabels	Array	会議室タグのリスト。
labelId	Long	タグ ID： - 1：テレビ - 2：電話番号 - 3：プロジェクター - 4：ホワイトボード - 5：ビデオ会議
labelName	String	タグ名。
roomCapacity	Integer	会議室の収容可能人数。
roomLocation	Object	会議室の位置情報。
title	String	会議室の位置名称。
desc	String	会議室の位置詳細情報。
roomPicture	String	会議室の画像。
isvRoomId	String	呼び出し元の外部会議室 ID。
roomGroup	Object	会議室のグループ分け情報。
groupId	Long	グループ ID。
groupName	String	グループ名。
parentId	Long	親グループ ID。
deviceUnionIds	Array of String	UnionId のリスト。
reservationAuthority	Object	roomStatus が一部権限の場合に設定する会議室の予約権限。
authorizedMembers	Array	権限を持つユーザーのリスト。
memberId	String	ユーザーの ID。memberType による設定：メンバー：ユーザーの unionId。ユーザー詳細の照会インターフェースを呼び出して取得できます。部門：部門 ID（dept_id）。部門リストの取得インターフェースを呼び出して取得できます。
memberType	String	ユーザーのタイプ： - メンバー：user - 部門：dept
memberName	String	ユーザーの名称： - メンバー：ユーザーの名前 - 部門：部門名
enableCycleReservation	Boolean	会議室が繰り返し周期予約をサポートするかどうか： - true：はい - false：いいえ
roomUnionId	String	会議室の unionId。
extensionConfig	Object	会議室のその他の設定。
openReservation	Boolean	会議室を予約可能にするかどうか： - true：はい - false：いいえ
maxReservationTimeInterval	Integer	1 回あたり予約可能な最長時間（分単位）。値が 0 の場合は無制限を意味します。
minReservationTimeInterval	Integer	1 回あたり予約可能な最小時間（分単位）。
advanceReservation	Object	予約可能な最大事前期間。
advanceReservationTime	Integer	事前予約可能時間の具体的な値。単位は advanceReservationTimeUnit フィールドを参照してください。
advanceReservationTimeUnit	String	時間単位： - days：日を表す - weeks：週を表す - months：月を表す - years：年を表す
advanceBookTimeFormat	String	何時まで精確に指定するか。
reservationCloseDetail	Object	予約停止の詳細情報。
taskStartTime	Long	会議室の予約を停止する開始時刻。タイムスタンプ（ミリ秒）。
taskEndTime	Long	会議室の予約を停止する終了時刻。タイムスタンプ（ミリ秒）。値が空の場合は永久停止を意味します。
closeReason	String	予約を停止する理由。
contactUnionId	String	連絡先の unionId。
contactNick	String	連絡先の名前。
sendNotify	Boolean	既に会議室を予約済みの社員に通知を送信するかどうか。
approvalSwitch	Boolean	承認スイッチをオンにするかどうか - true：オン - false：オフ
approvalType	Integer	承認タイプ： - 1：標準承認 - 2：カスタム承認
roomDescription	String	会議室の説明情報。

レスポンスボディ例

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

{
  "result" : {
    "roomId" : "0ffb7184xxxxx",
    "roomStaffId" : "0122414",
    "corpId" : "ding994axxxxx",
    "roomName" : "テスト会議室",
    "roomStatus" : 0,
    "roomLabels" : [ {
      "labelId" : 1,
      "labelName" : "テレビ"
    } ],
    "roomCapacity" : 10,
    "roomLocation" : {
      "title" : "xxx企業",
      "desc" : "xx市xx区xx町xx号"
    },
    "roomPicture" : "https://static.dingtalk.io/media/lADxxxxx.jpg",
    "isvRoomId" : "xxxIsvRoomId",
    "roomGroup" : {
      "groupId" : 1,
      "groupName" : "テストグループ",
      "parentId" : 0
    },
    "deviceUnionIds" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
    "reservationAuthority" : {
      "authorizedMembers" : [ {
        "memberId" : "lPHhSZDLXXXXXXpBlC9lxLwiEiE",
        "memberType" : "user",
        "memberName" : "山田太郎"
      } ]
    },
    "enableCycleReservation" : false,
    "roomUnionId" : "DtB8VDzXXXXXX41rgiE",
    "extensionConfig" : {
      "openReservation" : true,
      "maxReservationTimeInterval" : 60,
      "minReservationTimeInterval" : 15,
      "advanceReservation" : {
        "advanceReservationTime" : 3,
        "advanceReservationTimeUnit" : "days",
        "advanceBookTimeFormat" : "09:00"
      },
      "reservationCloseDetail" : {
        "taskStartTime" : 1740463800000,
        "taskEndTime" : 1740045030000,
        "closeReason" : "改装のため一時的に予約を停止します",
        "contactUnionId" : "2iPOLbpxxxxuwggiiqiPwiEiF",
        "contactNick" : "nick",
        "sendNotify" : true
      },
      "approvalSwitch" : false,
      "approvalType" : 1
    },
    "roomDescription" : "ここに会議室の説明情報を追加します"
  }
}

エラーコード

当該インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	param.error	Param Error	パラメータ欠落エラー
400	org.not.found	Org Not Found	企業が見つかりません
500	system.error	System Error	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード