> ## 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. # Query the list of rooms > Call this API to query the list of meeting rooms, returning each room's name, capacity, and location information. Call this API to query the list of rooms, including the room name, capacity, and location. ## Request ### Basic information | Field | Value | | -------------------- | ---------------------------------------------------------------------------------------------------------- | | HTTP URL | [https://api.dingtalk.io/v1.0/rooms/meetingRoomLists](https://api.dingtalk.io/v1.0/rooms/meetingRoomLists) | | HTTP Method | GET | | Supported app types | appType-Internal app　appType-Third-party enterprise app | | Permissions required | permission-VideoConference.Conference.Read-Read permission for Video Meeting information | ### Request headers | Name | Type | Required | Description | | --------------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. - For a third-party enterprise app, call the [Get the access token of an organization authorized to a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. | ### Query parameters | Name | Type | Required | Description | | ---------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | nextToken | Long | No | The pagination cursor. - Leave this parameter empty for the first call. - For subsequent calls, pass the nextToken returned by the previous call. | | maxResults | Integer | No | The page size. Default: 20. Maximum: 100. | | unionId | String | Yes | The unionId of the operator. Obtain it by calling the [Query user details](/open/development/query-user-details#) API. | ### Request example HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 ```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 with 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 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 = ""; 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 contains code and message properties, which 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, which 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 with 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_meeting_room_list_headers = dingtalkrooms__1__0_models.QueryMeetingRoomListHeaders() query_meeting_room_list_headers.x_acs_dingtalk_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 contains code and message properties, which help locate the issue 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 = '' 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 contains code and message properties, which help locate the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 = ""; $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 contains code and message properties, which 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 with 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 } queryMeetingRoomListHeaders := &dingtalkrooms_1_0.QueryMeetingRoomListHeaders{} queryMeetingRoomListHeaders.XAcsDingtalkAccessToken = tea.String("") 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 contains code and message properties, which 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 with 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 { let client = Client.createClient(); let queryMeetingRoomListHeaders = new $dingtalkrooms_1_0.QueryMeetingRoomListHeaders({ }); queryMeetingRoomListHeaders.xAcsDingtalkAccessToken = ""; 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 contains code and message properties, which 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 with 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.QueryMeetingRoomListHeaders queryMeetingRoomListHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListHeaders(); queryMeetingRoomListHeaders.XAcsDingtalkAccessToken = ""; 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 contains code and message properties, which help locate the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message properties, which help locate the issue } } } } } ``` ## Response ### Response body | Name | Type | Description | | ------------ | ------- | --------------------------------------------------------------------------------------------------------------------- | | hasMore | Boolean | Whether more results are available. - **true**: Yes - **false**: No | | nextToken | Long | The pagination cursor. | | result | Array | The list of rooms. | | roomId | String | The room ID. | | roomStaffId | String | The employee ID of the room within the organization. Reserved field. Not currently used. | | corpId | String | The organization ID (CorpId) the room belongs to. | | roomName | String | The room name. | | roomStatus | Integer | The room status. - **0**: Visible to all members - **1**: Visible to admins only - **2**: Visible to selected users | | roomLabels | Array | The list of room tags. | | labelId | Long | The tag ID. - **1**: TV - **2**: Phone - **3**: Projector - **4**: Whiteboard - **5**: Video Meeting | | labelName | String | The tag name. | | roomCapacity | Integer | The room capacity. | | roomLocation | Object | The room location. | | title | String | The location name of the room. | | desc | String | The detailed location information of the room. | | roomPicture | String | The room image. | | isvRoomId | String | The external room ID of the caller. | | roomGroup | Object | The room group information. | | groupId | Long | The group ID. | | groupName | String | The group name. | | parentId | Long | The parent group ID. | ### Response body example ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "hasMore" : true, "nextToken" : 123, "result" : [ { "roomId" : "0ffb7xxxxx", "roomStaffId" : "012241xxxxx", "corpId" : "ding994axxxx", "roomName" : "Test room", "roomStatus" : 0, "roomLabels" : [ { "labelId" : 1, "labelName" : "TV" } ], "roomCapacity" : 10, "roomLocation" : { "title" : "xxx Company", "desc" : "No. xx, xx Street, xx District, xx City" }, "roomPicture" : "https://static.dingtalk.io/media/lADPxxxxx.jpg", "isvRoomId" : "xxxIsvRoomId", "roomGroup" : { "groupId" : 1, "groupName" : "Test group", "parentId" : 0 } } ] } ``` ### Error codes If an error occurs when calling this API, refer to the [Global error codes](/open/development/server-api-error-codes-1) document for solutions based on the error message. | HttpCode | Error code | Error message | Description | | -------- | ----------------- | ----------------- | ------------------------------- | | 400 | param.error | Param Error | Parameter missing error | | 400 | user.not.employee | User Not Employee | User is not in the organization | | 400 | org.not.found | Org Not Found | Organization not found | | 500 | system.error | System Error | System error |