批量获取客户数据

POST

http://127.0.0.1/topapi/crm/objectdata/customer/query

服务端API/客户管理（官方CRM）/客户管理标准对象/客户管理

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口根据指定查询条件批量获取客户数据，最多可一次获取200条数据。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端接口的授权凭证，可通过调用access_token接口获得。

示例值:

dc73axxxx

Body 参数application/json

current_operator_userid

string

用户userid。

可选

cursor

string

分页游标。

可选

page_size

number

分页大小。

必需

query_dsl

string

查询条件。

可选

示例

{
  "cursor": "0",
  "query_dsl": "{\"queryGroupList\":[{\"logicType\":\"AND\",\"queryObjectList\":[{\"fieldId\":\"customer_name\",\"filterType\":\"EQ\",\"value\":\"xx有限公司\"}]}]}",
  "current_operator_userid": "user01",
  "page_size": "100"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/crm/objectdata/customer/query?access_token=dc73axxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cursor": "0",
    "query_dsl": "{\"queryGroupList\":[{\"logicType\":\"AND\",\"queryObjectList\":[{\"fieldId\":\"customer_name\",\"filterType\":\"EQ\",\"value\":\"xx有限公司\"}]}]}",
    "current_operator_userid": "user01",
    "page_size": "100"
}'

返回响应

🟢200成功

application/json

Body

result

object

分页查询的结果。

可选

next_cursor

string

下一页的游标。

可选

values

array [object {8}]

数据列表。

可选

has_more

boolean

是否有下一页。

可选

page_size

number

分页大小。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

示例

{
  "result": {
    "next_cursor": "string",
    "values": [
      {
        "gmt_modified": "string",
        "creator_userid": "string",
        "instance_id": "string",
        "data": "string",
        "extend_data": "string",
        "gmt_create": "string",
        "object_type": "string",
        "permission": {
          "owner_userid_list": [
            "string"
          ],
          "participant_userid_list": [
            "string"
          ]
        }
      }
    ],
    "has_more": true,
    "page_size": 0
  },
  "errcode": 0,
  "errmsg": "string"
}

删除CRM客户数据

按照ID列表批量获取客户数据

批量获取客户数据

说明#

权限#

请求参数

示例代码

返回响应

说明

权限