本文介绍了不纳入每月调用量限制的接口清单,包括基础接口(获取访问凭证、身份验证(免登)和通讯录)、宜搭接口和生态接口的清单。
基础接口清单
获取访问凭证接口
API | 接口说明 | 接口版本 |
获取企业内部应用的access_token | 调用本接口获取access_token,调用服务端API获取应用资源时,需要通过access_token来鉴权调用者身份进行授权。 | 服务端 |
获取企业内部应用的accessToken | 调用本接口获取access_token,调用服务端API获取应用资源时,需要通过access_token来鉴权调用者身份进行授权。 | 新版服务端 |
获取第三方个人应用的access_token | 调用本接口获取第三方个人应用的access_token。 | 服务端 |
获取用户token | 调用本接口获取用户token。 | 新版服务端 |
获取jsapi_ticket | 当开发H5微应用时,需要先通过本接口获取jsapi_ticket,然后再生成鉴权签名,最后调用dd.config完成鉴权。 | 服务端 |
创建jsapi ticket | 当开发H5微应用时,需要先通过本接口获取jsapi_ticket,然后再生成鉴权签名,最后调用dd.config完成鉴权。 | 新版服务端 |
获取微应用后台免登的access_token | 调用本接口获取微应用后台免登的access_token。获取的access_token即ssotoken只在应用管理后台免登场景中使用。 | 服务端 |
获取微应用后台免登的access_token | 调用本接口获取微应用后台免登的access_token。获取的access_token只在应用管理后台免登场景中使用。 | 新版服务端 |
查询个人授权记录 | 当需要查询用户的授权记录信息时,可以调用本接口查询用户的个人授权记录。 | 新版服务端 |
身份验证(免登)接口
API | 接口说明 | 接口版本 |
通过免登码获取用户信息 | 在第三方企业应用免登和企业内部应用免登场景中,开发者需要使用本接口通过access_token和免登接口中获取的code来获取用户userid。 | 服务端 |
获取应用管理后台免登的用户信息 | 在应用管理后台免登场景中,需要本接口通过获取到的免登授权码code和获取到的应用后台免登的access_token来换取应用管理员的身份信息。 | 服务端 |
获取应用管理后台免登的用户信息 | 在应用管理后台免登场景中,需要本接口通过获取到的免登授权码code和获取到的应用后台免登的access_token来换取应用管理员的身份信息。 | 新版服务端 |
根据sns临时授权码获取用户信息 | 调用本接口根据sns临时授权码获取用户信息。 | 服务端 |
通讯录管理接口
用户管理
API | 接口说明 | 接口版本 |
创建用户 | 调用本接口创建新用户。 | 服务端 |
更新用户信息 | 调用本接口更新指定的用户信息。 | 服务端 |
查询用户详情 | 调用本接口获取指定用户的详细信息。 | 服务端 |
删除用户 | 调用本接口根据用户的userid删除指定用户。 | 服务端 |
获取部门用户基础信息 | 调用本接口获取指定部门的用户基础信息。 | 服务端 |
获取部门用户详情 | 调用本接口获取指定部门中的用户详细信息。 | 服务端 |
获取部门用户userid列表 | 调用本接口获取指定部门的userid列表。 | 服务端 |
获取员工人数 | 调用本接口获取员工人数。 | 服务端 |
获取未登录钉钉的员工列表 | 调用本接口查询指定日期内未登录钉钉的企业员工列表。 | 服务端 |
根据手机号查询用户 | 调用本接口根据手机号获取专属帐号用户的userId。 | 服务端 |
根据unionid获取用户userid | 调用本接口根据unionid获取用户的userid。 | 服务端 |
获取管理员列表 | 调用本接口查询管理员列表。 | 服务端 |
获取管理员通讯录权限范围 | 调用本接口获取管理员通讯录权限范围。 | 服务端 |
查询离职记录列表 | 调用本接口查询企业离职记录列表,包含离职员工的离职日期、手机号码和退出企业方式等信息。 | 新版服务端 |
设置高管模式 | 调用本接口设置员工的高管模式。 | 新版服务端 |
获取用户高管模式设置 | 调用本接口获取用户高管模式设置。 | 新版服务端 |
删除用户属性可见性设置 | 调用本接口删除企业员工属性字段可见性设置。 | 新版服务端 |
获取用户属性可见性设置 | 调用本接口获取用户属性可见性设置。 | 新版服务端 |
设置用户属性可见性 | 调用本接口设置用户属性可见性。 | 新版服务端 |
获取用户通讯录个人信息 | 调用本接口获取企业用户通讯录中的个人信息。 | 新版服务端 |
部门管理
API | 接口说明 | 接口版本 |
创建部门 | 调用本接口创建新部门。 | 服务端 |
更新部门 | 调用本接口更新部门信息。 | 服务端 |
删除部门 | 调用本接口根据部门ID删除指定部门。 | 服务端 |
获取部门详情 | 调用本接口根据部门ID获取指定部门详情。 | 服务端 |
获取部门列表 | 调用本接口获取下一级部门基础信息。 | 服务端 |
获取子部门ID列表 | 调用本接口获取企业部门下的所有直属子部门列表。 | 服务端 |
获取指定部门的所有父部门列表 | 调用本接口获取指定部门的所有父部门ID列表。 | 服务端 |
获取指定用户的所有父部门列表 | 调用本接口查询指定用户所属的所有父级部门。 | 服务端 |
角色管理
API | 接口说明 | 接口版本 |
创建角色 | 调用本接口创建新角色。 | 服务端 |
创建角色组 | 调用本接口创建角色组。 | 服务端 |
更新角色名称 | 调用本接口更新角色名称。 | 服务端 |
批量增加员工角色 | 调用本接口批量增加员工角色。 | 服务端 |
删除角色 | 调用本接口根据角色ID删除指定的角色。 | 服务端 |
批量删除员工角色 | 调用本接口批量删除员工的角色。 | 服务端 |
设定角色成员管理范围 | 调用本接口设定角色成员管理范围。 | 服务端 |
获取角色组列表 | 调用本接口获取角色组信息。 | 服务端 |
获取角色列表 | 调用本接口获取角色列表。 | 服务端 |
获取角色详情 | 调用本接口根据角色ID获取指定角色详情。 | 服务端 |
获取指定角色的员工列表 | 调用本接口获取指定角色的员工列表。 | 服务端 |
外部联系人
API | 接口说明 | 接口版本 |
添加外部联系人 | 调用本接口添加企业外部联系人。 | 服务端 |
删除外部联系人 | 调用本接口删除企业外部联系人。 | 服务端 |
更新外部联系人 | 调用本接口更新企业外部联系人。 | 服务端 |
获取外部联系人列表 | 调用本接口获取企业外部联系人列表。 | 服务端 |
获取外部联系人标签列表 | 调用本接口获取企业外部联系人的标签。 | 服务端 |
获取外部联系人详情 | 调用本接口获取企业外部联系人的详细信息。 | 服务端 |
企业管理
API | 接口说明 | 接口版本 |
获取企业邀请信息 | 调用本接口获取企业的邀请信息。 | 新版服务端 |
获取企业最新钉钉指数信息 | 调用本接口获取企业最新钉钉指数信息。 | 新版服务端 |
获取企业认证信息 | 调用本接口获取企业认证信息。 | 新版服务端 |
通讯录可见性管理
API | 接口说明 | 接口版本 |
获取通讯录隐藏设置 | 调用本接口批量获取通讯录隐藏的设置列表。 | 新版服务端 |
删除通讯录隐藏设置 | 调用本接口删除通讯录隐藏设置。 | 新版服务端 |
更新通讯录隐藏设置 | 调用本接口更新通讯录隐藏设置。 | 新版服务端 |
设置部门可见性优先级 | 调用本接口设置通讯录部门可见性优先级。 | 新版服务端 |
智能人事接口清单
API | 接口说明 | 接口版本 |
添加企业待入职员工 | 添加企业待入职员工。 | 服务端 |
获取待入职员工列表 | 查询企业待入职员工userid列表。 | 服务端 |
获取在职员工列表 | 查询企业在职员工userid列表。 | 服务端 |
更新员工花名册信息 | 更新员工档案信息,支持明细分组。 | 服务端 |
获取员工花名册字段信息 | 查询员工花名册指定字段的信息,支持明细分组字段。 | 服务端 |
获取花名册元数据 | 获取员工花名册的元数据,包括花名册分组、字段等。 | 服务端 |
批量获取员工离职信息 | 批量查询员工的离职信息,如离职人员的部门ID、离职主动原因和被动原因等。 | 新版服务端 |
智能人事员工调岗 | 给智能人事员工调岗,支持以下内容调整,如员工部门列表、主部门、职务、职位和职级。 | 新版服务端 |
获取离职员工列表 | 查询企业离职员工userId列表。 | 新版服务端 |
钉钉客联接口清单
API | 接口说明 | 接口版本 |
创建钉钉客联帐号关联关系 | 创建钉外用户帐号,并建立与钉内用户的帐号关联关系。 | 新版服务端 |
创建普通群或跨钉两人群 | 创建钉钉客联互通群,群类型为普通群或跨钉两人群。 | 新版服务端 |
创建钉外两人群 | 创建钉外两人群。 | 新版服务端 |
创建店铺群 | 创建店铺群。 | 新版服务端 |
获取钉钉客联群会话地址 | 获取钉钉客联群会话地址,钉外用户可通过该地址进入对应群内。 | 新版服务端 |
添加互通群成员 | 向互通群内添加群成员。 | 新版服务端 |
查询互通群成员列表 | 查询互通群成员列表,包括普通群、跨钉两人群、钉外两人群和店铺群。 | 新版服务端 |
移除互通群成员 | 移除互通群成员。 | 新版服务端 |
修改互通群头像 | 修改互通群头像,包括普通群、跨钉两人群、钉外两人群和商铺群。 | 新版服务端 |
修改互通群名称 | 修改群名称,包括普通群、跨钉两人群、钉外两人群和店铺群。 | 新版服务端 |
更换互通群群主 | 更换互通群的群主。 | 新版服务端 |
钉外用户向钉内用户或互通群发送消息 | 实现钉外用户向钉内用户或互通群发送消息。 | 新版服务端 |
钉内用户向互通群或钉外用户发送消息 | 实现钉内用户给钉外用户或者互通群发送消息。 | 新版服务端 |
互通群机器人发送群消息 | 通过互通群内机器人向群内发送消息。 | 新版服务端 |
查询钉外用户未读消息的数量 | 查询钉外用户未读消息的数量。 | 新版服务端 |
批量查询跨钉两人群列表 | 根据群成员批量查询跨钉两人群列表。 | 新版服务端 |
解散互通群 | 解散互通群,包括普通群、跨钉两人群、钉外两人群和店铺群。 | 新版服务端 |
宜搭接口清单
API | 接口说明 | 接口版本 |
发起宜搭审批流程 | 发起宜搭审批流程到钉钉开放平台。 | 新版服务端 |
删除流程实例 | 删除流程实例。 | 新版服务端 |
终止流程实例 | 终止流程实例 | 新版服务端 |
获取实例ID列表 | 获取实例ID列表。 | 新版服务端 |
批量获取流程实例列表 | 批量获取对应的流程实例详情。 | 新版服务端 |
获取流程实例 | 获取宜搭的流程实例信息,包括实例Id、创建时间、发起人等信息。 | 新版服务端 |
根据流程实例ID获取流程实例 | 根据指定流程实例ID获取流程实例详情。 | 新版服务端 |
获取指定应用下的表单列表 | 分页获取应用下的表单列表。 | 新版服务端 |
获取表单内的组件信息 | 根据表单ID,获取单据或流程表单内的组件信息。 | 新版服务端 |
查询表单实例数据 | 查询表单实例数据。 | 新版服务端 |
保存表单数据 | 新增一条无审批流程的宜搭表单实例。 | 新版服务端 |
更新表单数据 | 更新表单数据。 | 新版服务端 |
查询表单数据 | 通过表单实例ID查询表单数据。 | 新版服务端 |
获取员工组件的值 | 获取员工组件的值。 | 新版服务端 |
获取表单组件定义列表 | 取表单组件定义列表。 | 新版服务端 |
获取子表组件数据 | 过表单实例ID和子表组IDd获取子表组件数据。 | 新版服务端 |
删除表单数据 | 删除表单数据。 | 新版服务端 |
获取多个表单实例ID | 获取多个表单实例ID。 | 新版服务端 |
批量获取表单实例数据 | 批量获取表单实例详情信息,包括实例名称、实例提交人等信息。 | 新版服务端 |
批量删除表单实例 | 批量删除表单实例数据,从表单实例列表中移除。 | 新版服务端 |
批量创建表单实例 | 批量创建表单实例数据,返回新增表单实例的Id。 | 新版服务端 |
批量更新表单实例内的组件值 | 根据宜搭表单实例Id,批量更新宜搭表单实例的组件值。 | 新版服务端 |
新增或更新表单实例 | 根据筛选条件筛选表单实例,满足筛选条件则根据指定表单值更新符合查询条件的表单实例,如果不存在满足筛选条件的表单实例,则根据指定表单值新增一条表单实例。 | 新版服务端 |
通过高级查询条件获取表单实例数据(包括子表单组件数据) | 使用筛选条件获取表单实例详情。 | 新版服务端 |
通过高级查询条件获取表单实例数据(不包括子表单组件数据) | 使用筛选条件获取表单实例详情,不包括子表单组件数据。 | 新版服务端 |
通过表单实例数据批量更新表单实例 | 根据宜搭表单组件数据,批量更新表单实例信息。 | 新版服务端 |
查询表单的变更记录 | 查询宜搭表单下的变更记录。 | 新版服务端 |
获取审批记录 | 获取审批记录。 | 新版服务端 |
同意或拒绝宜搭审批任务 | 用于同意或拒绝宜搭审批任务。 | 新版服务端 |
获取组织内某人提交的任务 | 获取组织内某人提交的任务。 | 新版服务端 |
获取组织内已完成的审批任务 | 获取组织内已完成的审批任务。 | 新版服务端 |
转交任务 | 转交任务。 | 新版服务端 |
查询流程运行任务(VPC) | 查询流程运行任务(VPC)。 | 新版服务端 |
获取任务列表(组织维度) | 获取组织维度任务列表。 | 新版服务端 |
获取发送给用户的通知 | 获取发送给用户的通知。 | 新版服务端 |
查询抄送我的任务列表(应用维度) | 查询抄送我的任务列表(应用维度)。 | 新版服务端 |
批量执行宜搭审批任务 | 批量执行宜搭表单实例的审批任务。 | 新版服务端 |
提交评论 | 提交表单或流程实例下的评论。 | 新版服务端 |
批量查询宜搭表单实例的评论 | 批量查询宜搭表单下的所有评论。 | 新版服务端 |
获取宜搭附件临时免登地址 | 获取宜搭附件临时免登地址。 | 新版服务端 |
查询宜搭应用列表 | 查询组织下的宜搭应用列表,包括宜搭应用状态、宜搭应用图标和宜搭应用编码等。 | 新版服务端 |
查询宜搭表单服务调用执行记录 | 根据宜搭表单Id查询对应的服务调用执行记录信息,包括服务调用状态、服务调用地址和服务调用结果等。 | 新版服务端 |
生态接口列表
阿里商旅接口
API | 接口说明 | 接口版本 |
机票城市搜索 | 搜索火车票城市。 | 服务端 |
火车票城市搜索 | 搜索机票城市。 | 服务端 |
新建成本中心 | 新建成本中心。 | 服务端 |
修改成本中心 | 修改成本中心基本信息。 | 服务端 |
删除成本中心 | 删除成本中心。 | 服务端 |
查询成本中心 | 查询成本中心信息。 | 服务端 |
设置成本中心人员信息 | 设置成本中心人员信息。 | 服务端 |
删除成本中心人员信息 | 删除成本中心人员信息。 | 服务端 |
商旅成本中心转换为外部成本中心 | 商旅成本中心转换为外部成本中心。 | 服务端 |
添加项目 | 添加商旅项目。 | 服务端 |
修改项目 | 修改项目信息。 | 服务端 |
删除项目 | 删除项目。 | 服务端 |
新建审批单 | 新建审批单。 | 服务端 |
获取申请单列表 | 查询企业审批单数据。 | 服务端 |
获取申请单详情 | 获取单个申请单的详细信息。 | 服务端 |
修改申请单 | 修改出差申请单。 | 服务端 |
更新申请单状态 | 更新审批单状态。 | 服务端 |
搜索第三方酒店超标审批单 | 搜索第三方酒店超标审批单。 | 服务端 |
搜索第三方火车票超标审批单 | 搜索第三方火车票超标审批单。 | 服务端 |
回传第三方超标审批结果 | 回传第三方超标审批结果。 | 服务端 |
搜索第三方机票超标审批单 | 搜索第三方机票的超标审批单。 | 服务端 |
获取企业机票订单数据 | 获取企业机票订单数据 | 服务端 |
获取企业商旅酒店订单数据 | 获取商旅酒店订单数据。 | 服务端 |
获取企业火车票订单数据 | 获取企业火车票订单数据。 | 服务端 |
获取用车订单数据 | 获取企业用车订单数据。 | 服务端 |
关联单号查询相关订单信息列表 | 申请单中关联单号获取订单信息。 | 新版服务端 |
获取商旅访问地址 | 获取各个场景预订访问地址,以及我的订单地址。 | 服务端 |
新增发票配置 | 新增发票配置。 | 服务端 |
配置发票适用人群 | 配置发票适用人群。 | 服务端 |
查询可用发票列表 | 查询可用发票列表。 | 服务端 |
修改发票配置 | 修改发票配置。 | 服务端 |
删除发票信息 | 删除发票信息。 | 服务端 |
同步市内用车申请单 | 同步市内用车申请单。 | 服务端 |
审批市内用车申请单 | 审批市内用车申请单。 | 服务端 |
查询市内用车申请单 | 查询市内用车申请单。 | 服务端 |
查询用车结算记录 | 查询商旅用车的结算记账数据。 | 新版服务端 |
查询商旅火车票结算数据 | 查询商旅火车票结算记账数据。 | 新版服务端 |
查询酒店结算数据 | 查询商旅酒店结算记账数据。 | 新版服务端 |
查询机票结算数据 | 查询机票结算记账数据。 | 新版服务端 |
获取月对账结算数据 | 获取月对账结算数据下载地址。 | 服务端 |
查询预估价 | 查询预估价。 | 服务端 |
小蜜客服接口
API | 接口说明 | 接口版本 |
智能问答 | 使用小蜜客服机器人的能力进行智能问答。 | 新版服务端 |
推送小蜜机器人单聊O2O消息 | 通过小蜜客服机器人发送O2O(即Online To Offline)线上线下消息。 | 新版服务端 |
小蜜客服机器人消息回复 | 根据小蜜客服机器人sessionId进行异步消息回复。 | 新版服务端 |
查询机器人基础指标数据 | 根据机器人ID查询某时间段机器人的基础指标数据。 | 新版服务端 |
获取用户登录凭证 | 获取用户的登录凭证。 | 新版服务端 |
智能客服接口
API | 接口说明 | 接口版本 |
创建自助单 | 创建用户自定义的自助单。 | 新版服务端 |
执行工单活动 | 执行工单活动。 | 新版服务端 |
查询动作记录 | 查询动作记录。 | 新版服务端 |
分页查询工单 | 分页查询工单。 | 新版服务端 |
员工服务台
API | 接口说明 | 接口版本 |
使用服务助手推送消息 | 通过服务助手机器人给企业员工发送消息。 | 服务端 |
制造业接口
API | 接口说明 | 接口版本 |
计件报工 | 用于MES系统上报计件数据到平台。 | 新版服务端 |
查询计件报工数据 | 查询计件报工的数据。 | 新版服务端 |
e签宝接口
API | 接口说明 | 接口版本 |
e签宝数据初始化 | 帮助钉钉企业进行e签宝开放平台的数据初始化。 | 新版服务端 |
获取授权的页面地址 | 获取企业授权的页面地址。 | 新版服务端 |
取消企业授权 | 取消授权过企业的授权状态。 | 新版服务端 |
套餐转售—分润模式 | 为使用电子合同的用户创建转售订单。 | 新版服务端 |
套餐转售—底价结算模式 | 直接转售e签宝订单给最终真正使用电子合同的用户。 | 新版服务端 |
查询套餐余量 | 查询当前企业的套餐余量。 | 新版服务端 |
获取企业的e签宝微应用状态 | 获取企业的e签宝微应用状态。 | 新版服务端 |
查询企业是否实名认证 | 查询企业是否已在e签宝完成实名认证。 | 新版服务端 |
获取企业控制台地址 | 获取的企业在e签宝的控制台地址。 | 新版服务端 |
查询个人是否实名认证 | 查询当前用户是否已在e签宝完成实名认证。 | 新版服务端 |
获取个人实名的地址 | 通过个人信息接口查询到个人未实名时,可调用本接口获取个人实名认证地址。 | 新版服务端 |
获取跳转到企业实名的地址 | 通过企业信息接口查询到企业未实名时,可调用本接口获取实名地址,在应用内展示给企业。 | 新版服务端 |
获取文件上传地址 | 获取到文件上传地址。 | 新版服务端 |
获取文件详情 | 查询文件详情。 | 新版服务端 |
获取发起签署任务的地址 | 获取发起签署任务的地址。 | 新版服务端 |
创建签署流程 | 当ISV侧企业有文件需签署时,可调用本接口获取发起签署地址。 | 新版服务端 |
获取签署人签署地址 | 获取签署人签署地址。 | 新版服务端 |
获取流程的签署详情 | 根据taskId获取流程签署相关的详细信息。 | 新版服务端 |
获取流程任务用印审批列表 | 获取流程任务用印审批列表。 | 新版服务端 |
获取流程详细信息及操作记录 | 获取流程详细信息及操作记录。 | 新版服务端 |
获取流程任务的所有合同列表 | 获取流程任务的所有合同列表,收到签署完成消息后查询。 | 新版服务端 |
金智CRM接口
API | 接口说明 | 接口版本 |
客户资料 | 新增或编辑客户资料。 | 新版服务端 |
客户公共池 | 新增或编辑客户公共池。 | 新版服务端 |
联系人 | 新增或编辑联系人。 | 新版服务端 |
合同订单 | 新增或编辑合同订单。 | 新版服务端 |
发货单 | 新增或编辑发货单。 | 新版服务端 |
销售换货单 | 新增或编辑销售换货单。 | 新版服务端 |
销售机会 | 新增或编辑销售机会。 | 新版服务端 |
报价记录 | 新增或编辑报价记录。 | 新版服务端 |
采购单 | 新增或编辑采购单。 | 新版服务端 |
生产单 | 新增或编辑生产单。 | 新版服务端 |
产品信息 | 新增或编辑产品信息。 | 新版服务端 |
入库单 | 新增或编辑入库单。 | 新版服务端 |
出库单 | 新增或编辑出库单。 | 新版服务端 |
获取数据列表 | 获取各种单据的列表数据。 | 新版服务端 |
获取数据详情 | 获取各种单据的详情数据。 | 新版服务端 |
氚云接口
API | 接口说明 | 接口版本 |
获取应用列表 | 查询氚云的应用信息。 | 新版服务端 |
获取应用功能节点 | 获取应用的功能节点信息。 | 新版服务端 |
获取组织数据 | 获取组织部门数据信息。 | 新版服务端 |
获取用户数据 | 获取用户基础数据信息。 | 新版服务端 |
获取角色数据 | 获取角色组、角色数据等信息。 | 新版服务端 |
获取角色用户数据 | 获取指定角色包含的用户。 | 新版服务端 |
获取表单对象结构 | 获取表单对象结构信息。 | 新版服务端 |
创建表单业务数据 | 创建单条表单、流程表单的业务数据对象。 | 新版服务端 |
查询表单业务数据列表 | 查询表单业务数据实例集合。 | 新版服务端 |
修改表单业务对象数据 | 修改表单的单条业务实例数据。 | 新版服务端 |
批量新增表单业务数据 | 批量新增表单的业务实例数据。 | 新版服务端 |
删除业务对象 | 批量新增表单的业务实例数据。 | 新版服务端 |
获取业务实例信息 | 获取表单的单条业务实例数据。 | 新版服务端 |
创建流程实例 | 创建流程表单的流程实例数据。 | 新版服务端 |
删除流程实例数据 | 流程表单的单条流程实例数据。 | 新版服务端 |
取消流程实例 | 取消流程实例,取消后的流程实例状态为已取消。 | 新版服务端 |
查询流程实例 | 查询流程表单的流程实例数据。 | 新版服务端 |
查询流程实例节点工作项 | 获取流程实例节点工作项的相关信息。 | 新版服务端 |
获取附件临时访问地址 | 获取附件临时免登的访问地址。 | 新版服务端 |
获取文件上传地址 | 返回表单中指定图片、附件等控件的文件上传地址。 | 新版服务端 |