《钉钉应用开发者速成手册》之“钉钉能力概览——服务端API”

简介: 为满足开发者基于钉钉进行应用开发的需求,钉钉开放平台为用户提供服务端API和前端API共500多个接口给开发者使用

服务端API

获取凭证

API

说明

企业内部应用

第三方企业应用

第三方个人应用

获取企业内部应用的access_token

获取企业内部应用的access_token企业内部应用调用本接口获取access_token。

支持

不支持

不支持

获取第三方应用授权企业的access_token

获取第三方应用授权企业的access_token定制服务商应用和服务商可通过此接口获取授权企业的access_token。

支持

支持

不支持

获取第三方企业应用的suite_acess_token

获取第三方企业应用的suite_access_token。

不支持

支持

不支持

获取jsapi_ticket

获取jsapi_ticket。

支持

支持

不支持

获取微应用后台免登的access_token

获取微应用后台免登的access_token。

支持

支持

不支持

身份验证(免登)

API名称

说明

企业内部应用

第三方企业应用

第三方个人应用

通过免登码获取用户信息

通过access_token和免登接口中获取的code来获取用户userid。

支持

支持

不支持

通过免登码获取用户信息(v2)

通过access_token和免登接口中获取的code来获取用户userid。

支持

支持

不支持

获取微应用管理员的身份信息

通过access_token和获取到的免登授权码code来换取微应用管理员的身份信息。

支持

支持

不支持

根据sns临时授权码获取用户信息

根据sns临时授权码获取用户信息。

不支持

不支持

支持

HTTP回调

API

说明

企业内部应用

第三方企业应用

第三方个人应用

注册回调事件

注册回调事件。

支持

支持

不支持

获取推送失败的事件列表

获取推送失败的变更事件。

支持

支持

不支持

更新事件接口

更新已经注册的回调事件。

支持

支持

不支持

查询订阅事件

查询已经注册的回调事件。

支持

支持

不支持

删除事件回调接口

删除事件回调接口。

支持

支持

不支持

应用授权

API

说明

企业内部应用

第三方企业应用

第三方个人应用

激活应用

在收到HTTP回调推送的企业授权开通应用事件后,激活企业授权的应用。

不支持

支持

不支持

获取授权应用的基本信息

获取已授权开通的企业的指定应用的基本信息。

不支持

支持

不支持

获取企业授权信息

获取企业授权信息。

支持

支持

不支持

获取授权企业的永久授权码

获取企业的永久授权码。

不支持

支持

不支持

获取应用未激活的企业列表

获取应用未激活的企业列表。

不支持

支持

不支持

重新授权未激活应用的企业

重新授权未激活应用的企业。

不支持

支持

不支持

通讯录管理

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

获取通讯录权限范围

获取通讯录权限范围

获取通讯录权限范围。

支持

支持

不支持

用户管理(1.0)

创建用户

创建新用户。

支持

不支持

不支持

删除用户

删除指定用户。

支持

不支持

不支持

更新用户详情

更新用户详情。

支持

不支持

不支持

根据手机号获取userid

获取用户的userid。

支持

不支持

不支持

根据userid获取用户详情

根据userid获取用户详情。

支持

支持

不支持

获取部门用户userid列表

根据部门ID获取指定部门的userid列表。

支持

支持

不支持

获取部门用户列表

获取部门下的用户列表。

支持

支持

不支持

获取部门用户详情

获取部门用户详情。

支持

支持

不支持

根据unionid获取userid

根据unionid获取用户的userid。

支持

支持

不支持

获取企业员工人数

获取企业员工的人数。

支持

支持

不支持

获取未登录钉钉的员工列表

查询指定日期内未登录钉钉的企业员工列表。

支持

不支持

不支持

获取管理员列表

获取管理员列表。

支持

支持

不支持

获取管理员通讯录权限范围

获取管理员通讯录权限范围。

支持

支持

不支持

获取管理员的应用管理权限

获取管理员的应用管理权限。

不支持

支持

不支持

用户管理(2.0)

创建用户

创建新用户。

支持

不支持

不支持

更新用户信息

更新指定的用户信息。

支持

不支持

不支持

删除用户

删除指定用户。

支持

不支持

不支持

根据userid获取用户详情

获取指定用户的详细信息。

支持

支持

不支持

获取部门用户基础信息

获取指定部门的用户userid和name。

支持

支持

不支持

获取部门用户userid列表

获取指定部门的userid列表。

支持

支持

不支持

获取部门用户详情

获取指定部门中的用户详细信息。

支持

支持

不支持

获取员工人数

获取员工人数。

支持

支持

不支持

获取未登录钉钉的员工列表

查询指定日期内未登录钉钉的企业员工列表。

支持

不支持

不支持

获取管理员列表

查询管理员列表。

支持

支持

不支持

获取管理员通讯录权限范围

获取管理员通讯录权限范围。

支持

支持

不支持

获取管理员的应用管理权限

获取管理员的应用管理权限。

不支持

支持

不支持

根据手机号获取userid

根据手机号获取用户的userid。

支持

支持

不支持

根据unionid获取用户userid

根据unionid获取用户的userid。

支持

支持

不支持

部门管理(1.0)

创建部门

创建新部门。

支持

不支持

不支持

删除部门

根据部门ID删除指定部门。

支持

不支持

不支持

更新部门

更新部门信息。

支持

不支持

不支持

获取部门详情

获取部门详细信息。

支持

支持

不支持

获取部门列表

获取部门列表信息。

支持

支持

不支持

获取子部门ID列表

获取子部门ID列表。

支持

支持

不支持

查询部门的所有上级父部门路径

查询指定部门的所有上级父部门路径。

支持

支持

不支持

查询指定用户的所有上级父部门路径

查询指定用户的所有上级父部门路径。

支持

支持

不支持

部门管理(2.0)

创建部门

创建新部门。

支持

不支持

不支持

更新部门

更新部门信息。

支持

不支持

不支持

删除部门

根据部门ID删除指定部门。

支持

不支持

不支持

获取部门详情

根据部门ID获取指定部门详情。

支持

支持

不支持

获取子部门ID列表

获取企业部门下的所有直属子部门列表。

支持

支持

不支持

获取指定用户的所有父部门列

查询指定用户所属的所有父级部门。

支持

支持

不支持

获取指定部门的所有父部门列表

获取指定部门的所有部门列表。

支持

支持

不支持

获取部门列表

获取部门列表。

支持

支持

不支持

角色管理

获取角色组列表

获取角色组信息。

支持

支持

不支持

获取角色列表

获取角色列表。

支持

支持

不支持

获取角色详情

根据角色ID获取指定角色详情。

支持

支持

不支持

获取指定角色的员工列表

获取指定角色的员工列表。

支持

支持

不支持

创建角色

创建新角色。

支持

不支持

不支持

创建角色组

创建角色组。

支持

不支持

不支持

更新角色

更新角色名称。

支持

不支持

不支持

批量增加员工角色

批量增加员工角色。

支持

不支持

不支持

删除角色

删除指定的角色。

支持

不支持

不支持

批量删除员工角色

批量删除员工的角色。

支持

不支持

不支持

设定角色成员管理范围

设定角色成员管理范围。

支持

不支持

不支持

外部联系人

获取外部联系人列表

获取企业外部联系人列表。

支持

支持

不支持

获取外部联系人标签列表

获取企业外部联系人的标签。

支持

支持

不支持

获取外部联系人详情

获取企业外部联系人的详细信息。

支持

支持

不支持

添加外部联系人

添加企业外部联系人。

支持

不支持

不支持

删除外部联系人

删除企业外部联系人

支持

不支持

不支持

更新外部联系人

更新企业外部联系人。

支持

不支持

不支持

行业通讯录

获取部门详情

根据部门ID获取部门详情。

支持

支持

不支持

获取部门下人员列表

获取部门下的人员列表信息。

支持

支持

不支持

获取部门列表

根据部门ID获取部门列表。

支持

支持

不支持

获取部门用户详情

获取部门用户详情。

支持

支持

不支持

获取企业信息

获取行业通讯录的企业信息。

支持

支持

不支持

互联平台

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

合作空间

获取加入或申请加入合作空间的组织和个人信息

获取加入或申请加入合作空间的组织和个人信息。

支持

支持

不支持

获取企业已经加入或申请加入的合作空间的信

获取企业已经加入或申请加入的合作空间的信息。

支持

支持

不支持

关联组织

获取主干组织列表

获取主干组织列表。

支持

支持

不支持

获取分支组织列表

获取分支组织列表。

支持

支持

不支持

消息通知

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

工作通知

使用模板发送工作通知消息

使用消息模板发送工作通知。

不支持

支持

不支持

发送工作通知

发送工作通知消息。

支持

支持

不支持

更新工作通知状态栏

更新OA工作通知消息的状态。

支持

支持

不支持

获取工作通知消息的发送进度

获取工作通知消息的发送进度。

支持

支持

不支持

获取工作通知消息的发送结果

查询工作通知消息的发送结果。

支持

支持

不支持

撤回工作通知消息

撤回工作消息通知。

支持

支持

不支持

企业群消息

发送消息到企业群

发送消息到企业群。

支持

不支持

不支持

查询群消息已读人员列表

查询群消息已读人员列表。

支持

不支持

不支持

群消息

创建群会话

创建群会话。

支持

不支持

不支持

获取群会话信息

获取群设置和成员信息。

支持

不支持

不支持

修改群会话

修改群会话。

支持

不支持

不支持

设置群管理员

设置群管理员。

支持

不支持

不支持

设置禁止群成员私聊

设置群成员之间是否可以添加好友和私聊。

支持

不支持

不支持

获取入群二维码链接

获取群入群二维码邀请链接。

支持

不支持

不支持

设置群成员昵称

设置群成员在群中的昵称。

支持

不支持

不支持

普通消息

发送普通消息

发送普通消息。

支持

支持

不支持

智能工作流

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

官方工作流

创建或更新审批模板

创建或更新审批模板。

不支持

支持

不支持

发起审批实例

发起一个审批。

支持

支持

不支持

终止审批流程

终止当前企业下发起的审批实例。

支持

不支持

不支持

下载审批附件

审批文件下载授权,并且生成下载链接。

支持

不支持

不支持

获取审批实例ID列表

获取权限范围内的相关部门审批实例ID列表。

支持

不支持

不支持

获取审批实例详情

获取审批实例详情。

支持

支持

不支持

获取用户待审批数量

获取指定用户待处理的审批数量。

支持

不支持

不支持

获取指定用户可见的审批表单列表

分页获取指定用户可见的审批表单列表。

支持

不支持

不支持

获取审批钉盘空间信息

获取审批钉盘空间的ID并授予当前用户上传附件的权限。

支持

支持

不支持

授权预览审批附件

授权预览审批附件。

支持

支持

不支持

查询已设置为条件的表单组件

查询已设置为条件的表单组件。

不支持

支持

不支持

添加审批评论

对审批实例添加评论。

支持

不支持

不支持

获取当前企业所有可管理的模版

获取当前企业所有可管理的审批模板。

支持

不支持

不支持

执行审批操作带附件

对某个审批节点进行审批。

支持

不支持

不支持

授权下载审批钉盘文件

对钉盘文件进行授权,包括下载和预览权限。

支持

不支持

不支持

自有工作流

创建或更新审批模板

创建或更新审批模板。

支持

支持

不支持

获取模板code

查询process_code。

支持

支持

不支持

删除模板

删除为企业创建的审批模板,同时删除该模板下创建的实例和待办任务。

支持

支持

不支持

清理工作流数据

清理工作流数据。

不支持

支持

不支持

创建实例

创建不带流程的审批实例。

支持

支持

不支持

更新实例状态

更新实例状态。

支持

支持

不支持

批量更新实例状态

批量更新实例状态。

支持

支持

不支持

创建待办事项

把待办事项的审批节点信息同步到钉钉待办。

支持

支持

不支持

查询待办列表

查询用户待办任务。

支持

支持

不支持

更新待办状态

更新待办任务的状态。

支持

支持

不支持

批量取消待办

实现在或签等场景下,批量将正在运行中的待办事项设置为CANCELED。

支持

支持

不支持

智能填表

API

说明

企业内部应用

第三方企业应用

第三方个人应用

获取用户创建的填表模板

获取用户创建的填表模板。

支持

支持

不支持

获取填表实例数据

获取填表实例数据。

支持

支持

不支持

获取实例详情

获取表单实例详情。

支持

不支持

不支持

智能人事

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

智能人事

获取在职员工列表

查询企业在职员工userid列表。

支持

支持

不支持

获取待入职员工列

查询企业待入职员工userid列表。

支持

支持

不支持

获取员工离职信息

获取表单实例详情。

支持

支持

不支持

获取离职员工列表

查询企业离职员工userid列表。

支持

支持

不支持

添加企业待入职员工

添加企业待入职员工。

支持

支持

不支持

花名册

获取员工花名册字段信息

批量获取员工花名册字段信息。

支持

不支持

不支持

更新员工花名册

更新指定员工的花名册信息。

支持

不支持

不支持

获取花名册字段组详情

查询花名册的员工档案信息中有权限的字段列表。

支持

不支持

不支持

获取花名册字段组详情

查询员工花名册指定字段的信息。

支持

支持

不支持

更新员工花名册信息(v2)

更新员工档案信息。

支持

支持

不支持

获取花名册元数据

获取员工花名册的元数据。

支持

支持

不支持

组织

获取部门的扩展字段定义

获取部门的扩展字段定义。

支持

不支持

不支持

获取部门扩展信息

获取部门扩展信息。

支持

不支持

不支持

更新部门扩展信息

更新部门扩展信息。

支持

不支持

不支持

待办任务

API

说明

企业内部应用

第三方企业应用

第三方个人应用

发起待办

发起一个待办事项。

支持

支持

不支持

获取用户的待办事项

分页获取用户的待办任务列表。

支持

不支持

不支持

更新待办事项状态

更新待办事项状态。

支持

支持

不支持

考勤

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

考勤排班

查询成员排班信息

查询某人在某工作日的排班信息。

支持

支持

不支持

批量查询人员排班信息

批量查询员工在工作日内的排班信息。

支持

支持

不支持

排班制考勤组排班

给排班制考勤组成员进行排班。

支持

支持

不支持

查询排班打卡结果

查询排班的打卡结果。

支持

支持

不支持

查询企业考勤排班详情

查询某天的考勤排班信息。

支持

不支持

不支持

查询排班概要信息

查询用户在某个时间段内的排班概要信息。

支持

不支持

不支持

考勤班次

获取班次摘要信息

查询所有的班次信息。

支持

支持

不支持

获取班次详情

根据班次ID查询班次的详细信息。

支持

支持

不支持

按名称搜索班次

根据名称模糊搜索班次。

支持

支持

不支持

创建班次

创建钉钉考勤班次。

支持

不支持

不支持

查询历史班次

查询历史班次信息。

支持

不支持

不支持

删除班次

删除考勤班次。

支持

不支持

不支持

修改卡点设置

修改考勤班次卡点的设置信息。

支持

不支持

不支持

考勤打卡

获取打卡结果

返回企业内员工的实际打卡结果。

支持

支持

不支持

获取打卡详情

返回企业内员工的实际打卡详情。

支持

支持

不支持

上传打卡记录

上传考勤的打卡流水。

支持

支持

不支持

假勤审批

通知审批通过

通知审批通过,支持加班、请假、外出和出差类型。

不支持

支持

不支持

通知审批撤销

通知审批撤销。

不支持

支持

不支持

通知补卡通过

通知考勤补卡通过。

不支持

支持

不支持

预计算时

根据考勤系统的排班情况,预计算员工加班、出差及请假的时长信息。

不支持

支持

不支持

通知换班通

换班审批通过后,通知考勤执行换班动作。

不支持

支持

不支持

计算请假时长

获取自动根据排班规则统计出每个员工的请假时长。

不支持

支持

不支持

查询请假状态

查询指定企业下指定用户在指定时间段内的请假状态。

支持

不支持

不支持

假期管理

初始化假期余额

批量初始化假期余额。

支持

支持

不支持

查询假期余额

根据企业或员工分页获取假期余额信息。

支持

支持

不支持

更新假期类型

更新指定假期类型的相关规则。

支持

支持

不支持

删除假期类型

删除指定的假期类型。

支持

支持

不支持

批量更新假期余额

批量更新假期余额信息。

支持

支持

不支持

查询假期消费记录

获取假期消费记录信息。

支持

支持

不支持

查询假期类型

查询假期类型。

支持

支持

不支持

添加假期类型

添加假期类型。

支持

支持

不支持

考勤组管理

批量获取考勤组详情

查询所有的考勤组详情信息。

支持

不支持

不支持

获取用户考勤组

获取员工的考勤组信息。

支持

不支持

不支持

获取考勤组成员

获取当前考勤组下的成员信息。

支持

支持

不支持

考勤组成员校验

校验某个部门或者员工是否属于某个考勤组。

支持

支持

不支持

更新考勤组成员

更新考勤组成员。

支持

支持

不支持

获取考勤组员工的userid

分页获取某个考勤组下的所有员工的userId。

支持

支持

不支持

批量获取考勤组摘要

分页获取企业内所有考勤组摘要信息。

支持

支持

不支持

获取考勤组详情

根据考勤组ID获取考勤组详情。

支持

支持

不支持

搜索考勤组摘要

按考勤组名称模糊搜索,获取考勤组摘要信息。

支持

支持

不支持

批量新增wifi信息

为指定考勤组批量新增wifi信息。

支持

不支持

不支持

批量移除wifi

批量移除指定考勤组的wifi信息。

支持

不支持

不支持

批量查询wifi

批量查询指定考勤组下的wifi列表信息。

支持

不支持

不支持

批量新增position

在指定考勤组下批量新增position。

支持

不支持

不支持

批量删除position

在指定考勤组下批量删除position。

支持

不支持

不支持

批量查询position

批量查询指定考勤组下的position列表信息。

支持

不支持

不支持

创建考勤组

创建考勤组。

支持

不支持

不支持

更新考勤组

根据考勤组id更新考勤组信息。

支持

不支持

不支持

删除考勤组

批量删除考勤组。

支持

不支持

不支持

批量新增考勤组成员

在指定的考勤组下批量新增考勤组成员。

支持

不支持

不支持

批量删除考勤组成员

批量删除指定考勤组下的考勤组成员。

支持

不支持

不支持

查询考勤组员工

查询指定考勤组下的员工列表。

支持

不支持

不支持

根据groupkey查询考勤组信息

根据考勤组id查询考勤组信息。

支持

不支持

不支持

考勤统计

获取报表列定义

获取企业智能考勤报表中的列信息。

支持

支持

不支持

获取报表列值

获取钉钉智能考勤报表的列值数据。

支持

支持

不支持

获取报表假期数据

获取钉钉智能考勤报表的假期数据。

支持

支持

不支持

查询是否启用智能统计报表

判断企业是否开启了考勤智能报表。

支持

支持

不支持

获取考勤更新数据

获取考勤更新数据。

支持

不支持

不支持

groupKey和groupId互转

groupKey转换为groupId

将考勤组的groupKey转换为groupId。

支持

支持

不支持

groupId转换为groupKey

将考勤组的groupId转换为groupKey。

支持

支持

不支持

日志

API

说明

企业内部应用

第三方企业应用

第三方个人应用

创建日志

调用本接口创建日志。

支持

支持

不支持

保存日志内容

调用本接口保存自定义的日志内容。

支持

支持

不支持

获取模板详情

调用本接口根据模板名称获取模板详情。

支持

支持

不支持

获取用户发出的日志列表

调用本接口获取用户发出的日志列表。

支持

不支持

不支持

获取用户发送日志的概要信息

调用本接口根据员工userid或者日志模板名称,分页获取员工在一段时间范围内发送的日志概要信息。

支持

不支持

不支持

获取日志统计数据

调用该接口获取日志的已读人数、评论条数、评论人数、点赞人数。

支持

不支持

不支持

获取日志相关人员列表

调用该接口查询日志已读人员列表、评论人员列表或点赞人员列表。

支持

不支持

不支持

获取日志接收人员列表

调用本接口获取日志接收人员列表。

支持

不支持

不支持

获取日志评论详情

调用该接口获取评论详情,包括评论人userid、评论内和评论时间。

支持

不支持

不支持

获取用户日志未读数

调用本接口获取用户日志未读数。

支持

不支持

不支持

获取用户可见的日志模板

调用本接口根据userid获取用户可见的日志模板。

支持

不支持

不支持

日程

API

说明

企业内部应用

第三方企业应用

第三方个人应用

创建日程

调用创建日程接口可以将企业员工的待办事项写入到钉钉日历并在钉钉日历中展示。

支持

不支持

不支持

修改日程

调用该接口修改日程。

支持

不支持

不支持

修改日程参与者

调用本接口新增或删除日程参与者。

支持

不支持

不支持

取消日程

调用该接口取消日程,只能取消通过创建日程接口创建的日程。

支持

不支持

不支持

签到

API

说明

企业内部应用

第三方企业应用

第三方个人应用

获取部门用户签到记录

调用本接口获取部门用户签到记录。

支持

不支持

不支持

获取用户签到记录

调用本接口获取用户签到记录。

支持

不支持

不支持

公告

API

说明

企业内部应用

第三方企业应用

第三方个人应用

创建公告

调用本接口创建企业公告。

支持

不支持

不支持

更新公告

调用该接口更新公告。

支持

不支持

不支持

删除公告

调用该接口根据公告ID删除公告。

支持

不支持

不支持

获取用户可查看的公告

调用本接口可获取指定人员的公告信息,在企业自定义工作首页进行公告轮播展示。

支持

不支持

不支持

获取公告分类列表

调用本接口获取未删除的公告分类列表,如果公告类别已被删除,则无法获取。

支持

不支持

不支持

获取公告ID列表

调用该接口获取企业某公告分类下所有未删除的公告的ID列表。

支持

不支持

不支持

获取公告详情

调用该接口根据公告ID获取未删除的公告的详情。

支持

不支持

不支持

钉钉运动

API

说明

企业内部应用

第三方企业应用

第三方个人应用

查询用户是否开启了钉钉运动

调用本接口可查询用户是否启用了钉钉运动。

支持

不支持

不支持

获取个人或部门钉钉运动数据

调用本接口查询企业用户或部门每天的钉钉运动步数。

支持

不支持

不支持

批量获取钉钉运动数据

调用本接口批量获取钉钉运动数据。

支持

不支持

不支持

应用管理

API

说明

企业内部应用

第三方企业应用

第三方个人应用

获取应用列表

调用该接口获取当前企业的应用列表。

支持

不支持

不支持

获取员工可见的应用列表

调用本接口获取指定员工可见的应用列表。

支持

不支持

不支持

设置应用的可见范围

调用本接口设置指定应用的可见范围。

支持

不支持

不支持

获取应用可见范围

调用本接口获取应用的可见范围。

支持

不支持

不支持

创建H5微应用

调用本接口创建H5微应用。

支持

不支持

不支持

删除H5微应用

调用本接口删除H5微应用。

支持

不支持

不支持

文件储存

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

媒体管理

上传媒体文件

上传图片、语音媒体资源文件以及普通文件,接口返回媒体资源标识media_id。

支持

支持

不支持

管理钉盘

发送钉盘文件给指定用户

将文件发送给指定用户,用户将收到以应用名义发送的一条文件消息。

支持

支持

不支持

保存文件到自定义或审批钉盘空间

将文件保存到自定义钉盘空间或审批附件钉盘空间。

支持

支持

不支持

获取企业下的自定义空间

获取企业下的自定义空间。

支持

支持

不支持

获取应用自定义空间使用详情

获取自定义空间已使用容量,单位为Bytes。

支持

支持

不支持

授权用户访问企业的自定义空间

授权企业下指定人员访问其使用的自定义空间。

支持

支持

不支持

单步文件上传

上传文件到钉盘。

支持

支持

不支持

开启分块上传事务

文件分块上传第一步,开启上传事务。

支持

支持

不支持

上传文件块

文件分块上传中间环节,传输文件块。

支持

支持

不支持

提交文件上传事务

文件分块上传最后一步,提交本次分块上传事务。

支持

支持

不支持

AI

API

说明

企业内部应用

第三方企业应用

第三方个人应用

文本翻译

调用本接口翻译一段文本。

支持

支持

不支持

OCR文字识别

调用本接口进行OCR文字识别。即识别一张图片上的文字。

支持

支持

不支持

ASR 一句话语音识别

调用本接口识别一段60秒内的语音。

支持

支持

不支持

场景群

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

群管理

创建场景群

根据群模板ID创建群。

支持

支持

不支持

更新场景群

根据群ID更新群信息。

支持

支持

不支持

查询群信息

根据群ID查询场景群的基本信息。

支持

支持

不支持

查询群成员

根据群ID查询群成员列表。

支持

支持

不支持

新增群成员

新增群成员。

支持

支持

不支持

删除群成员

删除群成员。

支持

支持

不支持

群模板

启用群模板

根据群模板ID启用群模板。

支持

支持

不支持

停用群模板

根据群模板ID停用群模板。

支持

支持

不支持

互动卡片

注册互动卡片回调地址

注册互动卡片的回调地址。

支持

支持

不支持

发送互动卡片消息

以群助手方式发送互动卡片消息到场景群中。

支持

支持

不支持

群助手

发送群助手消息

在场开放场景下,通过群模板定义的机器人向群内发送消息。

支持

支持

不支持

新教育

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

学段

获取学段元数据列表

获取学段元数据列表。

支持

支持

不支持

学科

获取学科元数据列表

获取学科元数据列表。

支持

支持

不支持

创建学科实例

创建学科实例。

支持

支持

不支持

更新学科实例

更新学科实例。

支持

支持

不支持

删除学科实例

删除学科实例。

支持

支持

不支持

获取学科实例详情

获取学科实例详细信息。

支持

支持

不支持

获取学科实例列表

获取学科实例列表。

支持

支持

不支持

排课

创建课程

创建课程。

不支持

支持

不支持

修改课程

修改课程。

不支持

支持

不支持

删除课程

删除课程。

不支持

支持

不支持

获取课程详情

获取指定课程的详细信息。

不支持

支持

不支持

获取课程列表

获取课程列表。

不支持

支持

不支持

添加课程参与方

添加课程参与方。

不支持

支持

不支持

获取课程参与方列表

获取课程参与方列表。

不支持

支持

不支持

移除课程参与方

移除课程参与方。

不支持

支持

不支持

授课

开始课程

开始课程。

不支持

支持

不支持

加入课堂

加入课堂。

不支持

支持

不支持

结束上课

结束上课。

不支持

支持

不支持

回放课程

获取授课回放链接。

不支持

支持

不支持

课堂数据

获取课堂概要数据

获取课堂概要数据。

不支持

支持

不支持

获取课堂明细数据

获取课堂明细数据。

不支持

支持

不支持

家校通讯录2.0

获取部门列表

查看某个部门下的所有子部门列表。

支持

支持

不支持

获取部门详情

获取部门详细信息。

支持

支持

不支持

获取人员详情

查看班级下的人员详细信息。

支持

支持

不支持

获取人员列表

查看班级下的人员身份列表。

支持

支持

不支持

获取人员关系列表

查看班级下的所有人员关系列表。

支持

支持

不支持

获取人员关系详情

查看班级下某个监护人的人员关系列表。

支持

支持

不支持

家庭同步

家庭Feed同步

同步钉钉教育家庭Feed。

不支持

支持

不支持

查询家庭孩子信息

根据孩子的userId查询家庭孩子信息。

不支持

支持

不支持

学习推荐数据回流

家长首页学习推荐数据回流。

不支持

支持

不支持

静态推荐数据同步

同步静态推荐数据。

不支持

支持

不支持

专属钉钉

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

视频直播统计

获取视频直播明细列表

获取视频直播明细列表。

支持

不支持

不支持

获取视频直播观看人员列表

获取观看视频直播的人员列表。

支持

不支持

不支持

获取企业视频直播统计列表(部门维度)

按部门直播视频统计列表数据。

支持

不支持

不支持

获取企业视频直播统计数据

获取企业视频直播统计数据。

支持

不支持

不支持

视频会议统

获取企业某天的视频会议统计数据2.0

获取企业在某一天的视频会议统计数据。

支持

不支持

不支持

获取企业某天的视频会议统计数据1.0

查询企业在某天所有视频会议的统计数据。

支持

不支持

不支持

获取企业某天的所有部门视频会议统计数据

查询企业在某天各部门视频会议统计列表。

支持

不支持

不支持

获取企业视频会议明细列表

获取企业视频会议明细列表。

支持

不支持

不支持

电话会议统计

获取企业某天的所有部门电话会议统计列表

查询企业在某天各部门电话会议汇总统计列表。

支持

不支持

不支持

获取企业电话会议明细列表

查询企业在某天发起的电话会议列表及详情。

支持

不支持

不支持

获取企业某天的电话会议数据

获取企业某天的电话会议数据。

支持

不支持

不支持

其他数据统计

获取企业各类群组创建情况

查询企业各类群组创建情况。

支持

不支持

不支持

获取企业聊天数据

查询当前企业每天的聊天汇总数据。

支持

不支持

不支持

获取企业部门聊天数据(部门维度)

查询企业各部门聊天数据。

支持

不支持

不支持

获取企业应用访问情况

查询当前企业每天的微应用使用汇总数据。

支持

不支持

不支持

统计企业活跃用户

查询企业的DAU(日活跃用户数量)汇总数据。

支持

不支持

不支持

企业活跃用户统计列表(部门维度)

查询部门维度的活跃用户统计数据列表。

支持

不支持

不支持

查询企业通讯录未激活用户列表

查询当前企业当前通讯录未激活用户明细列表。

支持

不支持

不支持

获取企业DING使用数据

查询企业各类DING的使用情况。

支持

不支持

不支持

获取企业DING使用数据(部门维度)

查询企业各部门各类DING的使用情况。

支持

不支持

不支持

服务号管理

新增服务号

新增一个服务号。

支持

不支持

不支持

更新服务号

更新指定服务号的相关信息。

支持

不支持

不支持

查询服务号列表

查询当前组织的服务号列表。

支持

不支持

不支持

查询服务号详情

根据服务号的unionid查询服务号详情。

支持

不支持

不支持

文章管理

新增文章

新增一篇文章。

支持

不支持

不支持

删除文章

删除一篇指定的文章。

支持

不支持

不支持

更新文章

更新指定文章。

支持

不支持

不支持

查询文章列表

查询文章列表。

支持

不支持

不支持

获取文章详情

查询一篇文章的详细信息。

支持

不支持

不支持

发布文章

发布文章。

支持

不支持

不支持

消息卡片管理

新增消息卡片

新增消息卡片。

支持

不支持

不支持

删除消息卡片

删除指定的消息卡片素材。

支持

不支持

不支持

获取消息卡片详情

获取消息卡片详情。

支持

不支持

不支持

更新消息卡片

更新消息卡片。

支持

不支持

不支持

查询消息卡片列表

查询消息卡片列表。

支持

不支持

不支持

消息群发

消息撤回

根据消息发送的任务id撤回消息。

支持

不支持

不支持

消息群发

群发消息。

支持

不支持

不支持

菜单管理

服务号菜单更新

更新服务号的会话菜单。

支持

不支持

不支持

查询服务号菜单

查询指定服务号的会话菜单。

支持

不支持

不支持

获取年报数据

获取年报数据

根据不同数据维度,获取企业年报数据。

支持

不支持

不支持

智能办公电话

API

说明

企业内部应用

第三方企业应用

第三方个人应用

向授权开通第三方应用的管理员发起智能办公电话

调用本接口向授权开通第三方应用的管理员发起智能办公电话。

不支持

支持

不支持

查询发起智能办公电话的员工

调用本接口查询发起智能办公电话的员工。

不支持

支持

不支持

删除ISV能发起智能办公电话的员工

调用本接口删除ISV能发起智能办公电话的员工。

不支持

支持

不支持

设置发起智能办公电话的员工

调用本接口设置发起智能办公电话的员工。

不支持

支持

不支持

应用内购

API

说明

企业内部应用

第三方企业应用

第三方个人应用

获取内购商品SKU页面地址

调用本接口获取内购商品SKU页面地址。

不支持

支持

不支持

内购商品订单处理完成

调用本接口完成内购商品订单处理。

不支持

支持

不支持

获取内购订单信息

调用本接口获取内购订单信息。

不支持

支持

不支持

应用内购商品核销

调用本接口在应用内购流程中,对内购订单进行核销。

不支持

支持

不支持

获取未处理的已支付订单

调用本接口获取未处理的已支付订单。

不支持

支持

不支持

阿里商旅

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

城市基本数据

机票城市搜索

搜索机票城市。

支持

不支持

不支持

火车票城市搜索

搜索火车票城市。

支持

不支持

不支持

维护成本中心和发票抬头

新建成本中心

新建成本中心。

支持

不支持

不支持

修改成本中心

修改成本中心基本信息。

支持

不支持

不支持

删除成本中心

删除成本中心。

支持

不支持

不支持

查询成本中心

查询成本中心信息。

支持

不支持

不支持

设置成本中心人员信息

设置成本中心人员信息。

支持

不支持

不支持

删除成本中心人员信息

删除成本中心人员信息。

支持

不支持

不支持

商旅成本中心转换为外部成本中心

将商旅成本中心转换为外部成本中心。

支持

不支持

不支持

项目管理

添加项目

添加商旅项目。

支持

支持

不支持

修改项目

修改项目信息。

支持

支持

不支持

删除项目

删除项目。

支持

支持

不支持

出差申请

新建审批单

新建审批单。

支持

支持

不支持

获取申请单列表

查询企业审批单数据。

支持

支持

不支持

获取申请单详情

获取单个申请单的详细信息。

支持

支持

不支持

修改申请单

修改出差申请单。

支持

支持

不支持

更新申请单状态

更新审批单状态。

支持

支持

不支持

订单管理

获取企业机票订单数据

获取企业机票订单数据。

支持

支持

不支持

企业获取商旅酒店订单数据

获取商旅酒店订单数据。

支持

支持

不支持

获取企业火车票订单数据

获取企业火车票订单数据。

支持

支持

不支持

获取用车订单数据

获取企业用车订单数据。

支持

支持

不支持

阿里商旅跳转链接

获取类目预定页跳转地址

获取类目预定页跳转地址。

支持

支持

不支持

获取商旅访问地址

获取各个场景预订访问地址,以及我的订单地址。

支持

支持

不支持

发票管理

新增发票配置

新增发票配置。

支持

支持

不支持

配置发票适用人群

配置发票适用人群。

支持

支持

不支持

查询可用发票列表

查询可用发票列表。

支持

支持

不支持

修改发票配置

修改发票配置。

支持

支持

不支持

删除发票信息

删除发票信息。

支持

支持

不支持

获取月对账结算数据

获取月对账结算数据

取月对账结算数据下载地址。

支持

支持

不支持

查询预估价

查询预估价

查询预估价。

支持

支持

不支持

项目管理

API

说明

企业内部应用

第三方企业应用

第三方个人应用

查询项目中文件操作日志

调用本接口获取钉钉项目空间任务中文件的操作日志列表。

支持

不支持

不支持

小蜜客服

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

服务窗/客户群接口

获取服务窗机器人信息

获取服务窗/客户群机器人信息。

支持

不支持

不支持

更新服务窗/客户群机器人信息

修改客户群或服务窗机器人的基础信息。

支持

不支持

不支持

推送服务窗单聊消息

使用钉小蜜服务窗机器人给指定用户推送单聊消息。

支持

不支持

不支持

推送客户群消息

使用钉小蜜机器人发送客户群消息。

支持

不支持

不支持

查询客户群活跃情况

查询群活跃情况。

支持

不支持

不支持

小蜜客服付费版接口

推送小蜜机器人单聊O2O消息

通过小蜜机器人发送O2O(即Online To Offline)线上线下消息。

支持

不支持

不支持

获取用户登录凭证

获取用户的登录凭证。

支持

不支持

不支持

智能问答

使用小蜜客服机器人能力进行智能问答。

支持

不支持

不支持

钉钉红包

API

说明

企业内部应用

第三方企业应用

第三方个人应用

发送企业红包

发送企业红包。

支持

不支持

不支持

查询红包详情

根据企业订单号查询红包详情。

支持

不支持

不支持

客户管理CRM数据

类目

API

说明

企业内部应用

第三方企业应用

第三方个人应用

客户管理

创建CRM客户数据

创建客户数据。

支持

不支持

不支持

更新CRM客户数据

更新CRM客户数据。

支持

不支持

不支持

删除CRM客户数据

删除指定的CRM客户数据。

支持

不支持

不支持

批量获取客户数据

根据指定查询条件批量获取客户数据。

支持

不支持

不支持

按照ID列表批量获取客户数据

根据实例ID列表批量获取客户记录数据。

支持

不支持

不支持

获取客户对象的元数据

获取钉钉CRM客户对象的元数据。

支持

支持

不支持

联系人管理

创建CRM联系人数据

创建联系人数据。

支持

不支持

不支持

更新CRM联系人数据

更新联系人数据。

支持

不支持

不支持

删除CRM联系人

删除当前组织CRM指定联系人的接口。

支持

不支持

不支持

批量获取联系人数据

根据指定查询条件批量获取联系人数据。

支持

不支持

不支持

按照ID列表批量获取联系人数据

根据联系人实例id列表批量获取联系人数据。

支持

不支持

不支持

获取联系人对象的元数据

读取钉钉CRM联系人对象的元数据描述。

支持

支持

不支持

跟进记录

跟进记录数据搜索查询接口

根据指定查询条件批量获取跟进记录数据。

支持

不支持

不支持

获取跟进记录对象的元数据

读取钉钉CRM跟进记录对象的元数据描述。

支持

支持

不支持

按照ID列表批量获取跟进记录数据

根据实例ID列表批量获取跟进记录数据。

支持

支持

不支持

客户管理自定义对象

创建CRM自定义对象数据

创建自定义对象数据。

支持

不支持

不支持

获取CRM自定义对象数据

获取CRM自定义对象数据。

支持

不支持

不支持

更新自定义对象数据

更新CRM自定义

支持

不支持

不支持

获取自定义对象的元数据

读取钉钉CRM自定义对象的元数据描述。

支持

支持

不支持

按照ID列表批量获取CRM自定义表单数据

根据实例ID列表批量获取CRM自定义表单数据。

支持

不支持

不支持

培训

API

说明

企业内部应用

第三方企业应用

第三方个人应用

创建培训课程

通过培训平台开放能力,创建培训课程。

不支持

支持

不支持

获取培训课程的基本信息

获取培训课程的基本信息。

不支持

支持

不支持

获取培训观看数据

获取培训观看数据包含观看直播时长和观看回放时长。

不支持

支持

不支持

连接器

API

说明

企业内部应用

第三方企业应用

第三方个人应用

连接器事件发送

将本地业务系统产生的事件发送到钉钉连接器服务中,钉钉会将这些事件再广播转发给订阅了此事件的其它业务系统。

支持

支持

不支持

相关文章
|
28天前
|
自然语言处理 Java API
Java 8的Stream API和Optional类:概念与实战应用
【5月更文挑战第17天】Java 8引入了许多重要的新特性,其中Stream API和Optional类是最引人注目的两个。这些特性不仅简化了集合操作,还提供了更好的方式来处理可能为空的情况,从而提高了代码的健壮性和可读性。
54 7
|
4天前
|
运维 Serverless API
Serverless 应用引擎产品使用合集之SD API模式可以通过什么方式进行访问
阿里云Serverless 应用引擎(SAE)提供了完整的微服务应用生命周期管理能力,包括应用部署、服务治理、开发运维、资源管理等功能,并通过扩展功能支持多环境管理、API Gateway、事件驱动等高级应用场景,帮助企业快速构建、部署、运维和扩展微服务架构,实现Serverless化的应用部署与运维模式。以下是对SAE产品使用合集的概述,包括应用管理、服务治理、开发运维、资源管理等方面。
|
4天前
|
JavaScript 关系型数据库 Serverless
Serverless 应用引擎操作报错合集之在调用stable Diffusion函数计算api接口返回,报错:"Not Found"一般是什么原因
Serverless 应用引擎(SAE)是阿里云提供的Serverless PaaS平台,支持Spring Cloud、Dubbo、HSF等主流微服务框架,简化应用的部署、运维和弹性伸缩。在使用SAE过程中,可能会遇到各种操作报错。以下是一些常见的报错情况及其可能的原因和解决方法。
|
4天前
|
移动开发 监控 API
WebSocket API 详解与应用指南
WebSocket API 是HTML5的一种技术,它允许服务器与客户端建立持久的全双工连接,改变传统HTTP请求-响应模式,实现双向通信。API包括WebSocket构造函数、连接状态属性(如readyState)、方法(如send和close)及事件(如onopen和onmessage)。它简化了实时Web应用程序的开发,适用于在线聊天、实时数据监控等场景。
13 5
|
8天前
|
机器学习/深度学习 自然语言处理 监控
从数据到决策:拼多多商品详情API在市场分析中的应用
本文探讨了如何利用拼多多商品详情API进行市场分析,该API提供商品基本信息、价格销量、用户评价和商品属性等数据,助力商家和分析师理解消费者行为、预测市场趋势、分析竞争环境及优化产品策略。通过数据收集、分析和整合,企业可借助此工具制定精准市场策略。案例展示了市场趋势、竞争情报和用户评价情感分析的应用。未来,随着技术进步,此类API的应用将更加广泛,推动电商行业创新。
|
12天前
|
API 网络架构 数据格式
API接口详解及其在电子商务中的应用研究
本文介绍了API接口在电子商务中的重要性,详细阐述了API的定义、分类(RESTful, SOAP, GraphQL)和设计原则。通过实例展示了API如何促进数据交换和系统集成,如商品信息共享、订单自动化处理。同时,讨论了API安全性措施,并提供了一个Python代码示例来演示如何获取电商平台的商品信息。API在电子商务领域的应用对于提升业务效率和推动行业创新具有显著影响。