概述 - 钉钉 API copy

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

客户管理（官方CRM）使用说明

免费提供基础的客户管理能力，包括客户表单、服务群、服务窗、表单搭建、关联表单等，并且支持打通日志、审批、日程、签到、待办等，帮助企业实现轻量级、便捷的管理客户。

主数据结构

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	关联的联系人

对应的主数据结构：

主数据名称	主数据类型	主数据字段	字段类型	对应JAVA类型
企业客户	crm_customer	customer_name	TextField	String
customer_follow_up_status	DDSelectField	JSONObject
address	AddressField	JSONObject
个人客户	crm_customer_personal	customer_name	TextField	String
customer_follow_up_status	DDSelectField	JSONObject
address	AddressField	JSONObject
customer_phone	PhoneField	JSONObject
gender	DDSelectField	JSONObject
birthday	DDDateField	JSONObject
identity	DDSelectField	JSONObject
wechat	TextField	String
qq	TextField	String
email	TextField	String
联系人	crm_contact	contact_related_customer	FormRelatedField	JSONObject
contact_name	TextField	String
contact_phone	PhoneField	String
跟进记录	crm_follow_record	follow_record_related_customer	FormRelatedField	JSONObject
follow_record_related_contact	FormRelatedField	JSONObject

关联字段JSON格式，以联系人为例，结构如下：

说明

extendValue中有list字段表明了引用的数据ID。

{
    "contact_related_customer": {
        "value": "[\"222222\"]",
        "extendValue": "{\"quote\":1,\"list\":[{\"instanceId\":\"b9f5e82b-57eb-4528-92a9-0d25409950d9\",\"rowValue\":[{\"bizAlias\":\"customer_name\",\"label\":\"客户名称\",\"value\":\"222222\",\"key\":\"TextField-K2U5DHAA\"}],\"formCode\":\"PROC-3FBB4B39-2951-41E4-914D-CECA7E71E8FD\"}]}"
    }
}

数据传参格式

开发者可以获取表单Schema，表单中的值都是存储在对应的控件中，而每种控件可能有不同的传参格式，下面将对常用的一些控件传参格式进行解释并给处对应demo。

表单数据一般放在入参的data里，是个json，其中key是控件的id，value是具体的值。

关联表单（FormRelateField）

{ 
  "FormRelateField-xxxx": {
    "value": "[\"张旭的关联跟进记录表单\"]",
    "extendValue": "{\"quote\":1,\"list\":[{\"formCode\":\"PROC-69B66723-E02B-483E-B57B-1768BE8771CC\",\"instanceId\":\"5aadf1e6-943a-4730-b2c5-3a3085666b62\",\"rowValue\":[{\"label\":\"输入文字\",\"key\":\"TextField-KD3VIIE8\",\"value\":\"dd \",\"componentType\":\"TextField\"}]}]}"
  }
}

value****定义：

假设A表单关联了B表单，这里外层的value就是B表单的名称，extendValue中的formCode是B表单的模版code，instanceId是B表单的id，rowValue里的值表示关联了B表单中TextField类型的控件，控件id是："TextField-KD3VIIE8"，控件名为“输入文字”，这个控件的值是"dd"。

extendValue参数补充说明：

quote取值：

1：引用

0：拷贝

instanceId：关联实例的id。

rowValue：指关联表单中的关联字段，可以是多个。

手机控件（PhoneField）

"customer_phone": {
     "extendValue": "{\"mode\":\"phone\",\"countryKey\":\"CN\",\"flag\":\"C\",\"countryCode\":\"+86\",\"areaNumber\":\"\",\"flagPy\":\"Z\",\"countryName\":\"China\",\"countryNameZh\":\"中国\",\"countryNamePy\":\"ZHONGGUO\"}",
     "value": "136********"
}

单选标签（MultiTagField）

"TagField-xxxxx": {
  "extendValue": "{\"key\":\"e88a359d6c\"}",
  "value": "重要"
 }

多选标签（MultiTagField）

"MultiTagField-xxxxx": {
  "extendValue": "[{\"key\":\"e88a359d6c\"}]",
  "value": "[\"重要\"]"
 }

地址（AddressField）

"address": {
    "extendValue": "{\"province\":{\"name\":\"北京\",\"id\":\"110000\"},\"city\":{\"name\":\"北京市\",\"id\":\"110100\"},\"street\":{\"name\":\"东华门街道\",\"id\":\"110101001\"},\"district\":{\"name\":\"东城区\",\"id\":\"110101\"},\"detail\":{\"name\":\"**路**号\"}}",
    "value": "北京,北京市,东城区,东华门街道,**路**号"
 }

单选框（DDSelectField）

{ 
  "DDSelectField-xxxx" :{
    "value": "持续跟进",
    "extendValue":"{\"key\":\"option_2\"}" 
  }
}

多选框（DDMultiSelectField）

{
  "DDMultiSelectField-xxx": {
     "value":"[\"多选1\",\"多选2\"]",
     "extendValue":"[{\"key\":\"option_xx\"},{\"key\":\"option_xx\"}]"} 
  }
}

单行文本（TextField）

{
  "TextField-xxx": "文本"
}

多行文本（TextareaField）

{
  "TextareaField_xxx": "多行文本"
}

数字输入框（NumberField）

{
  "NumberField-xxx": 123
}

日期（DDDateField）

{
  "DDDateField-xxx": 1613032818000（毫秒级时间戳）
}

数据传参示例

{
  "data": {
    "customer_name": "第10086个测试数据手机-关联表单2",
    "FormRelateField-KDO8X8NG": {
      "value": [
        "**的关联自定义表单"
      ],
      "extendValue": {
        "quote": 1,
        "list": [{
          "formCode": "PROC-DC72080A-087E-42EA-8606-A6F9C91185DF",
          "instanceId": "17e2df50-093a-4580-8b6a-cff8d55efa75",
          "rowValue": []
        }]
      }
    },
    "DDSelectField_6LZ66UD2NM80": {
      "value": "我，我testst",
      "extendValue": "{ \"key\":  \"d4f02119-2847-4695-9804-b7b4e73db665\"}"
    },
    "DDSelectField-K371T4RY": {
      "value": "持续跟进",
      "extendValue": "{\"key\":\"option_2\"}"
    },
    "TextField-K55CWZ2D": "哈哈哈哈",
    "NumberField-KHYZA17O": 234,
    "TextareaField_2041PS98SIN40": "sdf \nsdfsdf\n手动阀十三水",
    "DDDateField_1S0PTMEFECG00": 16130328,
    "NumberField_YYWXGBU2DEO0": 123,
    "MoneyField_134FD5T1JMPS0": "324",
    "PhoneField_92L7IK0IJNK0": "+86-17130423756"
  },
  "extend_data": {},
  "creator_userid": "manager9388",
  "creator_nick": "李四",
  "permission": {
    "participant_userids": ["manager9388"],
    "owner_userids": ["manager9388"]
  }
}

接入前咨询

如果企业内部应用接入有疑问的话，可以通过以下方式加入群，在群里咨询群管理员。

打开钉钉，搜索钉钉群号31827123，加入客户管理开放api接入咨询群。

打开钉钉，扫描以下二维码加入群。
p239254

概述

客户管理（官方CRM）使用说明#

主数据结构#

数据传参格式#

数据传参示例#

接入前咨询#

相关链接#

客户管理（官方CRM）使用说明

主数据结构

数据传参格式

数据传参示例

接入前咨询

相关链接