获取个人或企业客户的元数据

GET

/v1.0/crm/personalCustomers/objectMeta

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

调用本接口，获取CRM个人客户或企业客户的元数据描述，包括字段名、字段Id、字段类型等信息。

例如，在企业客户管理应用中，企业客户列表如下图所示。调用本接口可获取客户名称、客户标签、协同人等列的详细属性信息。

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	invalidParam	invalid param, %s	应用id不能为空
400	systemError.notPermittedAccess	system error, %s	无权限操作
400	systemError	system error, %s	获取模板归属应用失败
400	businessError	businessError, %s	业务错误

请求参数

Query 参数

Header 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/crm/personalCustomers/objectMeta?relationType' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "name": "对象名称",
    "customized": false,
    "fields": [
        {
            "name": "customer_name",
            "customized": false,
            "label": "抱壹",
            "type": "Text",
            "nillable": false,
            "format": "yyyy-MM-dd",
            "unit": "天",
            "selectOptions": [
                {
                    "key": "option_1",
                    "value": "选项1"
                }
            ],
            "quote": true,
            "referenceTo": "crm_contact",
            "referenceFields": [
                {
                    "label": "联系人名称",
                    "type": "Text",
                    "nillable": false,
                    "unit": "天",
                    "format": "yyyy-MM-dd",
                    "selectOptions": [
                        {
                            "key": "option_2",
                            "value": "选项2"
                        }
                    ],
                    "name": "crm_customer"
                }
            ],
            "rollUpSummaryFields": [
                {
                    "name": "Money-XDADDF",
                    "aggregator": "SUM"
                }
            ]
        }
    ],
    "status": "PUBLISHED",
    "code": "PROC-XXXX"
}

修改于 2024-01-18 07:32:44

根据unionId获取客户信息流程

创建个人或企业客户数据

获取个人或企业客户的元数据

权限#

错误码#

请求参数

返回响应

权限

错误码