wecom_bot_api

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2021 License: MIT Imports: 16 Imported by: 1

README

WeCom-Bot-API

企业微信-群机器人-API

Installation

go get github.com/electricbubble/wecom-bot-api

Usage

纯文本消息
package main

import (
	botApi "github.com/electricbubble/wecom-bot-api"
	"os"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	phoneNumber := os.Getenv("Phone_Number")
	userid := os.Getenv("Userid")

	bot := botApi.NewWeComBot(botKey)

	// 仅发送文本内容
	_ = bot.PushTextMessage("hi")

	// 通过群成员 `手机号码` 进行 `@` 提醒
	_ = bot.PushTextMessage("hi again", botApi.MentionByMobile(phoneNumber))

	// 通过群成员 `userid` 进行 `@` 提醒
	_ = bot.PushTextMessage("hi again", botApi.MentionByUserid(userid))

	// @全部成员
	_ = bot.PushTextMessage("hi again",
		botApi.MentionAllByMobile(),
		// botApi.MentionAllByUserid(),
	)
}
Markdown 消息
package main

import (
	"bytes"
	botApi "github.com/electricbubble/wecom-bot-api"
	"github.com/electricbubble/wecom-bot-api/md"
	"os"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	userid := os.Getenv("Userid")

	bot := botApi.NewWeComBot(botKey)

	content := bytes.NewBufferString(md.Heading(1, "H1"))
	content.WriteString("实时新增用户反馈" + md.WarningText("132例") + "，请相关同事注意。\n")
	content.WriteString(md.QuoteText("类型:" + md.CommentText("用户反馈")))
	content.WriteString(md.QuoteText("普通用户反馈:" + md.CommentText("117例")))
	content.WriteString(md.QuoteText("VIP用户反馈:" + md.CommentText("15例")))
	// 👆效果等同于👇
	/*
		# H1
		实时新增用户反馈 <font color="warning">132例</font>，请相关同事注意。\n
		> 类型:<font color="comment">用户反馈</font>
		> 普通用户反馈:<font color="comment">117例</font>
		> VIP用户反馈:<font color="comment">15例</font>
	*/

	// 仅发送 `markdown` 格式的文本
	_ = bot.PushMarkdownMessage(content.String())

	// 通过群成员 `userid` 进行 `@` 提醒
	_ = bot.PushMarkdownMessage(
		md.Heading(2, "H2") + md.Bold("hi") + "\n" + "> again\n" +
			md.MentionByUserid(userid),
	)
}
图片消息
package main

import (
	botApi "github.com/electricbubble/wecom-bot-api"
	"io/ioutil"
	"os"
	"path"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	bot := botApi.NewWeComBot(botKey)

	userHomeDir, _ := os.UserHomeDir()
	filename := path.Join(userHomeDir, "Pictures", "IMG_5246.jpg")
	readFile, _ := ioutil.ReadFile(filename)

	// 发送 图片消息
	_ = bot.PushImageMessage(readFile)
}
图文消息
package main

import (
	botApi "github.com/electricbubble/wecom-bot-api"
	"os"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	bot := botApi.NewWeComBot(botKey)

	article := botApi.NewArticle("中秋节礼品领取", "www.qq.com",
		botApi.ArticleDescription("今年中秋节公司有豪礼相送"),
		botApi.ArticlePicUrl("http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"),
	)
	article2 := botApi.NewArticle("图文标题2", "www.qq.com",
		botApi.ArticleDescription("图文描述2"),
	)
	article3 := botApi.NewArticle("图文标题3", "www.qq.com",
		botApi.ArticleDescription("图文描述3"),
	)
	_, _ = article2, article3

	// 发送 `1条图文` 消息
	_ = bot.PushNewsMessage(article)

	// 发送 `多条图文` 消息 (一个图文消息支持 `1~8条` 图文)
	_ = bot.PushNewsMessage(article, article2, article3)
}
文本通知模版卡片
package main

import (
	botApi "github.com/electricbubble/wecom-bot-api"
	"os"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	bot := botApi.NewWeComBot(botKey)

	// "media_id":"38BHOWH1SHSCZImMcuPmG2TuJSpYikh0AxznKJYSUJAJaFJvDeRu60NTAuj_IKLoR"
	media := botApi.Media{ID: "38BHOWH1SHSCZImMcuPmG2TuJSpYikh0AxznKJYSUJAJaFJvDeRu60NTAuj_IKLoR"}

	rawUrl := "https://work.weixin.qq.com/api/doc/90000/90136/91770#%E6%96%87%E6%9C%AC%E9%80%9A%E7%9F%A5%E6%A8%A1%E7%89%88%E5%8D%A1%E7%89%87"

	// botApi.TemplateCardActionApp("APPID", "/index.html")

	_ = bot.PushTemplateCardTextNotice(
		botApi.TemplateCardMainTitle("一级标题", "标题辅助信息"), botApi.TemplateCardActionUrl(rawUrl),
		botApi.TemplateCardSource("https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0", "企业微信"),
		botApi.TemplateCardEmphasisContent("关键数据标题", "关键数据描述"),
		botApi.TemplateCardSubTitleText("二级普通文本"),
		botApi.TemplateCardHorizontalContent("二级标题(text)", botApi.TemplateCardHorizontalContentText("二级文本")),
		botApi.TemplateCardHorizontalContent("二级标题(url)", botApi.TemplateCardHorizontalContentUrl(rawUrl, "api地址")),
		botApi.TemplateCardHorizontalContent("二级标题(media)", botApi.TemplateCardHorizontalContentMedia("IMG_5246.jpg", media)),
		botApi.TemplateCardJump("跳转指引", botApi.TemplateCardJumpUrl(rawUrl)),
		botApi.TemplateCardJump("企业微信官网", botApi.TemplateCardJumpUrl("https://work.weixin.qq.com")),
	)
}
图文展示模版卡片
package main

import (
	botApi "github.com/electricbubble/wecom-bot-api"
	"os"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	bot := botApi.NewWeComBot(botKey)

	// "media_id":"38BHOWH1SHSCZImMcuPmG2TuJSpYikh0AxznKJYSUJAJaFJvDeRu60NTAuj_IKLoR"
	media := botApi.Media{ID: "38BHOWH1SHSCZImMcuPmG2TuJSpYikh0AxznKJYSUJAJaFJvDeRu60NTAuj_IKLoR"}

	rawUrl := "https://work.weixin.qq.com/api/doc/90000/90136/91770#%E5%9B%BE%E6%96%87%E5%B1%95%E7%A4%BA%E6%A8%A1%E7%89%88%E5%8D%A1%E7%89%87"
	imgUrl := "https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0"

	// botApi.TemplateCardActionApp("APPID", "/index.html")

	_ = bot.PushTemplateCardNewsNotice(
		botApi.TemplateCardMainTitle("一级标题", "标题辅助信息"), botApi.TemplateCardImage(imgUrl), botApi.TemplateCardActionUrl(rawUrl),
		botApi.TemplateCardSource("https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0", "企业微信"),
		botApi.TemplateCardVerticalContent("卡片二级标题", "二级普通文本"),
		botApi.TemplateCardHorizontalContent("二级标题(text)", botApi.TemplateCardHorizontalContentText("二级文本")),
		botApi.TemplateCardHorizontalContent("二级标题(url)", botApi.TemplateCardHorizontalContentUrl(rawUrl, "api地址")),
		botApi.TemplateCardHorizontalContent("二级标题(media)", botApi.TemplateCardHorizontalContentMedia("IMG_5246.jpg", media)),
		botApi.TemplateCardJump("跳转指引", botApi.TemplateCardJumpUrl(rawUrl)),
		botApi.TemplateCardJump("企业微信官网", botApi.TemplateCardJumpUrl("https://work.weixin.qq.com")),
	)
}
文件消息
package main

import (
	botApi "github.com/electricbubble/wecom-bot-api"
	"os"
	"path"
)

func main() {
	botKey := os.Getenv("WeCom_Bot_Key")
	bot := botApi.NewWeComBot(botKey)

	userHomeDir, _ := os.UserHomeDir()
	filename := path.Join(userHomeDir, "Pictures", "IMG_5246.jpg")

	// 必须先通过企业微信上传文件接口, 获取 `media_id` (仅三天内有效)
	// https://work.weixin.qq.com/api/doc/90000/90136/91770#%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0%E6%8E%A5%E5%8F%A3
	media, _ := bot.UploadFile(filename)
	// 发送 文件消息
	_ = bot.PushFileMessage(media)
}

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BotSendUrl = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=%s"

BotSendUrl 企业微信群机器人 webhook

View Source 
var HTTPClient = http.DefaultClient
View Source 
var UploadMediaUrl = "https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key=%s&type=file"

UploadMediaUrl 企业微信上传文件接口 `url`, `type` 固定传 `file`

Functions

func SetDebug 

func SetDebug(debug bool)

Types

type Article 

type Article struct {
	// **必填** 标题, 不超过 128 个字节, 超过会自动截断
	Title string `json:"title"`

	// **选填** 描述, 不超过 512 个字节, 超过会自动截断
	Description string `json:"description,omitempty"`

	// **必填** 点击后跳转的链接
	Url string `json:"url"`

	// **选填** 图文消息的图片链接, 支持 `JPG`、`PNG` 格式, 较好的效果为大图 `1068*455`, 小图 `150*150`
	PicUrl string `json:"picurl,omitempty"`
}

func NewArticle 

func NewArticle(title, Url string, opts ...ArticleOption) Article

type ArticleOption 

type ArticleOption func(d *Article)

func ArticleDescription 

func ArticleDescription(desc string) ArticleOption

func ArticlePicUrl 

func ArticlePicUrl(picUrl string) ArticleOption

type Media 

type Media struct {
	// 文件id, 通过文件上传接口获取
	ID string `json:"media_id"`
}

type TemplateCardAction added in v0.2.0 

type TemplateCardAction func(act *templateCardAction)

func TemplateCardActionApp added in v0.2.0 

func TemplateCardActionApp(appID string, pagePath string) TemplateCardAction

func TemplateCardActionUrl added in v0.2.0 

func TemplateCardActionUrl(rawUrl string) TemplateCardAction

type TemplateCardHorizontalContentOption added in v0.2.0 

type TemplateCardHorizontalContentOption func(hc *templateCardHorizontalContent)

func TemplateCardHorizontalContentMedia added in v0.2.0 

func TemplateCardHorizontalContentMedia(filename string, media Media) TemplateCardHorizontalContentOption

func TemplateCardHorizontalContentText added in v0.2.0 

func TemplateCardHorizontalContentText(text string) TemplateCardHorizontalContentOption

func TemplateCardHorizontalContentUrl added in v0.2.0 

func TemplateCardHorizontalContentUrl(rawUrl string, text string) TemplateCardHorizontalContentOption

type TemplateCardImageOption added in v0.2.0 

type TemplateCardImageOption func(img *templateCardImage)

func TemplateCardImage added in v0.2.0 

func TemplateCardImage(rawUrl string, aspectRatio ...float64) TemplateCardImageOption

TemplateCardImage 

aspectRatio 图片的宽高比
 宽高比要小于2.25
 大于1.3
 不填该参数默认1.3

type TemplateCardJumpOption added in v0.2.0 

type TemplateCardJumpOption func(j *templateCardJump)

func TemplateCardJumpApp added in v0.2.0 

func TemplateCardJumpApp(appID string, pagePath string) TemplateCardJumpOption

func TemplateCardJumpUrl added in v0.2.0 

func TemplateCardJumpUrl(rawUrl string) TemplateCardJumpOption

type TemplateCardMainTitleOption added in v0.2.0 

type TemplateCardMainTitleOption func(mt *templateCardMainTitle)

func TemplateCardMainTitle added in v0.2.0 

func TemplateCardMainTitle(title string, desc string) TemplateCardMainTitleOption

type TemplateCardOption added in v0.2.0 

type TemplateCardOption func(tc *templateCard)

func TemplateCardEmphasisContent added in v0.2.0 

func TemplateCardEmphasisContent(title, desc string) TemplateCardOption

func TemplateCardHorizontalContent added in v0.2.0 

func TemplateCardHorizontalContent(keyName string, opt TemplateCardHorizontalContentOption) TemplateCardOption

TemplateCardHorizontalContent 二级标题+文本列表 

列表长度不超过6

func TemplateCardJump added in v0.2.0 

func TemplateCardJump(title string, opt TemplateCardJumpOption) TemplateCardOption

TemplateCardJump 跳转指引样式的列表 

列表长度不超过3

func TemplateCardSource added in v0.2.0 

func TemplateCardSource(iconUrl, desc string) TemplateCardOption

func TemplateCardSubTitleText added in v0.2.0 

func TemplateCardSubTitleText(subTitle string) TemplateCardOption

func TemplateCardVerticalContent added in v0.2.0 

func TemplateCardVerticalContent(title, desc string) TemplateCardOption

TemplateCardVerticalContent 卡片二级垂直内容 

列表长度不超过4

type TextMsgOption 

type TextMsgOption func(d *textData)

func MentionAllByMobile 

func MentionAllByMobile() TextMsgOption

MentionAllByMobile `@all` 提醒所有人, 等同于 MentionAllByUserid

func MentionAllByUserid 

func MentionAllByUserid() TextMsgOption

MentionAllByUserid `@all` 提醒所有人, 等同于 MentionAllByMobile

func MentionByMobile 

func MentionByMobile(mobile string) TextMsgOption

MentionByMobile 通过 `手机号码` @某个成员

func MentionByUserid 

func MentionByUserid(userid string) TextMsgOption

MentionByUserid 通过 `userid` @某个成员

type WeComBot 

type WeComBot interface {
	PushTextMessage(content string, opts ...TextMsgOption) error
	PushMarkdownMessage(content string) error
	PushImageMessage(img []byte) error
	PushNewsMessage(art Article, articles ...Article) error
	PushFileMessage(media Media) error
	PushTemplateCardTextNotice(mainTitle TemplateCardMainTitleOption, cardAction TemplateCardAction, opts ...TemplateCardOption) error
	PushTemplateCardNewsNotice(mainTitle TemplateCardMainTitleOption, cardImage TemplateCardImageOption, cardAction TemplateCardAction, opts ...TemplateCardOption) error
	UploadFile(filename string) (media Media, err error)
}

func NewWeComBot 

func NewWeComBot(key string) WeComBot

Source Files

View all Source files

Directories

Path Synopsis

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.