文档中心 > API类目 > 钉钉API

dingtalk.corp.chatbot.listbychatbotids (isv查询企业已安装的企业机器人)

ISV根据chatbotId查询给企业已安装的机器人信息

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
chatbot_ids	String []	必须	gitLab	最大列表长度：20	chatbotId列表

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
result_list ChatbotResultVo [] result └ bot_type Number 2 2-企业对内机器人，3-企业对外机器人 └ chatbot_id String gitLab 机器人chatbotId └ name String 项目通知机器人名字 └ icon String @lALOuP-LU80CgM0CgA 机器人头像 └ breif String 基于ROR的开源代码托管软件机器人简介 └ description String 优秀的代码托管服务，将接收到项目变更实时通知机器人详细介绍 └ outgoing_url String http:xxx 机器人回调地址 └ outgoing_token String 1220ba9606120714e5eb2285e992680a6 机器人消息回调时在header中添加的token,用于对钉钉鉴权 └ preview_media_id String @dsa8d87y7c8d8c 机器人预览图 └ mobile_switch Number 1 手机端是否能添加机器人：0-移动端不能加，1-移动端能添加 └ function Number 3 INCOMING = 1,OUTGOING = 2,INOUT = 3 └ name_modify Number 0 向群添加机器人时是否可改名字：0-不可必，1-可改 └ icon_mdify Number 0 向群添加机器人时是否可改头像：0-不可必，1-可改 └ oto_support Number 0 是否支持单聊：0-不要单聊，1需要单聊 └ authority Number 0 0-正常，1-只服务端可管理 └ ding_open_errcode Number -1 dingOpenErrcode └ error_msg String 系统错误 errorMsg └ success Boolean true success

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpChatbotListbychatbotidsRequest req = new CorpChatbotListbychatbotidsRequest();
req.setChatbotIds("gitLab");
CorpChatbotListbychatbotidsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpChatbotListbychatbotidsRequest req = new CorpChatbotListbychatbotidsRequest();
req.ChatbotIds = "gitLab";
CorpChatbotListbychatbotidsResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new CorpChatbotListbychatbotidsRequest;
$req->setChatbotIds("gitLab");
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.corp.chatbot.listbychatbotids' \
-d 'partner_id=apidoc' \
-d 'session=5183126f-69cf-4974-b34e-49e72889cf16' \
-d 'timestamp=2025-05-09+22%3A03%3A23' \
-d 'v=2.0' \
-d 'chatbot_ids=gitLab'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.CorpChatbotListbychatbotidsRequest("https://eco.taobao.com/router/rest")

req.chatbot_ids="gitLab"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.corp.chatbot.listbychatbotids");
add_param(pRequest,"chatbot_ids","gitLab");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.corp.chatbot.listbychatbotids', {
	'chatbot_ids':'gitLab'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_chatbot_listbychatbotids_response>
    <result>
        <result_list>
            <chatbot_result_vo>
                <bot_type>2</bot_type>
                <chatbot_id>gitLab</chatbot_id>
                <name>项目通知</name>
                <icon>@lALOuP-LU80CgM0CgA</icon>
                <breif>基于ROR的开源代码托管软件</breif>
                <description>优秀的代码托管服务，将接收到项目变更实时通知</description>
                <outgoing_url>http:xxx</outgoing_url>
                <outgoing_token>1220ba9606120714e5eb2285e992680a6</outgoing_token>
                <preview_media_id>@dsa8d87y7c8d8c</preview_media_id>
                <mobile_switch>1</mobile_switch>
                <function>3</function>
                <name_modify>0</name_modify>
                <icon_mdify>0</icon_mdify>
                <oto_support>0</oto_support>
                <authority>0</authority>
            </chatbot_result_vo>
        </result_list>
        <ding_open_errcode>-1</ding_open_errcode>
        <error_msg>系统错误</error_msg>
        <success>true</success>
    </result>
</dingtalk_corp_chatbot_listbychatbotids_response>

{
    "dingtalk_corp_chatbot_listbychatbotids_response":{
        "result":{
            "result_list":{
                "chatbot_result_vo":[
                    {
                        "bot_type":2,
                        "chatbot_id":"gitLab",
                        "name":"项目通知",
                        "icon":"@lALOuP-LU80CgM0CgA",
                        "breif":"基于ROR的开源代码托管软件",
                        "description":"优秀的代码托管服务，将接收到项目变更实时通知",
                        "outgoing_url":"http:xxx",
                        "outgoing_token":"1220ba9606120714e5eb2285e992680a6",
                        "preview_media_id":"@dsa8d87y7c8d8c",
                        "mobile_switch":1,
                        "function":3,
                        "name_modify":0,
                        "icon_mdify":0,
                        "oto_support":0,
                        "authority":0
                    }
                ]
            },
            "ding_open_errcode":-1,
            "error_msg":"系统错误",
            "success":true
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.corp.chatbot.listbychatbotids (isv查询企业已安装的企业机器人)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ