批量获取客户数据旧版SDK
更新于 2024-01-11
为提升接口使用体验，针对客户管理相关接口规范进行升级，从旧版升级到新版。本文旧版规范接口文档已于2022年6月17日迁移至历史文档（不推荐）目录，且本接口仅保持现有功能，不再新增支持其他能力。
如果未使用本接口，推荐使用新版规范批量获取个人或企业客户数据接口。
如果已使用本接口，建议您根据自身实际情况评估是否切换至推荐接口。
接口说明
例如，调用本接口，在企业的客户管理应用中批量获取客户数据，实现效果与下图类似。
权限
服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
企业内部应用 | 是 | 重要 暂不支持新增申请。 | — |
第三方企业应用 | 否 | — | — |
第三方个人应用 | 否 | — | — |
基本信息
请求方式：POST
请求地址：https://oapi.dingtalk.com/topapi/crm/objectdata/customer/query
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
access_token | String | 是 | dc73axxxx | 调用服务端API的应用凭证。
|
Body参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
current_operator_userid | String | 否 | user01 | 用户userid。 |
cursor | String | 否 | 0 | 分页游标。 |
page_size | Number | 是 | 100 | 分页大小。 |
query_dsl | String | 否 | {\"queryGroupList\":[{\"logicType\":\"AND\",\"queryObjectList\":[{\"fieldId\":\"customer_name\",\"filterType\":\"EQ\",\"value\":\"xx有限公司\"}]}]} | 查询条件，格式参考查询DSL说明。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
result | IterablePage | 分页查询的结果。 | |
next_cursor | String | 100 | 下一页的游标。 |
values | Values[] | 数据列表。 | |
gmt_modified | String | 2019-12-25 15:33:12 | 记录修改时间。 |
creator_userid | String | user01 | 创建记录的用户userid。 |
instance_id | String | INST_XX | 数据ID。 |
data | String | {\"customer_name\":\"杨xx\"} | 数据内容。 |
extend_data | String | {\"field_1\":\"CRM\"} | 扩展数据内容。 |
gmt_create | String | 2019-12-25 15:33:12 | 记录创建时间。 |
object_type | String | crm_customer | 数据类型。 |
permission | DataPermissionVo | 数据权限信息。 | |
owner_userid_list | String[] | ["user01","user02"] | 负责人userid列表。 |
participant_userid_list | String[] | ["user01","user02"] | 协同人userid列表。 |
has_more | Boolean | true | 是否有下一页。 |
page_size | Number | 100 | 分页大小。 |
errcode | Number | 0 | 返回码。 |
errmsg | String | ok | 返回码描述。 |
示例
请求示例（HTTP）
请求正文
请求示例（JAVA SDK）
返回示例
