钉钉服务端api接口使用

原文链接：http://www.cnblogs.com/xiaosongJiang/p/9991573.html

第一步:注册钉钉企业账号

打开链接：https://oa.dingtalk.com/#/login，注册账号即可

第二步：创建应用

以创建e应用为例：

还需要授权一个开发人员，并获取CorpSecret，需要把corpId和CorpSecret作为参数请求api接口获取AccessToken，后面的所有接口都需要AccessToken

第三步：接入接口

一、获取token

 1 const corpid = ‘dingd***587da6ee21d35c2f4657eb63***‘;
 2 const corpsecret = ‘*********‘;
 3 const requestPromise = require("request-promise");
 4
 5 const getAccessToken = async (corpid, corpsecret) => {
 6   // https://oapi.dingtalk.com/gettoken?corpid={corpid}&corpsecret={corpSecret或开发授权码}
 7   const result = await requestPromise({ uri: ‘https://oapi.dingtalk.com/gettoken‘, qs: { corpid, corpsecret } });
 8   console.log(result);
 9 };
10 getAccessToken(corpid, corpsecret);

二、promise请求接口封装

function request(url, method, params, headers = {}) {
const options = {
url,
method,
// timeout: 3000,
headers: Object.assign(headers, {
‘content-type‘: ‘application/json‘,
}),
rejectUnauthorized: false, // https
json: true,
};
switch (method) {
case ‘POST‘:
case ‘PUT‘:
options.body = params;
break;
case ‘GET‘:
case ‘DELETE‘:
options.qs = params;
break;
default:
break;
}
return new Promise((resolve, reject) => {
request(options, (error, response, body) => {
if (!error) {
resolve(body);
} else {
reject(error);
}
});
});
.catch (error => ({
msg: error.message,
}));
}

三、接口见代码（后端使用koa.js）

const host = ‘https://oapi.dingtalk.com/‘;

/*
*发送工作通知消息
*/
router.post(‘/api/dingtalkserve/asyncsend_v2‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘userid_list‘] && !body[‘dept_id_list‘] && !body[‘to_all_user‘]) {
return response.fail({
‘msg‘: "userid_list,dept_id_list, to_all_user必须有一个不能为空"
});
}
if (!body[‘msg‘]) {
return response.fail({
‘msg‘: "msg不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
agent_id: parseInt(agentId4EP),
msg: {
"msgtype": "text",
"text": {
"content": body[‘msg‘]
}
}
};
body[‘to_all_user‘] ? params[‘to_all_user‘] = true : false;
body[‘dept_id_list‘] ? params[‘dept_id_list‘] = body[‘dept_id_list‘] : "";
body[‘userid_list‘] ? params[‘userid_list‘] = body[‘userid_list‘] : "";
let messageRes = await request(`${host}topapi/message/corpconversation/asyncsend_v2?access_token=${accessToken}`, ‘POST‘, params);
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取工作通知消息的发送进度
*/
router.post(‘/api/dingtalkserve/getsendprogress‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘task_id‘]) {
return response.fail({
‘msg‘: "task_id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
agent_id: parseInt(agentId4EP),
task_id: body[‘task_id‘]
};
let messageRes = await request(`${host}topapi/message/corpconversation/getsendprogress?access_token=${accessToken}`, ‘POST‘, params);
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取工作通知消息的发送结果
*/
router.post(‘/api/dingtalkserve/getsendresult‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘task_id‘]) {
return response.fail({
‘msg‘: "task_id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
agent_id: parseInt(agentId4EP),
task_id: body[‘task_id‘]
};
let messageRes = await request(`${host}topapi/message/corpconversation/getsendresult?access_token=${accessToken}`, ‘POST‘, params);
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取子部门ID列表
*/
router.post(‘/api/dingtalkserve/list_ids‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘id‘]) {
return response.fail({
‘msg‘: "父部门id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
id: body[‘id‘]
};
let messageRes = await request(`${host}department/list_ids`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取部门列表
*/
router.post(‘/api/dingtalkserve/list‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘id‘]) {
return response.fail({
‘msg‘: "父部门id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
id: body[‘id‘]
};
body[‘lang‘] ? params[‘lang‘] = body[‘lang‘] : "";
body[‘fetch_child‘] ? params[‘fetch_child‘] = true : false;
let messageRes = await request(`${host}department/list`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取部门详情
*/
router.post(‘/api/dingtalkserve/departmentget‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘id‘]) {
return response.fail({
‘msg‘: "部门id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
id: body[‘id‘]
};
body[‘lang‘] ? params[‘lang‘] = body[‘lang‘] : "";
let messageRes = await request(`${host}department/get`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 查询部门的所有上级父部门路径
*/
router.post(‘/api/dingtalkserve/list_parent_depts_by_dept‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘id‘]) {
return response.fail({
‘msg‘: "部门id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
id: body[‘id‘]
};
let messageRes = await request(`${host}department/list_parent_depts_by_dept`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 查询指定用户的所有上级父部门路径
*/
router.post(‘/api/dingtalkserve/list_parent_depts‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘userId‘]) {
return response.fail({
‘msg‘: "用户id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
userId: body[‘userId‘]
};
let messageRes = await request(`${host}department/list_parent_depts`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取企业员工人数
*/
router.post(‘/api/dingtalkserve/get_org_user_count‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘onlyActive‘]) {
return response.fail({
‘msg‘: "激活钉钉状态不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
onlyActive: body[‘onlyActive‘]
};
let messageRes = await request(`${host}user/get_org_user_count`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取用户详情
*/
router.post(‘/api/dingtalkserve/userinfo‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘userid‘]) {
return response.fail({
‘msg‘: "userid不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
userid: body[‘userid‘]
};
body[‘lang‘] ? params[‘lang‘] = body[‘lang‘] : "";
let messageRes = await request(`${host}user/get`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取部门用户userid列表
*/
router.post(‘/api/dingtalkserve/getDeptMember‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘deptId‘]) {
return response.fail({
‘msg‘: "部门id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
deptId: body[‘deptId‘]
};
let messageRes = await request(`${host}user/getDeptMember`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取部门用户(详情)
*/
router.post(‘/api/dingtalkserve/listbypage‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘department_id‘]) {
return response.fail({
‘msg‘: "部门id不能为空"
});
}
if (!body[‘offset‘]) {
return response.fail({
‘msg‘: "偏移量不能为空"
});
}
if (!body[‘size‘]) {
return response.fail({
‘msg‘: "每页数量不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
department_id: body[‘department_id‘],
offset: parseInt(body[‘offset‘]),
size: parseInt(body[‘size‘])
};
let messageRes = await request(`${host}user/listbypage`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 根据unionid获取userid
*/
router.post(‘/api/dingtalkserve/getUseridByUnionid‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘unionid‘]) {
return response.fail({
‘msg‘: "unionid不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
unionid: body[‘unionid‘]
};
let messageRes = await request(`${host}user/getUseridByUnionid`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取通讯录权限范围
*/
router.post(‘/api/dingtalkserve/authScopes‘, async ({ request, response, session }) => {
try {
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken
};
let messageRes = await request(`${host}/auth/scopes`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 创建群
*/
router.post(‘/api/dingtalkserve/createChat‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘name‘]) {
return response.fail({
‘msg‘: "群名称不能为空"
});
}
if (!body[‘owner‘]) {
return response.fail({
‘msg‘: "群主userid不能为空"
});
}
if (!body[‘useridlist‘]) {
return response.fail({
‘msg‘: "群成员不能为空"
});
}
if (body[‘useridlist‘].indexOf(body[‘owner‘]) < 0) {
return response.fail({
‘msg‘: "群主必须为群成员"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
name: body[‘name‘],
owner: body[‘owner‘],
useridlist: body[‘useridlist‘].split(",")
};
let messageRes = await request(`${host}chat/create?access_token=${accessToken}`, ‘POST‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 获取群聊会话信息
*/
router.post(‘/api/dingtalkserve/chatInfo‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘chatid‘]) {
return response.fail({
‘msg‘: "群id不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
chatid: body[‘chatid‘]
};
let messageRes = await request(`${host}chat/get`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 发送群消息
*/
router.post(‘/api/dingtalkserve/chatSend‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘chatid‘]) {
return response.fail({
‘msg‘: "群id不能为空"
});
}
if (!body[‘msg‘]) {
return response.fail({
‘msg‘: "群消息不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
chatid: body[‘chatid‘],
msg: {
"msgtype": "text",
"text": {
"content": body[‘msg‘]
}
}
};
let messageRes = await request(`${host}chat/send?access_token=${accessToken}`, ‘POST‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});
/*
* 查询群消息已读人员列表
*/
router.post(‘/api/dingtalkserve/getReadList‘, async ({ request, response, session }) => {
try {
let body = request.fields;
if (!body[‘messageId‘]) {
return response.fail({
‘msg‘: "messageId不能为空"
});
}
if (!body[‘cursor‘]) {
return response.fail({
‘msg‘: "cursor不能为空"
});
}
if (!body[‘size‘]) {
return response.fail({
‘msg‘: "每页数量不能为空"
});
}
// 获取TOKEN
let accessToken = await getAccessToken();
let params = {
access_token: accessToken,
messageId: body[‘messageId‘],
cursor: body[‘cursor‘],
size: parseInt(body[‘size‘]),
};
let messageRes = await request(`${host}chat/getReadList`, ‘GET‘, params);
console.log("messageRes", messageRes)
return response.success({ ‘data‘: messageRes });
} catch (e) {
console.log(e);
return response.fail({
‘msg‘: e
});
}
});

以上针对的是钉钉企业内部应用

如果是ISV开发者应用，则需要通过接口获取企业的基本信息

nodejs签名实现

/*
* 把timestamp + "\n" + suiteTicket当做签名字符串， suiteSecret做为签名秘钥，
* 使用HmacSHA256算法计算签名，然后进行Base64 encode获取最后结果。
* 然后把签名参数再进行urlconde，加到请求url后面。
*/
const crypto = require(‘crypto‘);
const accessKey = ‘suiteqh0ljtdheuee****‘; // suiteKey
const suiteSecret = ‘******‘;
const suiteTicket = ‘TestSuiteTicket‘;
const timestamp = Date.now();
const stringToSign = timestamp + "\n" + suiteTicket;
const hash = crypto.createHmac(‘sha256‘, suiteSecret)
.update(stringToSign, ‘utf8‘)
.digest().toString(‘base64‘);
console.log(hash);
var request = require("request");
var urlencode = require(‘urlencode‘);
var options = {
method: ‘POST‘,
url: ‘https://oapi.dingtalk.com/service/get_auth_info‘,
qs: {
signature: hash,
timestamp: timestamp,
suiteTicket: suiteTicket,
accessKey: accessKey
},
headers: {
‘Cache-Control‘: ‘no-cache‘,
‘Content-Type‘: ‘application/json‘
},
body: { auth_corpid: ‘dingd142a587da6ee21d35c2f4657eb6378f‘ },
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});

钉钉文档开发者链接：https://open-doc.dingtalk.com/microapp/serverapi2/isu6nk

转载于:https://www.cnblogs.com/xiaosongJiang/p/9991573.html

原文地址：https://www.cnblogs.com/westsoft/p/11282057.html

时间： 2024-10-01 22:34:52

钉钉服务端api接口使用的相关文章

C#开发BIMFACE系列10 服务端API之获取文件下载链接

通过BIMFACE控制台或者调用服务接口上传文件成功后,默认场景下需要下载该源文件,下载文件一般需要知道文件的下载链接即可.BIMACE平台提供了“获取文件下载链接”的服务接口.下面详细介绍其使用方法. 请求地址:GET https://file.bimface.com/download/url 说明:应用通过该接口获取文件的下载地址,然后下载文件.下载地址有效时间是5分钟. 参数: 请求 path(示例):https://file.bimface.com/download/url?fileId

C#开发BIMFACE系列11 服务端API之源文件删除

通过BIMFACE控制台或者调用服务接口上传文件成功后,如果不再需要该文件,则可以通过BIMFACE平台提供的“源文件删除”服务接口删除具体的文件.下面详细介绍其使用方法. 请求地址:DELETE https://file.bimface.com/file 说明:根据文件ID删除文件参数: 请求 path(示例):https://file.bimface.com/file?fileId=1418750515413120 请求 header(示例):"Authorization: Bearer

C#开发BIMFACE系列14 服务端API之批量获取转换状态详情

系列目录 [已更新最新开发文章,点击查看详细] 上一篇<C#开发BIMFACE系列13 服务端API之获取转换状态>中介绍了根据文件ID查询单个文件的转换状态. 本文介绍批量获取转换状态详情. 请求地址:POST https://api.bimface.com/translateDetails 说明:应用发起转换以后,可以根据筛选条件,通过该接口批量查询转换状态详情参数: 请求 path(示例):https://api.bimface.com/translateDetails 请求

C#开发BIMFACE系列24 服务端API之获取模型数据9：获取单个房间信息

系列目录 [已更新最新开发文章,点击查看详细] 大厦建筑模型中,基本上包含多个楼层,每个楼层包含多个房间等信息.在<C#开发BIMFACE系列21 服务端API之获取模型数据6:获取单模型的楼层信息>中介绍了如何获取一个模型中包含的楼层信息.面积分区.房间等信息.本篇主要介绍如何获取单个模型中单个房间信息. 请求地址:GET https://api.bimface.com/data/v2/files/{fileId}/rooms/{roomId} 说明:获取单个模型种单个房间信息参数

python的flex服务端数据接口开发

python的flex服务端数据接口开发 python 如果给flex提供服务端,需要提供一个网关和一个可供客户端(flex)调用的类.这方面我更加推荐用twisted来写这个网关,因为twisted有很好的异步机制. 下面的我写的一个简单的验证用户的python服务端: ______________________________DBServer.py # Copyright (c) 2009-2010 The Newjh Project."""@author: Roy@s

服务端测试之接口测试用例设计

小伙伴们大家好,上一次和大家分享了<服务端测试之接口测试初探>,讲了一些接口测试的基本概念和理论知识.在上次的分享中,简单提到了接口测试用例设计包含的几个方面.本期我将在上次分享的基础上,和各位小伙伴一起具体看看这几个方面都是什么,在实际的项目中应该如何使用. 一.功能性用例设计之前讲过,服务端的接口是和客户端的功能相对应的,对功能的验证,可以参照接口说明文档来进行.概括起来讲,就是我们需要验证接口说明文档中提到的各种情况,保证这些情况下接口的返回和最初设计的是一样的,这样我们就可以认为该接

APP服务端API(数据接口)设计应该考虑到的问题

1.跨平台性 2.良好的响应速度 3.接口要为移动客户端考虑 4.考虑移动端的网络情况和耗电量 5.通用的数据交换格式 6.接口统计功能 7.客户端与服务端的肥瘦平衡 8.隐式用户与显式用户 9.安全问题 10.良好的接口说明文档和测试程序 11.版本的维护详细分析请参考 :https://www.hutuseng.com/article/how-to-design-api 原文地址:http://blog.51cto.com/825272560/2058638

移动APP服务端API设计应该考虑到的问题

转载:http://www.hutuseng.com/article/how-to-design-api 2014年,移动APP的热度丝毫没有减退,怎样为您的移动端app设计良好的服务器端接口(API)呢? 下面谈谈我个人的一些想法. 2014年,移动APP的热度丝毫没有减退,并没有像桌面软件被WEB网站那样所取代,不但如此,越来越多的传统应用.网站也都开始制作自己的移动APP,也就是我们常说的IOS客户端.android客户端.这仿佛又回到了多年前的CS架构,那时候我们用VB.VC.Delph

移动端API接口优化的术和结果

最近一直在忙工作的事情,所以文章写得有些少. 有3-5篇文章都是写到一半然后被别的事情给打断了,所以,我得找个时间好好补补. 最近一直在关注移动端接口API的可用性问题,在移动时代这个做这个优化能产生相当大的优化结果.根据经验数据一般不做任何优化,接口的可用性在95%左右.举个例子,广告接口的可用性直接决定了收入,那么丢失的5%收入如何捡回来,对一家收入还不错的公司来说,是一件非常重大的事情.例如日营收1亿+的百度. 造成这样的主要的原因有两大块 1. app端网络状况并不好即便是wifi条件