获取全量个人或企业客户数据

POST

/v1.0/crm/customerInstances

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

调用本接口，获取CRM个人或企业客户数据，包括私海个人客户、私海企业客户、公海个人客户、公海企业客户。单个ISV单企业限流1QPS。

例如，在企业的客户管理中的客户列表中，客户信息如下图所示。调用本接口，可获取CRM个人或企业客户数据。

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	crm.not.installed	crm.not.installed	客户管理应用未安装。
400	request.too.frequent	请求太频繁	请求过于频繁。
400	invalid.objectType	invalid objectType	不存在的objectType
400	param.error	参数非法	参数非法
400	org.not.exists	org not exists	组织不存在或已解散
500	system.error	系统错误	系统错误

请求参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/crm/customerInstances' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "operatorUserId" : "String",
  "maxResults" : Long,
  "nextToken" : "String",
  "objectType" : "String"
}'

响应示例

{
    "result": {
        "nextToken": "100",
        "values": [
            {
                "creatorNick": "张三",
                "modifyTime": "2019-12-25 15:33:12",
                "creatorUserId": "ding_userid",
                "instanceId": "instance_id",
                "createTime": "2019-12-25 15:33:12",
                "objectType": "crm_customer",
                "permission": {
                    "participantStaffIds": [
                        "staff_id"
                    ],
                    "ownerStaffIds": [
                        "staff_id"
                    ]
                },
                "processOutResult": "agree",
                "processInstanceStatus": "COMPLETE"
            }
        ],
        "maxResults": 100
    }
}

修改于 2024-01-18 07:46:45

批量获取个人或企业客户数据

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

获取全量个人或企业客户数据

权限#

错误码#

请求参数

返回响应

权限

错误码