组织云钉钉API
  1. 服务端API
组织云钉钉API
  • 服务端API
    • 如何调用服务端API
    • 服务端SDK下载
    • 获取凭证(access_token)
      • 获取企业内部应用的access_token
      • 获取jsapi_ticket
    • 身份验证(免登)
      • 企业内部应用免登
      • 免登常见问题
    • 通讯录管理
      • 通讯录事件
      • 用户管理
        • 创建用户
        • 更新用户信息
        • 删除用户
        • 根据userid获取用户详情
        • 获取部门用户基础信息
        • 获取部门用户userid列表
        • 获取部门用户详情
        • 获取员工人数
        • 获取未登录钉钉的员工列表
        • 根据手机号获取userid
        • 根据unionid获取用户userid
        • 获取管理员列表
        • 获取管理员通讯录权限范围
        • 获取管理员的应用管理权限
      • 部门管理
        • 获取部门详情
        • 获取部门列表
        • 获取子部门ID列表
        • 获取指定部门的所有父部门列表
        • 获取指定用户的所有父部门列表
      • 角色管理
        • 删除角色
        • 创建角色
        • 创建角色组
        • 更新角色
        • 批量增加员工角色
        • 批量删除员工角色
        • 设定角色成员管理范围
        • 获取角色组列表
        • 获取角色列表
        • 获取角色详情
        • 获取指定角色的员工列表
    • 消息通知
      • 消息通知概述
      • 消息类型与数据格式
      • 消息链接说明
      • 工作通知
        • 发送工作通知
        • 更新工作通知状态栏
        • 获取工作通知消息的发送进度
        • 获取工作通知消息的发送结果
        • 撤回工作通知消息
      • 普通消息
        • 发送普通消息
  • 钉钉回调相关
    • 钉钉Stream回调
    • 事件订阅列表
  1. 服务端API

服务端SDK下载

服务端SDK下载#

更新于 2023-05-17
钉钉官方提供了统一的SDK,使用SDK可以便捷地调用服务端API。

旧版服务端API、新版服务端API的区别#

为提升接口的使用体验,提供更加规范的接口,钉钉开放平台针对服务端API的规范进行了升级。根据不同的规范,目前提供了旧版服务端API(旧版规范)和新版服务端API(新版规范)。详情请参考旧版服务端API与新版服务端API区别。

新版服务端SDK#

Java
通过Maven安装DingTalk OpenAPI Java SDK
添加依赖项到pom.xml的文件中,最新的SDK版本可以在这里查看。
<dependency>
 <groupId>com.aliyun</groupId>
 <artifactId>dingtalk</artifactId>
 <version>{sdk-version}</version>
</dependency>
下载SDK安装包
下载地址:https://open-dev.dingtalk.com/sdk/download/java

C##

命令行安装
使用dotnet来安装C# SDK,最新的SDK版本可以在这里查看。
dotnet add package AlibabaCloud.SDK.Dingtalk
下载SDK安装包
下载地址:https://open-dev.dingtalk.com/sdk/download/csharp

PHP#

命令行安装
使用composer工具进行安装。
composer require alibabacloud/dingtalk
下载SDK安装包
下载地址:https://open-dev.dingtalk.com/sdk/download/composer

Node.js#

命令行安装
执行以下命令,使用npm安装依赖。
npm install @alicloud/dingtalk --save
下载SDK安装包
下载地址:https://open-dev.dingtalk.com/sdk/download/nodejs

Python#

命令行安装
执行以下命令,使用pip安装包依赖。
pip install alibabacloud_dingtalk
下载SDK安装包
下载地址:https://open-dev.dingtalk.com/sdk/download/python

旧版服务端SDK#

请求示例#

下面是使用SDK调用API的请求示例:
Java
PHP
Python
Node
let { Config, OapiProcessinstanceGetParams, OapiProcessinstanceGetRequest } = require('./client.js');
let Client = require('./client.js').default
// import Client,{ Config, GetOapiProcessinstanceParams, GetOapiProcessinstanceRequest } from "./client.js";
async function test() {
 const config = new Config()
 config.serverUrl = 'https://oapi.dingtalk.com/topapi/processinstance/get'
 config.session = 'access_token'
 const params = new OapiProcessinstanceGetParams();
 params.processInstanceId = '23aa6794-b75e-451a-aa13-85bf4dc1b56c'

 const request = new OapiProcessinstanceGetRequest()
 request.params = params
 const client = new Client(config)
 try {
 const res = await client.oapiProcessinstanceGet(request)
 console.log(res.body)
 } catch (err) {
 console.log(err)
 }
}
test()
.NET
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/user/get");
OapiUserGetRequest req = new OapiUserGetRequest();
req.Userid = "userid1";
req.SetHttpMethod("GET");
OapiUserGetResponse rsp = client.Execute(req, accessToken)

请求示例说明:#

1.
定义Client对象,设置接口地址URI。一般情况,无需拼接URL后面的参数,比如access_token;需要注意部分Post接口,需要在URI后拼接除access_token外的个别参数。
2.
构造Request对象,接口对应的request对象,一般规则是Oapi+接口Path驼峰形式+Request,如/user/get接口,请求对象是OapiUserGetRequest。
3.
调用Request的方法设置参数,注意参数HttpMethod,默认是POST,如果是GET类型接口,需要这样设置request.setHttpMethod("GET")。
4.
调用client.execute执行,其中access_token同样可以使用SDK获取到。同时,/gettoken,/sns/gettoken,/service/get_suite_token等获取token的接口在调用execute时,无需再传token参数。
5.
执行后得到Response对象,是与Request对应的,然后可获取执行结果。

SDK下载#

环境依赖
Java SDK 需要依赖 Java SE/EE 1.5及以上
.NET SDK 需要依赖 .NET Framework 2.0及以上 (不支持Windows Phone平台)
下载地址:
Java版本:
JAR包下载:点击下载
添加maven依赖:
<dependency>
 <groupId>com.aliyun</groupId>
 <artifactId>alibaba-dingtalk-service-sdk</artifactId>
 <version>2.0.0</version>
</dependency>
PHP版本:点击下载
Python版本:点击下载
Python3版本:点击下载
.NET版本:点击下载
.NET Core版本:点击下载
Node版本:点击下载
修改于 2023-12-27 03:22:16
上一页
如何调用服务端API
下一页
获取企业内部应用的access_token
Built with