Skip to main content
Call this API to delete a Room group.

Request

Basic information

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

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Get 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 API.

Path parameters

NameTypeRequiredDescription
groupIdLongYesThe Room group ID. Obtain it by calling the Query the Room group list API. If the group contains sub-groups, you cannot delete it directly. Otherwise, the API returns an error.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Obtain it by calling the Query user details API.

Request example

HTTP
DELETE /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.DeleteMeetingRoomGroupHeaders deleteMeetingRoomGroupHeaders = new com.aliyun.dingtalkrooms_1_0.models.DeleteMeetingRoomGroupHeaders();
        deleteMeetingRoomGroupHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.DeleteMeetingRoomGroupRequest deleteMeetingRoomGroupRequest = new com.aliyun.dingtalkrooms_1_0.models.DeleteMeetingRoomGroupRequest()
                .setUnionId("2iPOLxxxxx");
        try {
            client.deleteMeetingRoomGroupWithOptions("172", deleteMeetingRoomGroupRequest, deleteMeetingRoomGroupHeaders, 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 attributes that 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 attributes that 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()
        delete_meeting_room_group_headers = dingtalkrooms__1__0_models.DeleteMeetingRoomGroupHeaders()
        delete_meeting_room_group_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_meeting_room_group_request = dingtalkrooms__1__0_models.DeleteMeetingRoomGroupRequest(
            union_id='2iPOLxxxxx'
        )
        try:
            client.delete_meeting_room_group_with_options('172', delete_meeting_room_group_request, delete_meeting_room_group_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 attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_meeting_room_group_headers = dingtalkrooms__1__0_models.DeleteMeetingRoomGroupHeaders()
        delete_meeting_room_group_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_meeting_room_group_request = dingtalkrooms__1__0_models.DeleteMeetingRoomGroupRequest(
            union_id='2iPOLxxxxx'
        )
        try:
            await client.delete_meeting_room_group_with_options_async('172', delete_meeting_room_group_request, delete_meeting_room_group_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 attributes that 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\DeleteMeetingRoomGroupHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\DeleteMeetingRoomGroupRequest;
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();
        $deleteMeetingRoomGroupHeaders = new DeleteMeetingRoomGroupHeaders([]);
        $deleteMeetingRoomGroupHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteMeetingRoomGroupRequest = new DeleteMeetingRoomGroupRequest([
            "unionId" => "2iPOLxxxxx"
        ]);
        try {
            $client->deleteMeetingRoomGroupWithOptions("172", $deleteMeetingRoomGroupRequest, $deleteMeetingRoomGroupHeaders, 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 attributes that 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
  }

  deleteMeetingRoomGroupHeaders := &dingtalkrooms_1_0.DeleteMeetingRoomGroupHeaders{}
  deleteMeetingRoomGroupHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteMeetingRoomGroupRequest := &dingtalkrooms_1_0.DeleteMeetingRoomGroupRequest{
    UnionId: tea.String("2iPOLxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteMeetingRoomGroupWithOptions(tea.String("172"), deleteMeetingRoomGroupRequest, deleteMeetingRoomGroupHeaders, &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 attributes that 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 deleteMeetingRoomGroupHeaders = new $dingtalkrooms_1_0.DeleteMeetingRoomGroupHeaders({ });
    deleteMeetingRoomGroupHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let deleteMeetingRoomGroupRequest = new $dingtalkrooms_1_0.DeleteMeetingRoomGroupRequest({
      unionId: "2iPOLxxxxx",
    });
    try {
      await client.deleteMeetingRoomGroupWithOptions("172", deleteMeetingRoomGroupRequest, deleteMeetingRoomGroupHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that 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.DeleteMeetingRoomGroupHeaders deleteMeetingRoomGroupHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.DeleteMeetingRoomGroupHeaders();
            deleteMeetingRoomGroupHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.DeleteMeetingRoomGroupRequest deleteMeetingRoomGroupRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.DeleteMeetingRoomGroupRequest
            {
                UnionId = "2iPOLxxxxx",
            };
            try
            {
                client.DeleteMeetingRoomGroupWithOptions("172", deleteMeetingRoomGroupRequest, deleteMeetingRoomGroupHeaders, 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 attributes that 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))
                {
                    // err contains code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanWhether the deletion was successful. true indicates a successful deletion.

Response body example

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

{
  "result" : true
}

Error codes

If the API call returns an error, see the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400param.errorParam ErrorMissing parameter error
400group.not.foundGroup Not FoundThe group does not exist
400org.not.foundOrg Not FoundThe organization cannot be found
400user.not.adminUser Not AdminThe user is not an admin
500system.errorSystem ErrorSystem error