godingtalk

package module
v0.0.0-...-bef3df3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2016 License: MIT Imports: 17 Imported by: 0

README

DingTalk Open API golang SDK

image

Check out DingTalk Open API document at: http://open.dingtalk.com

Usage

Fetch the SDK

export GOPATH=`pwd`
go get github.com/hugozhu/godingtalk
Example code to send a micro app message
package main

import (
    "github.com/hugozhu/godingtalk"
    "log"
    "os"
)

func main() {
    c := godingtalk.NewDingTalkClient(os.Getenv("corpid"), os.Getenv("corpsecret"))
    c.RefreshAccessToken()
    err := c.SendAppMessage(os.Args[1], os.Args[2], os.Args[3])
    if err != nil {
        log.Println(err)
    }
}

Guide

Step-by-step Guide to use this SDK

http://hugozhu.myalert.info/2016/05/02/66-use-dingtalk-golang-sdk-to-send-message-on-pi.html

Tools

ding_alert : Command line tool to send app/text/oa ... messages

export GOPATH=`pwd`
go get github.com/hugozhu/godingtalk/ding_alert

export corpid=<组织的corpid 通过 https://oa.dingtalk.com 获取>
export corpsecret=<组织的corpsecret 通过 https://oa.dingtalk.com 获取>

./bin/ding_alert
Usage of ./bin/ding_alert:
  -agent string
    	agent Id (default "22194403")
  -chat string
    	chat id (default "chat6a93bc1ee3b7d660d372b1b877a9de62")
  -file string
    	file path for media message
  -link string
    	link url (default "http://hugozhu.myalert.info/dingtalk")
  -sender string
    	sender id (default "011217462940")
  -text string
    	text for link message (default "This is link text")
  -title string
    	title for link message (default "This is link title")
  -touser string
    	touser id (default "0420506555")
  -type string
    	message type (app, text, image, voice, link, oa) (default "app")

github: Deliver Github webhook events to DingTalk, which can be deployed on Google AppEngine.

more info at: http://hugozhu.myalert.info/2016/05/15/67-use-free-google-cloud-service-to-deliver-github-webhook-events-to-dingtalk.html

export GOPATH=`pwd`
go get github.com/hugozhu/godingtalk/demo/github/appengine

Modify app.yaml

cd src/github.com/hugozhu/godingtalk/demo/github/appengine
cat app.yaml
application: github-alert-<random_number>
version: 1
runtime: go
api_version: go1
env_variables:
  CORP_ID: '<从 http://oa.dingtalk.com 获取>'
  CORP_SECRET: '<从 http://oa.dingtalk.com 获取>'
  GITHUB_WEBHOOK_SECRET: '<从 http://github.com/ 获取>'
  SENDER_ID: '<从 http://open.dingtalk.com 调用api获取>'
  CHAT_ID: '<从 http://open.dingtalk.com 调用api获取>'
handlers:
- url: /.*
  script: _go_app

Documentation

Overview

普通钉钉用户账号开放相关接口

Index

Constants

View Source 
const (
	//VERSION is SDK version
	VERSION = "0.1"

	//ROOT is the root url
	ROOT = "https://oapi.dingtalk.com/"
)
View Source 
const (
	AES_ENCODE_KEY_LENGTH = 43
)

Variables

This section is empty.

Functions

func PKCS7Padding 

func PKCS7Padding(ciphertext []byte, blockSize int) []byte

func PKCS7UnPadding 

func PKCS7UnPadding(plantText []byte) []byte

func Sign 

func Sign(ticket string, nonceStr string, timeStamp string, url string) string

Sign is 签名

Types

type AccessTokenResponse 

type AccessTokenResponse struct {
	OAPIResponse
	AccessToken string `json:"access_token"`
	Expires     int    `json:"expires_in"`
	Created     int64
}

AccessTokenResponse is

func (*AccessTokenResponse) CreatedAt 

func (e *AccessTokenResponse) CreatedAt() int64

CreatedAt is when the access token is generated

func (*AccessTokenResponse) ExpiresIn 

func (e *AccessTokenResponse) ExpiresIn() int

ExpiresIn is how soon the access token is expired

type Cache 

type Cache interface {
	Set(data Expirable) error
	Get(data Expirable) error
}

type Callback 

type Callback struct {
	OAPIResponse
	Token     string
	AES_KEY   string `json:"aes_key"`
	URL       string
	Callbacks []string `json:"call_back_tag"`
}

type Crypto 

type Crypto struct {
	Token    string
	AesKey   string
	SuiteKey string
	// contains filtered or unexported fields
}
var DefaultDingtalkCrypto *Crypto

func NewCrypto 

func NewCrypto(token, aesKey, suiteKey string) (c *Crypto)

token 数据签名需要用到的token，ISV(服务提供商)推荐使用注册套件时填写的token，普通企业可以随机填写 aesKey 数据加密密钥。用于回调数据的加密，长度固定为43个字符，从a-z, A-Z, 0-9共62个字符中选取,您可以随机生成，ISV(服务提供商)推荐使用注册套件时填写的EncodingAESKey suiteKey 一般使用corpID

func (*Crypto) DecryptMsg 

func (c *Crypto) DecryptMsg(signature, timeStamp, nonce, secretStr string) (string, error)

signature: 签名字符串 timeStamp: 时间戳 nonce: 随机字符串 secretStr: 密文 返回: 解密后的明文

func (*Crypto) EncryptMsg 

func (c *Crypto) EncryptMsg(replyMsg, timeStamp, nonce string) (string, string, error)

replyMsg: 明文字符串 timeStamp: 时间戳 nonce: 随机字符串 返回: 密文,签名字符串

func (*Crypto) GenerateSignature 

func (c *Crypto) GenerateSignature(token, timeStamp, nonce, secretStr string) string

数据签名

func (*Crypto) RandomString 

func (c *Crypto) RandomString(n int, alphabets ...byte) string

func (*Crypto) VerifySignature 

func (c *Crypto) VerifySignature(token, timeStamp, nonce, secretStr, sigture string) bool

校验数据签名

type DataMessage 

type DataMessage struct {
	OAPIResponse
	Data string
}

DataMessage 服务端加密、解密消息

type Department 

type Department struct {
	OAPIResponse
	Id                    int
	Name                  string
	ParentId              int
	Order                 int
	DeptPerimits          string
	UserPerimits          string
	OuterDept             bool
	OuterPermitDepts      string
	OuterPermitUsers      string
	OrgDeptOwner          string
	DeptManagerUseridList string
}

type DepartmentList 

type DepartmentList struct {
	OAPIResponse
	Departments []Department `json:"department"`
}

type DingTalkClient 

type DingTalkClient struct {
	CorpID      string
	CorpSecret  string
	AgentID     string
	AccessToken string
	HTTPClient  *http.Client
	Cache       Cache

	//社交相关的属性
	SnsAppID       string
	SnsAppSecret   string
	SnsAccessToken string
}

DingTalkClient is the Client to access DingTalk Open API

func NewDingTalkClient 

func NewDingTalkClient(corpID string, corpSecret string) *DingTalkClient

NewDingTalkClient creates a DingTalkClient instance

func (*DingTalkClient) CreateChat 

func (c *DingTalkClient) CreateChat(name string, owner string, useridlist []string) (string, error)

CreateChat is

func (*DingTalkClient) CreateFile 

func (c *DingTalkClient) CreateFile(size int64) (file FileResponse, err error)

CreateFile is to create a new file in Ding Space

func (*DingTalkClient) Decrypt 

func (c *DingTalkClient) Decrypt(str string) (string, error)

Decrypt is 服务端解密

func (*DingTalkClient) DeleteCallback 

func (c *DingTalkClient) DeleteCallback() error

DeleteCallback is 删除事件回调接口

func (*DingTalkClient) DepartmentDetail 

func (c *DingTalkClient) DepartmentDetail(id int) (Department, error)

DepartmentDetail is 获取部门详情

func (*DingTalkClient) DepartmentList 

func (c *DingTalkClient) DepartmentList() (DepartmentList, error)

DepartmentList is 获取部门列表

func (*DingTalkClient) DownloadMedia 

func (c *DingTalkClient) DownloadMedia(mediaID string, write io.Writer) error

DownloadMedia is to download a media file from DingTalk

func (*DingTalkClient) Encrypt 

func (c *DingTalkClient) Encrypt(str string) (string, error)

Encrypt is 服务端加密

func (*DingTalkClient) GetConfig 

func (c *DingTalkClient) GetConfig(nonceStr string, timestamp string, url string) string

GetConfig is to return config in json

func (*DingTalkClient) GetJsAPITicket 

func (c *DingTalkClient) GetJsAPITicket() (ticket string, err error)

GetJsAPITicket is to get a valid ticket for JS API

func (*DingTalkClient) GetSnsPersistentCode 

func (c *DingTalkClient) GetSnsPersistentCode(tmpAuthCode string) (string, string, string, error)

获取用户授权的持久授权码

func (*DingTalkClient) GetSnsToken 

func (c *DingTalkClient) GetSnsToken(openid, persistentCode string) (string, error)

获取用户授权的SNS_TOKEN

func (*DingTalkClient) GetSnsUserInfo 

func (c *DingTalkClient) GetSnsUserInfo(snsToken string) (SnsUserInfoResponse, error)

获取用户授权的个人信息

func (*DingTalkClient) ListCallback 

func (c *DingTalkClient) ListCallback() (Callback, error)

ListCallback is 查询事件回调接口

func (*DingTalkClient) RefreshAccessToken 

func (c *DingTalkClient) RefreshAccessToken() error

RefreshAccessToken is to get a valid access token

func (*DingTalkClient) RefreshSnsAccessToken 

func (c *DingTalkClient) RefreshSnsAccessToken() error

获取钉钉开放应用ACCESS_TOKEN TODO: 

根据和赤司(钉钉开发者)的沟通，ACCESS_TOKEN只有两个小时的有效期
但是目前接口貌似没有返回过期时间相关的信息，因此所有相关的调用都需要强制刷新

func (*DingTalkClient) RegisterCallback 

func (c *DingTalkClient) RegisterCallback(callbacks []string, token string, aes_key string, callbackURL string) error

RegisterCallback is 注册事件回调接口

func (*DingTalkClient) SendAppLinkMessage 

func (c *DingTalkClient) SendAppLinkMessage(agentID, touser string, title, text string, picUrl, url string) error

SendAppLinkMessage is 发送企业会话链接消息

func (*DingTalkClient) SendAppMessage 

func (c *DingTalkClient) SendAppMessage(agentID string, touser string, msg string) error

SendAppMessage is 发送企业会话消息

func (*DingTalkClient) SendAppOAMessage 

func (c *DingTalkClient) SendAppOAMessage(agentID string, touser string, msg OAMessage) error

SendAppOAMessage is 发送OA消息

func (*DingTalkClient) SendFileMessage 

func (c *DingTalkClient) SendFileMessage(sender string, cid string, mediaID string) error

SendFileMessage is 发送文件消息

func (*DingTalkClient) SendImageMessage 

func (c *DingTalkClient) SendImageMessage(sender string, cid string, mediaID string) error

SendImageMessage is 发送图片消息

func (*DingTalkClient) SendLinkMessage 

func (c *DingTalkClient) SendLinkMessage(sender string, cid string, mediaID string, url string, title string, text string) error

SendLinkMessage is 发送链接消息

func (*DingTalkClient) SendOAMessage 

func (c *DingTalkClient) SendOAMessage(sender string, cid string, msg OAMessage) error

SendOAMessage is 发送OA消息

func (*DingTalkClient) SendRobotTextMessage 

func (c *DingTalkClient) SendRobotTextMessage(accessToken string, msg string) error

SendRobotTextMessage can send a text message to a group chat

func (*DingTalkClient) SendTextMessage 

func (c *DingTalkClient) SendTextMessage(sender string, cid string, msg string) error

SendTextMessage is 发送普通文本消息

func (*DingTalkClient) SendVoiceMessage 

func (c *DingTalkClient) SendVoiceMessage(sender string, cid string, mediaID string, duration string) error

SendVoiceMessage is 发送语音消息

func (*DingTalkClient) UpdateCallback 

func (c *DingTalkClient) UpdateCallback(callbacks []string, token string, aes_key string, callbackURL string) error

UpdateCallback is 更新事件回调接口

func (*DingTalkClient) UploadMedia 

func (c *DingTalkClient) UploadMedia(mediaType string, filename string, reader io.Reader) (media MediaResponse, err error)

UploadMedia is to upload media file to DingTalk

func (*DingTalkClient) UserInfoByCode 

func (c *DingTalkClient) UserInfoByCode(code string) (User, error)

UserInfoByCode 校验免登录码并换取用户身份

func (*DingTalkClient) UserList 

func (c *DingTalkClient) UserList(departmentID int) (UserList, error)

UserList is 获取部门成员

func (*DingTalkClient) UseridByUnionId 

func (c *DingTalkClient) UseridByUnionId(unionid string) (string, error)

UseridByUnionId 通过UnionId获取玩家Userid

type DownloadFile 

type DownloadFile struct {
	MediaID  string
	FileName string
	Reader   io.Reader
}

DownloadFile is for downloading a single file from DingTalk

type Expirable 

type Expirable interface {
	CreatedAt() int64
	ExpiresIn() int
}

type FileCache 

type FileCache struct {
	Path string
}

func NewFileCache 

func NewFileCache(path string) *FileCache

func (*FileCache) Get 

func (c *FileCache) Get(data Expirable) error

func (*FileCache) Set 

func (c *FileCache) Set(data Expirable) error

type FileResponse 

type FileResponse struct {
	OAPIResponse
	Code     int
	Msg      string
	UploadID string `json:"uploadid"`
	Writer   io.Writer
}

FileResponse is

type InMemoryCache 

type InMemoryCache struct {
	// contains filtered or unexported fields
}

func NewInMemoryCache 

func NewInMemoryCache() *InMemoryCache

func (*InMemoryCache) Get 

func (c *InMemoryCache) Get(data Expirable) error

func (*InMemoryCache) Set 

func (c *InMemoryCache) Set(data Expirable) error

type JsAPITicketResponse 

type JsAPITicketResponse struct {
	OAPIResponse
	Ticket  string
	Expires int `json:"expires_in"`
	Created int64
}

JsAPITicketResponse is

func (*JsAPITicketResponse) CreatedAt 

func (e *JsAPITicketResponse) CreatedAt() int64

CreatedAt is when the ticket is generated

func (*JsAPITicketResponse) ExpiresIn 

func (e *JsAPITicketResponse) ExpiresIn() int

ExpiresIn is how soon the ticket is expired

type MediaResponse 

type MediaResponse struct {
	OAPIResponse
	Type    string
	MediaID string `json:"media_id"`
	Writer  io.Writer
}

MediaResponse is

type OAMessage 

type OAMessage struct {
	URL   string `json:"message_url"`
	PcURL string `json:"pc_message_url"`
	Head  struct {
		BgColor string `json:"bgcolor,omitempty"`
		Text    string `json:"text,omitempty"`
	} `json:"head,omitempty"`
	Body struct {
		Title     string          `json:"title,omitempty"`
		Form      []OAMessageForm `json:"form,omitempty"`
		Rich      OAMessageRich   `json:"rich,omitempty"`
		Content   string          `json:"content,omitempty"`
		Image     string          `json:"image,omitempty"`
		FileCount int             `json:"file_count,omitempty"`
		Author    string          `json:"author,omitempty"`
	} `json:"body,omitempty"`
}

OAMessage is the Message for OA

func (*OAMessage) AppendFormItem 

func (m *OAMessage) AppendFormItem(key string, value string)

type OAMessageForm 

type OAMessageForm struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type OAMessageRich 

type OAMessageRich struct {
	Num  string `json:"num,omitempty"`
	Unit string `json:"body,omitempty"`
}

type OAPIResponse 

type OAPIResponse struct {
	ErrCode int    `json:"errcode"`
	ErrMsg  string `json:"errmsg"`
}

OAPIResponse is

type SnsPersistentCodeResponse 

type SnsPersistentCodeResponse struct {
	OAPIResponse
	UnionID        string `json:"unionid"`
	OpenID         string `json:"openid"`
	PersistentCode string `json:"persistent_code"`
}

获取用户授权的持久授权码返回信息

type SnsTokenResponse 

type SnsTokenResponse struct {
	OAPIResponse
	Expires  int    `json:"expires_in"`
	SnsToken string `json:"sns_token"`
}

type SnsUserInfoResponse 

type SnsUserInfoResponse struct {
	OAPIResponse

	CorpInfo []struct {
		CorpName    string `json:"corp_name"`
		IsAuth      bool   `json:"is_auth"`
		IsManager   bool   `json:"is_manager"`
		RightsLevel int    `json:"rights_level"`
	} `json:"corp_info"`

	UserInfo struct {
		MaskedMobile string `json:"marskedMobile"`
		Nick         string `json:"nick"`
		OpenID       string `json:"openid"`
		UnionID      string `json:"unionid"`
		DingID       string `json:"dingId"`
	} `json:"user_info"`
}

type Unmarshallable 

type Unmarshallable interface {
	// contains filtered or unexported methods
}

Unmarshallable is

type UploadFile 

type UploadFile struct {
	FieldName string
	FileName  string
	Reader    io.Reader
}

UploadFile is for uploading a single file to DingTalk

type User 

type User struct {
	OAPIResponse
	Userid     string
	Name       string
	Mobile     string
	Tel        string
	Remark     string
	Order      int
	IsAdmin    bool
	IsBoss     bool
	IsLeader   bool
	IsSys      bool `json:"is_sys"`
	SysLevel   int  `json:"sys_level"`
	Active     bool
	Department []int
	Position   string
	Email      string
	Avatar     string
	Extattr    interface{}
}

type UserList 

type UserList struct {
	OAPIResponse
	HasMore  bool
	Userlist []User
}

Source Files

View all Source files

Directories

Path Synopsis
demo
ding_alert
ding_server
github
github/appengine

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.