dingtalk

README

创建和配置应用 先有应用我们才能一起玩

dingtalk 是基于新版的 钉钉开发平台api文档 开发，也就是说在你使用之前是需要在钉钉开发者后台 创建一个小程序或应用

为什么有它

首先我要感谢 godingtalk 库,我是参考他的代码写的。但是由于钉钉历史原因，很多api都更新了,其次就是我有很多钉钉预警的业务需要做,于是就写了这个

怎么使用

go get github.com/zhaoyunxing92/dingtalk/v2

client := NewClient(1244553273, "appkey", "AppSecret")
// 获取token
token, _ := client.GetAccessToken()

fmt.Println(token)

日志级别设置

client:= NewClient(1244553273, "appkey", "AppSecret", WithLevel(zap.DebugLevel))

isv和企业内部开发切换

在NewClient的时候如果调用了WithTicket和WithCorpId则判定为是isv

一个api的诞生过程

dingtalk.go文件里面已经对网络请求封装好了所以写起来会方便很多，下面从简单的 创建用户 说起

安装工具

格式import的

go get -u github.com/dubbogo/tools/cmd/imports-formatter@v1.0.7

添加license

go get -u github.com/lsm-dev/license-header-checker/cmd/license-header-checker@v1.2.0

在request目录下创建一个文件create_user.go

按照文档写参数，注意如果遇到参数校验可以使用validate tag标记

在response目录里面也创建一个文件create_user.go必须包含Response结构体

type CreateUser struct {
Response
createUserResponse `json:"result"`
}

type createUserResponse struct {
UserId string `json:"userid"`
}

文件添加license

license-header-checker -v -a -r -i vendor,license-header-checker,tools ./header/license_header.txt . go

格式化import

imports-formatter

参考文档

dingtalk-callback-Crypto

开发进度

• 获取凭证 (2/5)

  • 获取企业内部应用的access_token client.GetAccessToken
  • 服务商获取第三方应用授权企业的access_token client.GetCorpAccessToken
  • 获取第三方企业应用的suite_access_token client.GetSuiteAccessToken
  • 获取jsapi_ticket client.GetJsApiTicket
  • 获取微应用后台免登的SsoToken client.GetSSOToken

• 通讯录管理

  • 用户管理(14/14)

    • 创建用户 client.CreateUser
    • 删除用户 client.DeleteUser
    • 更新用户详情 client.UpdateUser
    • 根据userid获取用户详情 client.GetUserDetail
    • 获取部门用户基础信息 client.GetDeptUserIds
    • 获取部门用户userid列表 client.GetDeptUserIds
    • 获取部门用户详情 client.GetDeptDetailUserInfo
    • 获取员工人数 client.GetUserCount
    • 获取未登录钉钉的员工列表 client.GetInactiveUser
    • 根据手机号获取userid client.GetUserIdByMobile
    • 根据unionid获取用户userid client.GetUserIdByUnionId
    • 获取管理员列表 client.GetOrgAdminUser
    • 获取管理员通讯录权限范围 client.GetOrgAdminScope
    • 获取管理员的应用管理权限 client.GetUserCanAccessApplet

  • 部门管理(8/8)

    • 创建部门 client.CreateDept
    • 更新部门 client.UpdateDept
    • 删除部门 client.DeleteDept
    • 获取部门详情 client.GetDeptDetail
    • 获取部门列表 client.GetDeptList
    • 获取子部门Id列表 client.GetSubDeptList
    • 获取指定部门的所有父部门列表 client.GetParentIdsByDeptId
    • 获取指定用户的所有父部门列表 client.GetParentIdsByUserId

  • 角色管理(11/11)

    • 创建角色 client.CreateRole
    • 创建角色组 client.CreateRoleGroup
    • 更新角色 client.UpdateRole
    • 批量增加员工角色 client.BatchAddUserRole
    • 删除角色 client.DeleteRole
    • 批量删除员工角色 client.BatchRemoveUserRole
    • 批量删除员工角色 client.BatchRemoveUserRole
    • 设定角色成员管理范围 client.SetUserRoleManageScope 官方接口不通
    • 获取角色组列表 client.GetGroupRoles
    • 获取角色列表 client.GetRoleList
    • 获取角色详情 client.GetRoleDetail
    • 获取指定角色的员工列表 client.GetRoleUserList

  • 外部联系人(6/6)

    • 添加外部联系人 client.CreateExtContact
    • 删除外部联系人 client.DeleteExtContact
    • 更新外部联系人 client.UpdateExtContact
    • 获取外部联系人列表 client.GetExtContact
    • 获取外部联系人标签列表 client.GetExtContactLabel
    • 获取外部联系人详情 client.GetExtContactDetail

• 群会话管理(7/7)

  • 创建群会话 client.CreateChat
  • 获取群会话信息 client.GetChatInfo
  • 修改群会话 client.UpdateChat
  • 设置禁止群成员私聊 client.ChatFriendSwitch
  • 获取入群二维码链接 client.GetChatQRCode
  • 设置群管理员 client.ChatSetSubAdmin
  • 设置群成员昵称 client.ChatSetUserNick

• 消息通知(4/6)

  • 工作通知

    • 使用模板发送工作通知消息 client.SendTemplateMessage
    • 发送工作通知 client.SendCorpConvMessage
    • 更新工作通知状态栏 client.UpdateCorpConvMessageStatus
    • 获取工作通知消息的发送进度 client.GetCorpConvMsgProgress
    • 获取工作通知消息的发送结果 client.GetMessageSendResult
    • 撤回工作通知消息 client.RecallCorpConvMessage

  • 企业群消息

    • 发送消息到企业群 client.SendChatMessage
    • 查询群消息已读人员列表 client.GetChatMsgReadUser

  • 普通消息

    • 发送普通消息 client.SendMessage

• 身份验证

  • 通过免登码获取用户信息 client.GetUserInfoByCode
  • 获取应用管理员的身份信息 client.GetSSOUserInfo
  • 根据sns临时授权码获取用户信息

• 应用授权(6/6)

  • 激活应用 client.ActivateSuite
  • 获取授权应用的基本信息 client.GetAgentInfo
  • 获取企业授权信息 client.GetAuthInfo
  • 获取授权企业的永久授权码 client.GetCorpPermanentCode
  • 获取应用未激活的企业列表 client.GetUnactiveCorpIds
  • 重新授权未激活应用的企业 client.ReauthCorp

• 待办任务

  • 新增钉钉待办任务 client.CreateTodo
  • 获取钉钉待办任务详情 client.GetTodoDetail
  • 删除钉钉待办任务 client.DeleteTodo
  • 更新钉钉待办任务 client.UpdateTodo
  • 更新钉钉待办执行者状态 client.UpdateTodoDone
  • 根据sourceId获取钉钉待办任务详情 client.GetTodoListBySourceId
  • 查询企业下用户待办列表 client.GetTodoList

• 钉盘

  • 空间管理
    • 新建空间 client.CreateDriveSpaces
    • 删除空间 client.DeleteDriveSpaces
    • 获取空间列表 client.GetDriveSpaces
    • 获取空间信息 client.GetDriveSpacesInfo
  • 文件管理
    • 查询文件（夹）列表 client.GetDriveSpacesFiles
    • 查询文件（夹）信息 client.GetDriveSpacesFileInfo
    • 添加文件（夹） client.CreateDriveSpacesFiles
    • 删除文件（夹） client.DeleteDriveSpacesFiles
    • 移动文件（夹） client.MoveDriveSpacesFiles
    • 修改文件（夹）名 client.RenameDriveSpacesFiles
  • 权限管理
    • 获取权限列表 client.GetDriveSpacesFilesPermissions
    • 添加权限 client.AddDriveSpacesFilesPermissions
    • 删除权限
    • 修改权限
    • 修改权限
    • 添加自定义空间权限
  • 回收站
    • 查询回收站文件（夹）列表
    • 还原回收站文件（夹）
    • 删除回收站文件（夹）
    • 清空回收站

• 智能人事

  • 获取在职员工列表 client.GetHrmEmployee <<<<<<< HEAD
  • 获取待入职员工列表 client.GetHrmToBeHiredEmployee =======

main

• 应用管理 (3/4)

  • 获取应用列表
  • 获取员工可见的应用列表
  • 设置应用的可见范围
  • 获取应用可见范围

• 群机器人

  • 自定义机器人接入 基本的消息类型都已经支持并完成测试

• AI

  • 文本翻译
  • OCR文字识别
  • ASR 一句话语音识别

• 文件存储 (1/10)

  • 上传媒体文件 client.MediaUpload
  • 新增文件到用户自定义空间
  • 发送钉盘文件给指定用户
  • 获取企业下的自定义空间
  • 获取应用自定义空间使用详情
  • 授权用户访问企业的自定义空间
  • 单步文件上传
  • 开启分块上传事务
  • 提交文件上传事务
  • 上传文件块

Documentation

Index

• func NewClient(id int, key, secret string, opts ...OptionFunc) (ding *dingTalk)
• type OptionFunc
  • func WithCorpId(corpId string) OptionFunc
  • func WithLevel(level zapcore.Level) OptionFunc
  • func WithSSOSecret(secret string) OptionFunc
  • func WithTicket(ticket string) OptionFunc
• type Robot
  • func NewRobot(token string) Robot
  • func (robot *Robot) SendRobotMsg(req domain.Request) (res domain.Response, err error)

Functions

func NewClient

func NewClient(id int, key, secret string, opts ...OptionFunc) (ding *dingTalk)

NewClient new DingTalkBuilder

Types

type OptionFunc

type OptionFunc func(*dingTalk)

func WithCorpId

func WithCorpId(corpId string) OptionFunc

func WithLevel

func WithLevel(level zapcore.Level) OptionFunc

func WithSSOSecret

func WithSSOSecret(secret string) OptionFunc

func WithTicket

func WithTicket(ticket string) OptionFunc

type Robot

type Robot struct {
	Token string
	// contains filtered or unexported fields
}

func NewRobot

func NewRobot(token string) Robot

https://oapi.dingtalk.com/robot/send?access_token=f00184626027aafcd6b4fe07b90ec11250d78b8735282185256a0c72186a5f49

func (*Robot) SendRobotMsg

func (robot *Robot) SendRobotMsg(req domain.Request) (res domain.Response, err error)

SendRobotMsg:机器人发送消息