概述 - 钉钉 API

本文档介绍了什么是客户管理，如何开通客户管理，客户管理开放了哪些接口能力，以及如何接入客户管理能力等。

什么是客户管理

客户管理（官方CRM）是钉钉推出的官方应用，以客户为中心一站式管理协同，灵活配置满足各类内部管理诉求，助力企业提升客户转化率。同时提供“客户群”等能力，帮助连接客户、连接组织与组织，让沟通协同更高效。客户管理开放了相关表单、数据的增删改查接口等能力，帮助企业进行系统化的客户全生命周期管理。更多功能详情可参考钉钉使用手册-客户管理。

如何开通客户管理

客户管理是钉钉默认安装的官方应用。员工可以在钉钉工作台打开应用并使用。

手机端：钉钉手机客户端-工作台

PC端：钉钉PC客户端-工作台

客户管理接口能力

客户管理开放的接口列表

客户管理提供了丰富的接口开放能力，开发者通过API接口可以实现客户管理和企业业务系统打通。

客户

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建个人或企业客户数据	添加CRM个人客户或企业客户	创建个人或企业客户数据	创建企业客户数据（历史版本）
批量新增个人或企业客户数据	批量新增个人客户、企业客户数据。	批量新增个人或企业客户数据
更新个人或企业客户数据	更新CRM个人客户或企业客户信息。	更新个人或企业客户数据	更新企业客户数据（历史版本）
批量更新个人或企业客户数据	批量修改个人客户、企业客户数据。	批量更新个人或企业客户数据
删除个人或企业客户数据	删除CRM个人客户或企业客户数据。	删除个人或企业客户数据	删除企业客户数据（历史版本）
批量获取个人或企业客户数据	批量获取CRM个人客户或企业客户。	批量获取个人或企业客户数据	批量获取客户数据（历史版本）批量获取企业客户数据（历史版本）
获取个人或企业客户的元数据	获取CRM个人客户或企业客户的元数据描述。	获取个人或企业客户的元数据	获取企业客户的元数据（历史版本）
获取全量个人或企业客户数据	获取CRM个人或企业客户数据。	获取全量个人或企业客户数据	-
根据指定条件查询个人或企业客户数据	根据指定条件查询CRM个人客户或企业客户数据。	根据指定条件查询个人或企业客户数据	-
获取个人或企业客户查重字段	获取客户管理中设置个人客户、企业客户的查重字段。	获取个人或企业客户查重字段	-
查询客户数据	根据客户的unionId查询客户详情信息。	查询客户数据	-

联系人

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
批量新增联系人数据	批量新增联系人数据。	批量新增联系人数据	创建联系人数据（历史版本）
批量修改联系人数据	批量修改联系人数据。	批量修改联系人数据	更新联系人数据（历史版本）
删除联系人数据	删除当前组织CRM指定联系人的接口。	-	删除联系人数据
根据指定条件查询联系人数据	根据指定查询条件批量获取联系人数据。	-	根据指定条件查询联系人数据
按照ID列表批量获取联系人数据	根据联系人实例id列表批量获取联系人数据。	-	按照ID列表批量获取联系人数据
获取联系人的元数据	获取钉钉CRM联系人的元数据描述。	-	获取联系人的元数据

跟进记录

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
根据指定条件查询跟进记录数据	根据指定查询条件批量获取跟进记录数据。	-	根据指定条件查询跟进记录数据
根据ID列表批量获取跟进记录数据	根据实例ID列表批量获取跟进记录数据。	-	根据ID列表批量获取跟进记录数据
获取跟进记录对象的元数据	读取钉钉CRM跟进记录对象的元数据。	-	获取跟进记录对象的元数据
批量新增跟进记录数据	批量新增客户的跟进记录。	-	批量新增跟进记录数据
批量更新跟进记录数据	批量更新客户的跟进记录。	-	批量更新跟进记录数据
批量删除跟进记录数据	批量删除客户的跟进记录。	-	批量删除跟进记录数据

自定义对象

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建CRM自定义对象数据	创建自定义对象数据。	-	创建CRM自定义对象数据
更新自定义对象数据	更新CRM自定义对象数据。	-	更新自定义对象数据
获取自定义对象的元数据	读取钉钉CRM自定义对象的元数据描述。	-	获取自定义对象的元数据
根据指定条件查询自定义对象数据	根据指定条件分页查询自定义对象数据。	-	根据指定条件查询自定义对象数据
按照ID列表批量获取CRM自定义表单数据	根据实例ID列表批量获取CRM自定义表单数据。	-	按照ID列表批量获取CRM自定义表单数据
删除CRM自定义对象数据	删除CRM自定义对象数据。	删除CRM自定义对象数据	-

客户群

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建客户群	创建客户群。	创建客户群	-
查询客户群列表	根据指定过滤条件和排序规则，查询客户群列表数据。	查询客户群列表	-
获取单个客户群详情	获取单个客户群的详情数据。	获取单个客户群详情	-
批量查询客户群	批量查询客户群的信息。	批量查询客户群	-
创建客户群组	创建客户群组。	创建客户群组	-
获取单个客户群组详情	获取单个客户群组详情。	获取单个客户群组详情	-
更新客户群组	更新客户群组信息。	更新客户群组	-
查询客户群组列表	根据指定的筛选条件和排序规则，查询客户群组列表数据。	查询客户群组列表	-

服务窗

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取服务窗联系人信息	获取服务窗联系人信息。	获取服务窗联系人信息（历史版本）	-
批量获取服务窗联系人数据	分页获取服务窗联系人数据。	批量获取服务窗联系人数据（历史版本）	-

客户管理回调事件列表

客户管理支持元数据实例和主数据实例新增、更新及删除回调事件。

元数据回调事件

主数据回调事件

如何接入客户管理接口能力

钉钉提供了客户管理接口接入流程示例：

名词解释

术语	说明
企业客户	ToB类型的客户，例如某某企业。
个人客户	ToC类型的客户，例如某个家长。
联系人	联系人可以归属于某个企业客户或个人客户，一个企业/个人客户下最多30个联系人。
跟进记录	用于保存对企业/个人客户的跟进记录。
自定义对象	用户自定义的表单数据。
元数据	客户管理中的企业客户、个人客户、联系人、跟进记录、自定义对象都支持用户自行设计对象结构的能力，元数据描述了这些对象的数据结构（字段名、类型、是否必填等）。
客户动态	客户相关的操作记录，修改客户、添加联系人、添加跟进记录等动作都会生成对应客户的客户动态。
查重	指防止客户数据重复创建的能力，企业客户默认查重规则为客户名称唯一，个人客户默认查重规则为电话号码唯一，企业可以自行在客户管理后台修改查重规则。
客户群	企业员工和客户沟通协作的IM群。
客户群组	客户群组是同类客户群的集合，客户群组拥有自动裂变的能力，当某个客户群内满员时，会自动裂变出一个新的客户群用于加人，助力企业的营销活动。

主数据结构

CRM中客户、联系人和跟进记录的表单结构如下表所示：

字段名	对象名称	字段类型	字段名称	字段描述
企业客户	crm_customer	TextField	bizAlias:customer_name	客户姓名
DDSelectField	bizAlias:customer_follow_up_status	客户跟进状态
AddressField	bizAlias:address	地址
个人客户	crm_customer_personal	TextField	bizAlias:customer_name	客户姓名
DDSelectField	bizAlias:customer_follow_up_status	客户跟进状态
AddressField	bizAlias:address	地址
PhoneField	bizAlias:customer_phone	电话
DDSelectField	bizAlias:gender	性别
DDDateField	bizAlias:birthday	生日
DDSelectField	bizAlias:identity	身份
TextField	bizAlias:wechat	微信号
TextField	bizAlias:qq	QQ
TextField	bizAlias:email	邮箱
联系人	crm_contact	FormRelatedField	bizAlias:contact_related_customer	关联的客户
TextField	bizAlias:contact_name	联系人姓名
PhoneField	bizAlias:contact_phone	电话
跟进记录	crm_follow_record	FormRelatedField	bizAlias:follow_record_related_customer	关联的客户
FormRelatedField	bizAlias:follow_record_related_contact	关联的联系人

概述

什么是客户管理#

如何开通客户管理#

客户管理接口能力#

客户管理开放的接口列表#

客户管理回调事件列表#

如何接入客户管理接口能力#

名词解释#

主数据结构#