会議室リストのクエリ

本インターフェースを呼び出して、会議室の名称、収容可能人数、位置情報などを含む会議室リストをクエリします。

リクエスト

基本情報

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

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェース呼び出し時のアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、社内アプリの accessToken を取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリ認可企業の accessToken を取得インターフェースを呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
nextToken	Long	いいえ	ページネーションカーソル。 - 初回呼び出しの場合は、このパラメータを渡しません。 - 初回以降の呼び出しの場合は、前回呼び出し時に返された nextToken を渡します。
maxResults	Integer	いいえ	リクエストのページサイズ。デフォルトは 20、最大は 100 です。
unionId	String	はい	操作者の unionId。ユーザー詳細のクエリインターフェースを呼び出して取得できます。

リクエスト例

HTTP

GET /v1.0/rooms/meetingRoomLists?nextToken=124&maxResults=20&unionId=2iPOxxxxx 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.QueryMeetingRoomListHeaders queryMeetingRoomListHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListHeaders();
        queryMeetingRoomListHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListRequest queryMeetingRoomListRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListRequest()
                .setNextToken(124L)
                .setMaxResults(20)
                .setUnionId("2iPOxxxxx");
        try {
            client.queryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, 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 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_list_headers = dingtalkrooms__1__0_models.QueryMeetingRoomListHeaders()
        query_meeting_room_list_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_list_request = dingtalkrooms__1__0_models.QueryMeetingRoomListRequest(
            next_token=124,
            max_results=20,
            union_id='2iPOxxxxx'
        )
        try:
            client.query_meeting_room_list_with_options(query_meeting_room_list_request, query_meeting_room_list_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_list_headers = dingtalkrooms__1__0_models.QueryMeetingRoomListHeaders()
        query_meeting_room_list_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_list_request = dingtalkrooms__1__0_models.QueryMeetingRoomListRequest(
            next_token=124,
            max_results=20,
            union_id='2iPOxxxxx'
        )
        try:
            await client.query_meeting_room_list_with_options_async(query_meeting_room_list_request, query_meeting_room_list_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\QueryMeetingRoomListHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomListRequest;
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();
        $queryMeetingRoomListHeaders = new QueryMeetingRoomListHeaders([]);
        $queryMeetingRoomListHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryMeetingRoomListRequest = new QueryMeetingRoomListRequest([
            "nextToken" => 124,
            "maxResults" => 20,
            "unionId" => "2iPOxxxxx"
        ]);
        try {
            $client->queryMeetingRoomListWithOptions($queryMeetingRoomListRequest, $queryMeetingRoomListHeaders, 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
  }

  queryMeetingRoomListHeaders := &dingtalkrooms_1_0.QueryMeetingRoomListHeaders{}
  queryMeetingRoomListHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryMeetingRoomListRequest := &dingtalkrooms_1_0.QueryMeetingRoomListRequest{
    NextToken: tea.Int64(124),
    MaxResults: tea.Int32(20),
    UnionId: tea.String("2iPOxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, &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 queryMeetingRoomListHeaders = new $dingtalkrooms_1_0.QueryMeetingRoomListHeaders({ });
    queryMeetingRoomListHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryMeetingRoomListRequest = new $dingtalkrooms_1_0.QueryMeetingRoomListRequest({
      nextToken: 124,
      maxResults: 20,
      unionId: "2iPOxxxxx",
    });
    try {
      await client.queryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, 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.QueryMeetingRoomListHeaders queryMeetingRoomListHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListHeaders();
            queryMeetingRoomListHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListRequest queryMeetingRoomListRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListRequest
            {
                NextToken = 124,
                MaxResults = 20,
                UnionId = "2iPOxxxxx",
            };
            try
            {
                client.QueryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
hasMore	Boolean	さらにデータがあるかどうか。 - true：あり - false：なし
nextToken	Long	ページネーションカーソル。
result	Array	会議室リスト。
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。

レスポンスボディ例

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

{
  "hasMore" : true,
  "nextToken" : 123,
  "result" : [ {
    "roomId" : "0ffb7xxxxx",
    "roomStaffId" : "012241xxxxx",
    "corpId" : "ding994axxxx",
    "roomName" : "テスト会議室",
    "roomStatus" : 0,
    "roomLabels" : [ {
      "labelId" : 1,
      "labelName" : "テレビ"
    } ],
    "roomCapacity" : 10,
    "roomLocation" : {
      "title" : "xxx企業",
      "desc" : "xx市xx区xx町xx番地"
    },
    "roomPicture" : "https://static.dingtalk.io/media/lADPxxxxx.jpg",
    "isvRoomId" : "xxxIsvRoomId",
    "roomGroup" : {
      "groupId" : 1,
      "groupName" : "テストグループ",
      "parentId" : 0
    }
  } ]
}

エラーコード

本インターフェース呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を確認してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	param.error	Param Error	パラメータ欠落エラー
400	user.not.employee	User Not Employee	ユーザーが企業に所属していません
400	org.not.found	Org Not Found	企業が見つかりません
500	system.error	System Error	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード