Skip to main content
Call this API to close a video meeting. Only the host of the meeting has the permission to close it.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}
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 used to call 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 that authorized a third-party app API.

Path parameters

NameTypeRequiredDescription
conferenceIdStringYesThe meeting ID. Call the Create a video meeting API to obtain the value of the conferenceId parameter.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unique identifier of an employee within the current developer’s Enterprise Account scope. Call the Query user details API to obtain the value of the unionid parameter.

Request example

HTTP
DELETE /v1.0/conference/videoConferences/607452e01401526ee39609e1?unionId=27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:e6bba9c0d0343fcfaec87944fe37061D
Content-Type:application/json
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkconference_1_0.*;
import com.aliyun.dingtalkconference_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * Initialize the account Client with the Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkconference_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkconference_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkconference_1_0.Client client = Sample.createClient();
        CloseVideoConferenceHeaders closeVideoConferenceHeaders = new CloseVideoConferenceHeaders();
        closeVideoConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        CloseVideoConferenceRequest closeVideoConferenceRequest = new CloseVideoConferenceRequest()
                .setUnionId("27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE");
        try {
            client.closeVideoConferenceWithOptions("607452e01401526ee39609e1", closeVideoConferenceRequest, closeVideoConferenceHeaders, new 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 you troubleshoot issues
            }

        } 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 you troubleshoot issues
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.conference_1_0.client import Client as dingtalkconference_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.conference_1_0 import models as dingtalkconference__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() -> dingtalkconference_1_0Client:
        """
        Initialize the account Client with the Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkconference_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        close_video_conference_headers = dingtalkconference__1__0_models.CloseVideoConferenceHeaders()
        close_video_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        close_video_conference_request = dingtalkconference__1__0_models.CloseVideoConferenceRequest(
            union_id='27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE'
        )
        try:
            client.close_video_conference_with_options('607452e01401526ee39609e1', close_video_conference_request, close_video_conference_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 you troubleshoot issues
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        close_video_conference_headers = dingtalkconference__1__0_models.CloseVideoConferenceHeaders()
        close_video_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        close_video_conference_request = dingtalkconference__1__0_models.CloseVideoConferenceRequest(
            union_id='27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE'
        )
        try:
            await client.close_video_conference_with_options_async('607452e01401526ee39609e1', close_video_conference_request, close_video_conference_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 you troubleshoot issues
                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\Vconference_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CloseVideoConferenceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CloseVideoConferenceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with the 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();
        $closeVideoConferenceHeaders = new CloseVideoConferenceHeaders([]);
        $closeVideoConferenceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $closeVideoConferenceRequest = new CloseVideoConferenceRequest([
            "unionId" => "27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE"
        ]);
        try {
            $client->closeVideoConferenceWithOptions("607452e01401526ee39609e1", $closeVideoConferenceRequest, $closeVideoConferenceHeaders, 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 you troubleshoot issues
            }
        }
    }
}
$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/service"
  dingtalkconference_1_0  "github.com/alibabacloud-go/dingtalk/conference_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client with the Token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkconference_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkconference_1_0.Client{}
  _result, _err = dingtalkconference_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  closeVideoConferenceHeaders := &dingtalkconference_1_0.CloseVideoConferenceHeaders{}
  closeVideoConferenceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  closeVideoConferenceRequest := &dingtalkconference_1_0.CloseVideoConferenceRequest{
    UnionId: tea.String("27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CloseVideoConferenceWithOptions(tea.String("607452e01401526ee39609e1"), closeVideoConferenceRequest, closeVideoConferenceHeaders, &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 you troubleshoot issues
    }

  }
  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 dingtalkconference_1_0, * as $dingtalkconference_1_0 from '@alicloud/dingtalk/conference_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 the Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkconference_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkconference_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let closeVideoConferenceHeaders = new $dingtalkconference_1_0.CloseVideoConferenceHeaders({ });
    closeVideoConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let closeVideoConferenceRequest = new $dingtalkconference_1_0.CloseVideoConferenceRequest({
      unionId: "27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE",
    });
    try {
      await client.closeVideoConferenceWithOptions("607452e01401526ee39609e1", closeVideoConferenceRequest, closeVideoConferenceHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that help you troubleshoot issues
      }

    }    
  }

}

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 the Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkconference_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkconference_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkconference_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CloseVideoConferenceHeaders closeVideoConferenceHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CloseVideoConferenceHeaders();
            closeVideoConferenceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CloseVideoConferenceRequest closeVideoConferenceRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CloseVideoConferenceRequest
            {
                UnionId = "27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE",
            };
            try
            {
                client.CloseVideoConferenceWithOptions("607452e01401526ee39609e1", closeVideoConferenceRequest, closeVideoConferenceHeaders, 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 you troubleshoot issues
                }
            }
            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 you troubleshoot issues
                }
            }
        }

    }
}
C
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkconference__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkconference_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkconference_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::Client> client = make_shared<Alibabacloud_Dingtalkconference_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::CloseVideoConferenceHeaders> closeVideoConferenceHeaders = make_shared<Alibabacloud_Dingtalkconference_1_0::CloseVideoConferenceHeaders>();
  closeVideoConferenceHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::CloseVideoConferenceRequest> closeVideoConferenceRequest = make_shared<Alibabacloud_Dingtalkconference_1_0::CloseVideoConferenceRequest>(map<string, boost::any>({
    {"unionId", boost::any(string("27SaQ3iiHLN0uwqcPxxxxxxxxwiEiE"))}
  }));
  try {
    client->closeVideoConferenceWithOptions(make_shared<string>("607452e01401526ee39609e1"), closeVideoConferenceRequest, closeVideoConferenceHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err contains code and message attributes that help you troubleshoot issues
    }
  }
}

Response

Response body

NameTypeDescription
codeLongThe return code of the close audio and video API result.
causeStringIf the return code is 200, this field returns success. Otherwise, it returns the failure reason.

Response body example

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

{
  "code" : 200,
  "cause" : "sucess"
}

Error codes

If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400orgAccessForbiddenorgAccessForbiddenOrganization access is restricted.
400unknownUserErrorunknownUserErrorThe user cannot be identified.
400paramsTitleErrorerror:%sThe meeting Title is invalid.
400paramsErrorerror:%sParameter error.
400resourceCloseThe meeting has endedThe meeting has already been closed.
404waterLimitErrorwaterLimitError:%sRate limit reached for the number of participants.
404permissionErrorpermissionError:%sGroup permission restricted.
500systemErrorsystemError:%sSystem error.