Skip to main content
Call this API to query the quick entries of a Single-chat bot, including the entry name, entry icon, PC redirect link, and mobile redirect link. This API is suitable for Organization Admins who need to quickly retrieve quick entry configuration information when configuring bot features.

Request

Basic information

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

Request header

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

Request body

NameTypeRequiredDescription
robotCodeStringYesThe code of the bot. See Bot glossary - robotCode for details on how to obtain robotCode.

Request example

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

{
  "robotCode" : "dingykcdkXXXXXX"
}
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 using 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.QueryRobotPluginHeaders queryRobotPluginHeaders = new com.aliyun.dingtalkrobot_1_0.models.QueryRobotPluginHeaders();
        queryRobotPluginHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrobot_1_0.models.QueryRobotPluginRequest queryRobotPluginRequest = new com.aliyun.dingtalkrobot_1_0.models.QueryRobotPluginRequest()
                .setRobotCode("dingykcdkXXXXXX");
        try {
            client.queryRobotPluginWithOptions(queryRobotPluginRequest, queryRobotPluginHeaders, 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.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 using 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()
        query_robot_plugin_headers = dingtalkrobot__1__0_models.QueryRobotPluginHeaders()
        query_robot_plugin_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_robot_plugin_request = dingtalkrobot__1__0_models.QueryRobotPluginRequest(
            robot_code='dingykcdkXXXXXX'
        )
        try:
            client.query_robot_plugin_with_options(query_robot_plugin_request, query_robot_plugin_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()
        query_robot_plugin_headers = dingtalkrobot__1__0_models.QueryRobotPluginHeaders()
        query_robot_plugin_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_robot_plugin_request = dingtalkrobot__1__0_models.QueryRobotPluginRequest(
            robot_code='dingykcdkXXXXXX'
        )
        try:
            await client.query_robot_plugin_with_options_async(query_robot_plugin_request, query_robot_plugin_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\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\QueryRobotPluginHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrobot_1_0\Models\QueryRobotPluginRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client 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();
        $queryRobotPluginHeaders = new QueryRobotPluginHeaders([]);
        $queryRobotPluginHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryRobotPluginRequest = new QueryRobotPluginRequest([
            "robotCode" => "dingykcdkXXXXXX"
        ]);
        try {
            $client->queryRobotPluginWithOptions($queryRobotPluginRequest, $queryRobotPluginHeaders, 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"
  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 using 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
  }

  queryRobotPluginHeaders := &dingtalkrobot_1_0.QueryRobotPluginHeaders{}
  queryRobotPluginHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryRobotPluginRequest := &dingtalkrobot_1_0.QueryRobotPluginRequest{
    RobotCode: tea.String("dingykcdkXXXXXX"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryRobotPluginWithOptions(queryRobotPluginRequest, queryRobotPluginHeaders, &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 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 using 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 queryRobotPluginHeaders = new $dingtalkrobot_1_0.QueryRobotPluginHeaders({ });
    queryRobotPluginHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryRobotPluginRequest = new $dingtalkrobot_1_0.QueryRobotPluginRequest({
      robotCode: "dingykcdkXXXXXX",
    });
    try {
      await client.queryRobotPluginWithOptions(queryRobotPluginRequest, queryRobotPluginHeaders, 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 using 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.QueryRobotPluginHeaders queryRobotPluginHeaders = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.QueryRobotPluginHeaders();
            queryRobotPluginHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.QueryRobotPluginRequest queryRobotPluginRequest = new AlibabaCloud.SDK.Dingtalkrobot_1_0.Models.QueryRobotPluginRequest
            {
                RobotCode = "dingykcdkXXXXXX",
            };
            try
            {
                client.QueryRobotPluginWithOptions(queryRobotPluginRequest, queryRobotPluginHeaders, 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
pluginInfoListArrayThe list of quick entries.
nameStringThe name of the quick entry. Supports internationalization, for example: {"en_US":"test123","zh_CN":"Test123"}.
iconStringThe icon ID of the quick entry.
pcUrlStringThe redirect link for the quick entry in PC chats.
mobileUrlStringThe redirect link for the quick entry on mobile.

Response body example

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

{
  "pluginInfoList" : [ {
    "name" : "{\"zh_CN\":\"Test123\"}",
    "icon" : "@lALPDtXaDkO3j7hgYA",
    "pcUrl" : "https://www.dingtalk.io",
    "mobileUrl" : "https://www.dingtalk.io"
  } ]
}

Error codes

If an error occurs when calling this API, look up the solution based on the error message in the Global error codes document.
HttpCodeError codeError messageDescription
400param.illegalparameter errorparameter error
400invalidRequest.robotCodeNotMatchThe app does not match the bound bot’s robotCodeThe app does not match the bound bot’s robotCode
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
400invalidRequest.exceededMaximumLimitExceeded the maximum number of plugins allowedExceeded the maximum number of plugins allowed
400invalidRequest.jsonFormatErrojInvalid JSON formatInvalid JSON format
500system.errorsystem errorsystem error
500invalidRequest.pluginInstallFailPlugin installation failedPlugin installation failed