Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/robot/plugins/query |
| Metode HTTP | POST |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang wajib | permission-Robot.SingleChat.ReadWrite-Izin manajemen Bot obrolan tunggal |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Dapatkan dengan memanggil Dapatkan access token dari aplikasi internal. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| robotCode | String | Ya | Kode Bot. Lihat Glosarium Bot - robotCode untuk detail cara memperoleh robotCode. |
Contoh permintaan
HTTPPOST /v1.0/robot/plugins/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:asxsbjekdndkajXXXXX
Content-Type:application/json
{
"robotCode" : "dingykcdkXXXXXX"
}
// 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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
# -*- 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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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 berisi atribut code dan message yang membantu menemukan 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));
// 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 berisi atribut code dan message yang membantu menemukan issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
Client.main(process.argv.slice(2));
// 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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| pluginInfoList | Array | Daftar entri cepat. |
| name | String | Nama entri cepat. Mendukung internasionalisasi, misalnya: {"en_US":"test123","zh_CN":"Test123"}. |
| icon | String | ID ikon entri cepat. |
| pcUrl | String | Tautan pengalihan untuk entri cepat di obrolan PC. |
| mobileUrl | String | Tautan pengalihan untuk entri cepat di seluler. |
Contoh isi respons
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"
} ]
}
Kode error
Jika terjadi error saat memanggil API ini, cari solusinya berdasarkan pesan error di dokumen Kode error global.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | param.illegal | parameter error | Error parameter |
| 400 | invalidRequest.robotCodeNotMatch | The app does not match the bound bot’s robotCode | Aplikasi tidak cocok dengan robotCode Bot yang terikat |
| 400 | invalidRequest.robotNotExist | The bot does not exist. Verify and add it again | Bot tidak ada. Verifikasi dan tambahkan lagi |
| 400 | invalidRequest.robotIsStop | The bot has been disabled by the organization | Bot telah dinonaktifkan oleh organisasi |
| 400 | invalidRequest.exceededMaximumLimit | Exceeded the maximum number of plugins allowed | Melebihi jumlah maksimum plugin yang diizinkan |
| 400 | invalidRequest.jsonFormatErroj | Invalid JSON format | Format JSON tidak valid |
| 500 | system.error | system error | Error sistem |
| 500 | invalidRequest.pluginInstallFail | Plugin installation failed | Instalasi plugin gagal |