查询客户群列表新版SDK

更新于 2023-01-18

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

调用本接口，根据指定过滤条件和排序规则，查询客户群列表数据。

例如，设置过滤条件和排序规则如下：

如下图所示，调用本接口可获取到本企业内所有名称包含“客户”的客户群列表，并且是按照创建时间降序排序。

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	客户管理客户群读权限	API Explorer
第三方企业应用	支持	客户管理客户群读权限	API Explorer
第三方个人应用	暂不支持	客户管理客户群读权限	暂不支持

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

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

名称	类型	是否必填	描述
relationType	String	是	关系类型。 crm_customer：企业客户。 crm_customer_personal：个人客户。
nextToken	String	否	分页游标。如果是首次调用，该参数不传。如果是非首次调用，该参数传上次调用返回的nextToken。
maxResults	Integer	是	每页最大条目数，最大值100。
queryDsl	String	否	查询DSL语法。企业内部应用，参考客户群查询DSL语法说明。第三方企业应用，参考客户群查询DSL语法说明。

名称	类型	描述
resultList	Array	数据列表。
openConversationId	String	客户群openConversationId。
openGroupSetId	String	客户群所在的群组openGroupSetId。如果是客户群组裂变出的客户群，会返回该字段。如果是调用创建客户群接口创建的客户群，不返回该字段。企业内部应用，调用创建客户群接口。第三方企业应用，调用创建客户群接口。
ownerUserId	String	群主userId。
ownerUserName	String	群主userName。
name	String	客户群名称。
memberCount	Integer	客户群成员数。
gmtCreate	Long	客户群创建时间。
hasMore	Boolean	是否还有下一页。 true：有 false：没有
nextToken	String	下一页的游标。
totalCount	Integer	总条数。

请求示例

HTTP

Java

Python

PHP

Node.js

C++

返回示例

HttpCode	错误码	错误信息	说明
400	invalidParameter	invalid parameter.	无效的参数
400	notSupportedFilterType	%s	不支持的查询类型
400	userIdNotExists	%s	用户不存在
500	systemError	%s	系统错误

这篇文档是否有帮助？

本页内容