选择应用类型
企业内部应用开发

根据指定条件查询个人或企业客户数据

更新于 2023-01-18调用本接口,根据指定条件查询CRM个人客户或企业客户数据。

例如,在企业的客户管理中的客户列表中,客户信息如下图所示。调用本接口,可根据指定条件查询个人客户或企业客户数据。

权限

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

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持获取CRM主数据的接口访问权限API Explorer
第三方企业应用支持获取CRM主数据的接口访问权限API Explorer
第三方个人应用暂不支持获取CRM主数据的接口访问权限暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Query参数

名称

类型

是否必填

描述

currentOperatorUserId

String

用户userId。

relationType

String

关系类型。

  • crm_customer:企业客户
  • crm_customer_personal:个人客户

nextToken

String

分页游标,获取下一页时传入上一页返回的nextToken。

maxResults

Integer

每页条数,最大值100。

queryDsl

String

查询条件。

返回参数

名称

类型

描述

values

Array

返回结果。

instanceId

String

数据ID。

objectType

String

关系类型。

  • crm_customer:企业客户
  • crm_customer_personal:个人客户

creatorUserId

String

创建记录的用户userId。

creatorNick

String

创建记录的用户昵称。

data

Map

数据内容。

extendData

Map

扩展数据内容。

permission

Object

数据权限信息。

ownerStaffIds

Array of String

负责人用户userId列表。

participantStaffIds

Array of String

协同人用户userId列表。

procOutResult

String

审批结果。

procInstStatus

String

审批状态。

gmtCreate

String

记录创建时间。

gmtModified

String

记录修改时间。

hasMore

Boolean

是否有下一页。

  • true:有

  • false:没有

nextToken

String

分页游标。

maxResults

Integer

分页大小。

totalCount

Integer

总条数。

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

HttpCode

错误码

错误信息

说明

400

queryDsl.invalid.json

queryDsl is not json format

queryDsl不是有效的JSON字符串

400

request.too.frequent

request too frequent

请求过于频繁

400

relationType.not.exists

relationType not exists

relationType不存在

400

systemError.appNotExists

system error, app not exists, %s

应用不存在

400

systemError.notPermittedAccess

system error, not permitted access, %s

无权限操作

400

crmAppNotExisted

crmAppNotExisted

客户管理应用不存在

500

systemError

system error %s

系统错误

点击纠错