获取群内机器人列表新版SDK

更新于 2024-02-27

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口获取群内机器人列表。

接口功能介绍

调用本接口，根据群会话ID查询群内机器人列表信息。

说明

目前只支持获取企业内部机器人、第三方企业应用机器人，场景群机器人和公共模板机器人四种类型的机器人，其他类型的机器人均无法查询，如小钉。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉群基础信息管理权限	API Explorer

请求方法

Header参数

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用服务端接口的授权凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用服务端接口的授权凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

Body参数

名称	类型	是否必填	描述
openConversationId	String	是	群ID：基于群模板创建的群。调用创建群接口获取`open_conversation_id`参数值。

名称

类型

是否必填

描述

openConversationId

String

是

群ID：

基于群模板创建的群。
- 调用创建群接口获取open_conversation_id参数值。

返回参数

名称	类型	描述
chatbotInstanceVOList	Array	返回的机器人列表。
robotCode	String	机器人的编码，参见机器人名词表-robotCode内容，获取`robotCode`。
name	String	机器人的名称。
downloadIconURL	String	机器人头像的下载链接。
openRobotType	Integer	机器人的类型： 1：公共模板机器人，如自定义机器人，心知天气等等。 2：企业内部应用机器人。 3：第三方企业应用机器人。 4：场景群机器人。

示例

请求示例

HTTP

Java

Python

PHP

Node.js

返回示例

错误码

HttpCode	错误码	错误信息	说明
400	unauthorized	%s	调用权限不足
400	illegal.openconevrsation.id	%s	无效的会话id
400	reject	%s	群中机器人数量太多，无法查询
500	system.error	%s	系统错误

这篇文档是否有帮助？

本页内容