Skip to main content
Call this API to obtain the details of a specified meeting room group, including the group name, group ID, and parent group ID.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/rooms/groups/{groupId}
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-VideoConference.Conference.Read-Read permission for Video Meeting information

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe 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 the authorized enterprise API.

Path parameters

NameTypeRequiredDescription
groupIdLongYesThe group ID. You can obtain it by calling the Query meeting room group list API.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. You can obtain it by calling the Query user details API.

Request example

HTTP
GET /v1.0/rooms/groups/172?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 {

    /**
     * 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<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomGroupHeaders queryMeetingRoomGroupHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomGroupHeaders();
        queryMeetingRoomGroupHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomGroupRequest queryMeetingRoomGroupRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomGroupRequest()
                .setUnionId("2iPOLxxxxx");
        try {
            client.queryMeetingRoomGroupWithOptions("172", queryMeetingRoomGroupRequest, queryMeetingRoomGroupHeaders, 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 object contains the 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)) {
                // The err object contains the code and message properties, which help locate the issue
            }

        }        
    }
}
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:
        """
        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_group_headers = dingtalkrooms__1__0_models.QueryMeetingRoomGroupHeaders()
        query_meeting_room_group_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_group_request = dingtalkrooms__1__0_models.QueryMeetingRoomGroupRequest(
            union_id='2iPOLxxxxx'
        )
        try:
            client.query_meeting_room_group_with_options('172', query_meeting_room_group_request, query_meeting_room_group_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the 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_group_headers = dingtalkrooms__1__0_models.QueryMeetingRoomGroupHeaders()
        query_meeting_room_group_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_meeting_room_group_request = dingtalkrooms__1__0_models.QueryMeetingRoomGroupRequest(
            union_id='2iPOLxxxxx'
        )
        try:
            await client.query_meeting_room_group_with_options_async('172', query_meeting_room_group_request, query_meeting_room_group_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message properties, 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\QueryMeetingRoomGroupHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomGroupRequest;
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();
        $queryMeetingRoomGroupHeaders = new QueryMeetingRoomGroupHeaders([]);
        $queryMeetingRoomGroupHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryMeetingRoomGroupRequest = new QueryMeetingRoomGroupRequest([
            "unionId" => "2iPOLxxxxx"
        ]);
        try {
            $client->queryMeetingRoomGroupWithOptions("172", $queryMeetingRoomGroupRequest, $queryMeetingRoomGroupHeaders, 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 object contains the 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
// 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
  }

  queryMeetingRoomGroupHeaders := &dingtalkrooms_1_0.QueryMeetingRoomGroupHeaders{}
  queryMeetingRoomGroupHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryMeetingRoomGroupRequest := &dingtalkrooms_1_0.QueryMeetingRoomGroupRequest{
    UnionId: tea.String("2iPOLxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryMeetingRoomGroupWithOptions(tea.String("172"), queryMeetingRoomGroupRequest, queryMeetingRoomGroupHeaders, &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 object contains the 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
// 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<void> {
    let client = Client.createClient();
    let queryMeetingRoomGroupHeaders = new $dingtalkrooms_1_0.QueryMeetingRoomGroupHeaders({ });
    queryMeetingRoomGroupHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryMeetingRoomGroupRequest = new $dingtalkrooms_1_0.QueryMeetingRoomGroupRequest({
      unionId: "2iPOLxxxxx",
    });
    try {
      await client.queryMeetingRoomGroupWithOptions("172", queryMeetingRoomGroupRequest, queryMeetingRoomGroupHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err object contains the code and message properties, which help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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.QueryMeetingRoomGroupHeaders queryMeetingRoomGroupHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomGroupHeaders();
            queryMeetingRoomGroupHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomGroupRequest queryMeetingRoomGroupRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomGroupRequest
            {
                UnionId = "2iPOLxxxxx",
            };
            try
            {
                client.QueryMeetingRoomGroupWithOptions("172", queryMeetingRoomGroupRequest, queryMeetingRoomGroupHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains the code and message properties, 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 object contains the code and message properties, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
groupIdLongThe group ID.
groupNameStringThe group name.
parentIdLongThe parent group ID.

Response body example

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

{
  "groupId" : 172,
  "groupName" : "Test group",
  "parentId" : 0
}

Error codes

If an error is returned when you call this API, refer to the Global error codes document for the solution.
HttpCodeError codeError messageDescription
400param.errorParam ErrorMissing parameter error
400org.not.foundOrg Not FoundOrganization not found
400user.not.employeeUser Not EmployeeThe user is not an employee
500system.errorSystem ErrorSystem error
500group.query.errorGroup Query ErrorGroup query error