Query meeting room details - DingTalk Help Center

Call this API to query the details of a meeting room, including the room name, capacity, and location.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/rooms/meetingRooms/{roomId}`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	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 used to call this API. Obtain it as follows: For an internal app, call the Obtain the access token of an internal app API. For a third-party enterprise app, call the Obtain the access token of an authorized enterprise for a third-party app API.

Path parameters

Name	Type	Required	Description
roomId	String	Yes	The meeting room ID. Call the Query the meeting room list API to obtain it.

Query parameters

Name	Type	Required	Description
unionId	String	Yes	The unionId of the operator. Call the Query user details API to obtain it.

Request example

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>Initialize the account Client with a Token</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)) {
                // The err contains the code and message attributes, 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)) {
                // The err contains the code and message attributes, which help locate the issue
            }

        }        
    }
}

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:
        """
        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_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):
                # The err contains the code and message attributes, which help locate the issue
                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):
                # The err contains the code and message attributes, which help locate the issue
                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 {

    /**
     * Initialize the account Client with 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();
        $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)) {
                // The err contains the code and message attributes, 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));

// 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:
// 
// 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
  }

  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)) {
      // The err contains the code and message attributes, which help locate the issue
    }

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

  /**
   * Initialize the account Client with a Token
   * @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)) {
        // The err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

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>Initialize the account Client with a Token</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))
                {
                    // The err contains the code and message attributes, which 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))
                {
                    // The err contains the code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
result	Object	The meeting room details.
roomId	String	The meeting room ID.
roomStaffId	String	The enterprise employee ID of the meeting room. Reserved field. Not in use.
corpId	String	The organization ID of the enterprise that the meeting room belongs to.
roomName	String	The meeting room name.
roomStatus	Integer	The meeting room status: - 0: Available to all users - 1: Available to admins only - 2: Available to specific users
roomLabels	Array	The list of meeting 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 meeting room capacity.
roomLocation	Object	The location information of the meeting room.
title	String	The name of the meeting room location.
desc	String	The detailed information of the meeting room location.
roomPicture	String	The meeting room image.
isvRoomId	String	The external meeting room ID of the caller.
roomGroup	Object	The meeting room group information.
groupId	Long	The group ID.
groupName	String	The group name.
parentId	Long	The parent group ID.
deviceUnionIds	Array of String	The list of unionIds.
reservationAuthority	Object	The reservation permissions configured for the meeting room when roomStatus is set to partial permissions.
authorizedMembers	Array	The list of users with permissions.
memberId	String	The ID of the user. Set based on memberType: User: the unionId of the user. Call the Query user details API to obtain it. Department: the department ID, dept_id. Call the Obtain the department list API to obtain it.
memberType	String	The user type: - User: user - Department: dept
memberName	String	The user name: - User: the user name - Department: the department name
enableCycleReservation	Boolean	Whether the meeting room supports recurring reservations: - true: Yes - false: No
roomUnionId	String	The unionId of the meeting room.
extensionConfig	Object	Additional configurations for the meeting room.
openReservation	Boolean	Whether the meeting room is open for reservation: - true: Yes - false: No
maxReservationTimeInterval	Integer	The maximum duration of a single reservation, in minutes. A value of 0 indicates no limit.
minReservationTimeInterval	Integer	The minimum duration of a single reservation, in minutes.
advanceReservation	Object	The earliest advance reservation time.
advanceReservationTime	Integer	The specific value of the advance reservation time. The unit is determined by the advanceReservationTimeUnit field.
advanceReservationTimeUnit	String	The time unit: - days: Days - weeks: Weeks - months: Months - years: Years
advanceBookTimeFormat	String	The specific hour.
reservationCloseDetail	Object	The details of the reservation closure.
taskStartTime	Long	The start time of the reservation closure. A timestamp in milliseconds.
taskEndTime	Long	The end time of the reservation closure. A timestamp in milliseconds. An empty value indicates a permanent closure.
closeReason	String	The reason for closing reservations.
contactUnionId	String	The unionId of the contact.
contactNick	String	The contact name.
sendNotify	Boolean	Whether to send a notification to employees who have reserved the meeting room.
approvalSwitch	Boolean	Whether the approval switch is on: - true: On - false: Off
approvalType	Integer	The approval type: - 1: Standard approval - 2: Custom approval
roomDescription	String	The meeting room description.

Response body example

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

{
  "result" : {
    "roomId" : "0ffb7184xxxxx",
    "roomStaffId" : "0122414",
    "corpId" : "ding994axxxxx",
    "roomName" : "Test meeting 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/lADxxxxx.jpg",
    "isvRoomId" : "xxxIsvRoomId",
    "roomGroup" : {
      "groupId" : 1,
      "groupName" : "Test group",
      "parentId" : 0
    },
    "deviceUnionIds" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
    "reservationAuthority" : {
      "authorizedMembers" : [ {
        "memberId" : "lPHhSZDLXXXXXXpBlC9lxLwiEiE",
        "memberType" : "user",
        "memberName" : "Zhang San"
      } ]
    },
    "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" : "Reservations temporarily closed due to renovation",
        "contactUnionId" : "2iPOLbpxxxxuwggiiqiPwiEiF",
        "contactNick" : "nick",
        "sendNotify" : true
      },
      "approvalSwitch" : false,
      "approvalType" : 1
    },
    "roomDescription" : "Add the meeting room description here"
  }
}

Error codes

If an error occurs when calling this API, refer to the Global error codes document to find a solution based on the error message.

HttpCode	Error code	Error message	Description
400	param.error	Param Error	Missing parameter error
400	org.not.found	Org Not Found	Organization not found
500	system.error	System Error	System error

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes