Skip to main content
Call this API to clear the quick entries of a single-chat bot.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/robot/plugins/clear
HTTP MethodPOST
Supported app typeappType-Internal app
Permissions requiredpermission-Robot.SingleChat.ReadWrite-Single-chat bot management permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Request body

NameTypeRequiredDescription
robotCodeStringYesThe code of the bot. To obtain the robotCode, see the Bot glossary - robotCode topic.

Request example

HTTP
POST /v1.0/robot/plugins/clear HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:asxsbjekdndkajXXXXX
Content-Type:application/json

{
  "robotCode" : "dingkxnemxbqkXXXX"
}
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.dingtalkrobot_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.dingtalkrobot_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkrobot_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkrobot_1_0.models.ClearRobotPluginHeaders clearRobotPluginHeaders = new com.aliyun.dingtalkrobot_1_0.models.ClearRobotPluginHeaders();
        clearRobotPluginHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrobot_1_0.models.ClearRobotPluginRequest clearRobotPluginRequest = new com.aliyun.dingtalkrobot_1_0.models.ClearRobotPluginRequest()
                .setRobotCode("dingkxnemxbqkXXXX");
        try {
            client.clearRobotPluginWithOptions(clearRobotPluginRequest, clearRobotPluginHeaders, 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 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)) {
                // The 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.robot_1_0.client import Client as dingtalkrobot_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.robot_1_0 import models as dingtalkrobot__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() -> dingtalkrobot_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 dingtalkrobot_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        clear_robot_plugin_headers = dingtalkrobot__1__0_models.ClearRobotPluginHeaders()
        clear_robot_plugin_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_robot_plugin_request = dingtalkrobot__1__0_models.ClearRobotPluginRequest(
            robot_code='dingkxnemxbqkXXXX'
        )
        try:
            client.clear_robot_plugin_with_options(clear_robot_plugin_request, clear_robot_plugin_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The 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()
        clear_robot_plugin_headers = dingtalkrobot__1__0_models.ClearRobotPluginHeaders()
        clear_robot_plugin_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_robot_plugin_request = dingtalkrobot__1__0_models.ClearRobotPluginRequest(
            robot_code='dingkxnemxbqkXXXX'
        )
        try:
            await client.clear_robot_plugin_with_options_async(clear_robot_plugin_request, clear_robot_plugin_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The 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\Vrobot_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\ClearRobotPluginHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\ClearRobotPluginRequest;
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();
        $clearRobotPluginHeaders = new ClearRobotPluginHeaders([]);
        $clearRobotPluginHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $clearRobotPluginRequest = new ClearRobotPluginRequest([
            "robotCode" => "dingkxnemxbqkXXXX"
        ]);
        try {
            $client->clearRobotPluginWithOptions($clearRobotPluginRequest, $clearRobotPluginHeaders, 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 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"
  dingtalkrobot_1_0  "github.com/alibabacloud-go/dingtalk/robot_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 *dingtalkrobot_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkrobot_1_0.Client{}
  _result, _err = dingtalkrobot_1_0.NewClient(config)
  return _result, _err
}

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

  clearRobotPluginHeaders := &dingtalkrobot_1_0.ClearRobotPluginHeaders{}
  clearRobotPluginHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  clearRobotPluginRequest := &dingtalkrobot_1_0.ClearRobotPluginRequest{
    RobotCode: tea.String("dingkxnemxbqkXXXX"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ClearRobotPluginWithOptions(clearRobotPluginRequest, clearRobotPluginHeaders, &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 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 dingtalkrobot_1_0, * as $dingtalkrobot_1_0 from '@alicloud/dingtalk/robot_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(): dingtalkrobot_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkrobot_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let clearRobotPluginHeaders = new $dingtalkrobot_1_0.ClearRobotPluginHeaders({ });
    clearRobotPluginHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let clearRobotPluginRequest = new $dingtalkrobot_1_0.ClearRobotPluginRequest({
      robotCode: "dingkxnemxbqkXXXX",
    });
    try {
      await client.clearRobotPluginWithOptions(clearRobotPluginRequest, clearRobotPluginHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The 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.Dingtalkrobot_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkrobot_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.ClearRobotPluginHeaders clearRobotPluginHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.ClearRobotPluginHeaders();
            clearRobotPluginHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.ClearRobotPluginRequest clearRobotPluginRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.ClearRobotPluginRequest
            {
                RobotCode = "dingkxnemxbqkXXXX",
            };
            try
            {
                client.ClearRobotPluginWithOptions(clearRobotPluginRequest, clearRobotPluginHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The 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))
                {
                    // The err contains code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanIndicates whether the bot’s quick entries were cleared successfully.

Response body example

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

{
  "result" : true
}

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
400param.illegalParameter errorParameter error
400invalidRequest.robotCodeNotMatchThe app does not match the robotCode of the bound botThe app does not match the robotCode of the bound bot
400invalidRequest.robotNotExistThe bot does not exist. Verify and add it againThe bot does not exist. Verify and add it again
400invalidRequest.robotIsStopThe bot has been disabled by the organizationThe bot has been disabled by the organization
500system.errorSystem errorSystem error