Skip to main content
Call this API to delete users from the room booking blocklist.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/rooms/bookings/blacklist/remove
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
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 authorized organization for a third-party app API.

Request body

NameTypeRequiredDescription
blacklistUnionIdsArray of StringNoThe unionIds of the blocklist users. The number of unionIds cannot exceed 100.
unionIdStringNoThe unionId of the operator.

Request example

HTTP
POST /v1.0/rooms/bookings/blacklist/remove HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "blacklistUnionIds" : [ "2iPOLxxxxx" ],
  "unionId" : "2iPOLxxxxx"
}
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 by using 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 {
        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.DeleteBookingBlacklistHeaders deleteBookingBlacklistHeaders = new com.aliyun.dingtalkrooms_1_0.models.DeleteBookingBlacklistHeaders();
        deleteBookingBlacklistHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.DeleteBookingBlacklistRequest deleteBookingBlacklistRequest = new com.aliyun.dingtalkrooms_1_0.models.DeleteBookingBlacklistRequest()
                .setBlacklistUnionIds(java.util.Arrays.asList(
                    "2iPOLxxxxx"
                ))
                .setUnionId("2iPOLxxxxx");
        try {
            client.deleteBookingBlacklistWithOptions(deleteBookingBlacklistRequest, deleteBookingBlacklistHeaders, 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 code and message properties to 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 code and message properties to 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 by using 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_booking_blacklist_headers = dingtalkrooms__1__0_models.DeleteBookingBlacklistHeaders()
        delete_booking_blacklist_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_booking_blacklist_request = dingtalkrooms__1__0_models.DeleteBookingBlacklistRequest(
            blacklist_union_ids=[
                '2iPOLxxxxx'
            ],
            union_id='2iPOLxxxxx'
        )
        try:
            client.delete_booking_blacklist_with_options(delete_booking_blacklist_request, delete_booking_blacklist_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        delete_booking_blacklist_headers = dingtalkrooms__1__0_models.DeleteBookingBlacklistHeaders()
        delete_booking_blacklist_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_booking_blacklist_request = dingtalkrooms__1__0_models.DeleteBookingBlacklistRequest(
            blacklist_union_ids=[
                '2iPOLxxxxx'
            ],
            union_id='2iPOLxxxxx'
        )
        try:
            await client.delete_booking_blacklist_with_options_async(delete_booking_blacklist_request, delete_booking_blacklist_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message properties to 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\DeleteBookingBlacklistHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\DeleteBookingBlacklistRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client by using 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();
        $deleteBookingBlacklistHeaders = new DeleteBookingBlacklistHeaders([]);
        $deleteBookingBlacklistHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteBookingBlacklistRequest = new DeleteBookingBlacklistRequest([
            "blacklistUnionIds" => [
                "2iPOLxxxxx"
            ],
            "unionId" => "2iPOLxxxxx"
        ]);
        try {
            $client->deleteBookingBlacklistWithOptions($deleteBookingBlacklistRequest, $deleteBookingBlacklistHeaders, 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 code and message properties to 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 (
  "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 by using 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
  }

  deleteBookingBlacklistHeaders := &dingtalkrooms_1_0.DeleteBookingBlacklistHeaders{}
  deleteBookingBlacklistHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  deleteBookingBlacklistRequest := &dingtalkrooms_1_0.DeleteBookingBlacklistRequest{
    BlacklistUnionIds: []*string{tea.String("2iPOLxxxxx")},
    UnionId: tea.String("2iPOLxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteBookingBlacklistWithOptions(deleteBookingBlacklistRequest, deleteBookingBlacklistHeaders, &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 code and message properties to 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 by using 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 deleteBookingBlacklistHeaders = new dingtalkrooms_1_0.DeleteBookingBlacklistHeaders({ });
    deleteBookingBlacklistHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let deleteBookingBlacklistRequest = new dingtalkrooms_1_0.DeleteBookingBlacklistRequest({
      blacklistUnionIds: [
        '2iPOLxxxxx'
      ],
      unionId: '2iPOLxxxxx',
    });
    try {
      await client.deleteBookingBlacklistWithOptions(deleteBookingBlacklistRequest, deleteBookingBlacklistHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err object contains code and message properties to help locate the issue
      }

    }    
  }

}

exports.Client = Client;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client by using 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.DeleteBookingBlacklistHeaders deleteBookingBlacklistHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.DeleteBookingBlacklistHeaders();
            deleteBookingBlacklistHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.DeleteBookingBlacklistRequest deleteBookingBlacklistRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.DeleteBookingBlacklistRequest
            {
                BlacklistUnionIds = new List<string>
                {
                    "2iPOLxxxxx"
                },
                UnionId = "2iPOLxxxxx",
            };
            try
            {
                client.DeleteBookingBlacklistWithOptions(deleteBookingBlacklistRequest, deleteBookingBlacklistHeaders, 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 code and message properties to 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 code and message properties to help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanWhether the API call is successful.

Response body example

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

{
  "result" : true
}

Error codes

If an error occurs when calling this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400param.errorParam ErrorMissing parameter error
400user.over.limitUser Over LimitThe number of blocklist user IDs exceeds the limit
500system.errorSystem ErrorSystem error