Skip to main content
Call this API to remove users from an ongoing meeting. After the API is called, the removed users leave the meeting and see a prompt indicating that they have been removed.

Request

Basic information

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

Path parameters

NameTypeRequiredDescription
conferenceIdStringYesThe meeting ID. Call the Create a video meeting API to obtain the conferenceId field in the response.

Request body

NameTypeRequiredDescription
userListArrayYesThe list of users to operate on.
unionIdStringYesThe unionId of the user.
participantIdStringNoThe participant ID of the user. If not specified, the action applies to all devices of the user.
forbiddenRejoinBooleanNoWhether to prohibit the user from rejoining the meeting: - true: Prohibit rejoining. - false: Allow rejoining.

Request example

HTTP
POST /v1.0/conference/videoConferences/644272f14ba331014xxxxxxx/members/kick HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:0198da4df0e33395904073f1b8a192da
Content-Type:application/json

{
  "userList" : [ {
    "unionId" : "qzR1iSMDvzR9iP7P0ZKxxxxxxxxx",
    "participantId" : "644272f14ba332xxxxxxxxx"
  } ],
  "forbiddenRejoin" : false
}
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.dingtalkconference_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.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();
        com.aliyun.dingtalkconference_1_0.models.KickMembersHeaders kickMembersHeaders = new com.aliyun.dingtalkconference_1_0.models.KickMembersHeaders();
        kickMembersHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.KickMembersRequest.KickMembersRequestUserList userList0 = new com.aliyun.dingtalkconference_1_0.models.KickMembersRequest.KickMembersRequestUserList()
                .setUnionId("qzR1iSMDvzR9iP7P0ZKxxxxxxxxx")
                .setParticipantId("644272f14ba332xxxxxxxxx");
        com.aliyun.dingtalkconference_1_0.models.KickMembersRequest kickMembersRequest = new com.aliyun.dingtalkconference_1_0.models.KickMembersRequest()
                .setUserList(java.util.Arrays.asList(
                    userList0
                ))
                .setForbiddenRejoin(false);
        try {
            client.kickMembersWithOptions("644272f14ba331014xxxxxxx", kickMembersRequest, kickMembersHeaders, 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 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)) {
                // err 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 os
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 a 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()
        kick_members_headers = dingtalkconference__1__0_models.KickMembersHeaders()
        kick_members_headers.x_acs_dingtalk_access_token = '<your access token>'
        user_list_0 = dingtalkconference__1__0_models.KickMembersRequestUserList(
            union_id='qzR1iSMDvzR9iP7P0ZKxxxxxxxxx',
            participant_id='644272f14ba332xxxxxxxxx'
        )
        kick_members_request = dingtalkconference__1__0_models.KickMembersRequest(
            user_list=[
                user_list_0
            ],
            forbidden_rejoin=False
        )
        try:
            client.kick_members_with_options('644272f14ba331014xxxxxxx', kick_members_request, kick_members_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 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()
        kick_members_headers = dingtalkconference__1__0_models.KickMembersHeaders()
        kick_members_headers.x_acs_dingtalk_access_token = '<your access token>'
        user_list_0 = dingtalkconference__1__0_models.KickMembersRequestUserList(
            union_id='qzR1iSMDvzR9iP7P0ZKxxxxxxxxx',
            participant_id='644272f14ba332xxxxxxxxx'
        )
        kick_members_request = dingtalkconference__1__0_models.KickMembersRequest(
            user_list=[
                user_list_0
            ],
            forbidden_rejoin=False
        )
        try:
            await client.kick_members_with_options_async('644272f14ba331014xxxxxxx', kick_members_request, kick_members_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 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\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\KickMembersHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\KickMembersRequest\userList;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\KickMembersRequest;
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();
        $kickMembersHeaders = new KickMembersHeaders([]);
        $kickMembersHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $userList0 = new userList([
            "unionId" => "qzR1iSMDvzR9iP7P0ZKxxxxxxxxx",
            "participantId" => "644272f14ba332xxxxxxxxx"
        ]);
        $kickMembersRequest = new KickMembersRequest([
            "userList" => [
                $userList0
            ],
            "forbiddenRejoin" => false
        ]);
        try {
            $client->kickMembersWithOptions("644272f14ba331014xxxxxxx", $kickMembersRequest, $kickMembersHeaders, 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 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"
  dingtalkconference_1_0  "github.com/alibabacloud-go/dingtalk/conference_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 *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
  }

  kickMembersHeaders := &dingtalkconference_1_0.KickMembersHeaders{}
  kickMembersHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  userList0 := &dingtalkconference_1_0.KickMembersRequestUserList{
    UnionId: tea.String("qzR1iSMDvzR9iP7P0ZKxxxxxxxxx"),
    ParticipantId: tea.String("644272f14ba332xxxxxxxxx"),
  }
  kickMembersRequest := &dingtalkconference_1_0.KickMembersRequest{
    UserList: []*dingtalkconference_1_0.KickMembersRequestUserList{userList0},
    ForbiddenRejoin: tea.Bool(false),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.KickMembersWithOptions(tea.String("644272f14ba331014xxxxxxx"), kickMembersRequest, kickMembersHeaders, &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 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 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 a 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 kickMembersHeaders = new $dingtalkconference_1_0.KickMembersHeaders({ });
    kickMembersHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let userList0 = new $dingtalkconference_1_0.KickMembersRequestUserList({
      unionId: "qzR1iSMDvzR9iP7P0ZKxxxxxxxxx",
      participantId: "644272f14ba332xxxxxxxxx",
    });
    let kickMembersRequest = new $dingtalkconference_1_0.KickMembersRequest({
      userList: [
        userList0
      ],
      forbiddenRejoin: false,
    });
    try {
      await client.kickMembersWithOptions("644272f14ba331014xxxxxxx", kickMembersRequest, kickMembersHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 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.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.KickMembersHeaders kickMembersHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.KickMembersHeaders();
            kickMembersHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.KickMembersRequest.KickMembersRequestUserList userList0 = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.KickMembersRequest.KickMembersRequestUserList
            {
                UnionId = "qzR1iSMDvzR9iP7P0ZKxxxxxxxxx",
                ParticipantId = "644272f14ba332xxxxxxxxx",
            };
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.KickMembersRequest kickMembersRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.KickMembersRequest
            {
                UserList = new List<AlibabaCloud.SDK.Dingtalkconference_1_0.Models.KickMembersRequest.KickMembersRequestUserList>
                {
                    userList0
                },
                ForbiddenRejoin = false,
            };
            try
            {
                client.KickMembersWithOptions("644272f14ba331014xxxxxxx", kickMembersRequest, kickMembersHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 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))
                {
                    // err contains the code and message properties, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successBooleanIndicates whether the call was successful.

Response body example

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

{
  "success" : true
}

Error codes

If the API call returns an error, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400unknownUserErrorunknownUserErrorUnrecognized user.
400paramsErrorerror:%sParameter error. The meeting ID is missing.
500systemErrorsystemError:%sSystem error.