workwechat

Documentation

Overview

Package workwechat 企业微信机器人

Index

• Variables
• type Article
• type Image
• type Markdown
• type Message
  • func (m *Message) BuildURL(args ...string) string
  • func (m *Message) Reset() imbot.Messager
  • func (m *Message) SendMarkdown(url, title, markdown string, atMobiles ...string) error
  • func (m *Message) SendText(url, text string, atMobiles ...string) error
• type News
• type Text

Variables

var (
	KEY     = ``
	API_URL = `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=%v`
)

Types

type Article

type Article struct {
	Title       string `json:"title"`       //标题，不超过128个字节，超过会自动截断
	Description string `json:"description"` //描述，不超过512个字节，超过会自动截断
	URL         string `json:"url"`         //点击后跳转的链接。
	PicURL      string `json:"picurl"`      //图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图 1068*455，小图150*150。
}

type Image

type Image struct {
	Base64 string `json:"base64"` //图片内容的base64编码
	Md5    string `json:"md5"`    //图片内容（base64编码前）的md5值
}

type Markdown

type Markdown struct {
	Content             string   `json:"content"`               //markdown内容，最长不超过4096个字节，必须是utf8编码
	MentionedMobileList []string `json:"mentioned_mobile_list"` //手机号列表，提醒手机号对应的群成员(@某个成员)，@all表示提醒所有人
}

type Message

type Message struct {
	MsgType  string    `json:"msgtype"`            //消息类型 text/markdown/image/news
	Text     *Text     `json:"text,omitempty"`     // MsgType=text 时有效
	Markdown *Markdown `json:"markdown,omitempty"` // MsgType=markdown 时有效
	Image    *Image    `json:"image,omitempty"`    // MsgType=image 时有效
	News     *News     `json:"news,omitempty"`     // MsgType=news 时有效
}

Message 企业微信消息实体 每个机器人发送的消息不能超过20条/分钟。

func (*Message) BuildURL

func (m *Message) BuildURL(args ...string) string

func (*Message) Reset

func (m *Message) Reset() imbot.Messager

func (*Message) SendMarkdown

func (m *Message) SendMarkdown(url, title, markdown string, atMobiles ...string) error

func (*Message) SendText

func (m *Message) SendText(url, text string, atMobiles ...string) error

type News

type News struct {
	Articles []*Article `json:"articles"` //图文消息，一个图文消息支持1到8条图文
}

type Text

type Text struct {
	Content             string   `json:"content"`               //文本内容，最长不超过2048个字节，必须是utf8编码
	MentionedList       []string `json:"mentioned_list"`        //userid的列表，提醒群中的指定成员(@某个成员)，@all表示提醒所有人，如果开发者获取不到userid，可以使用mentioned_mobile_list
	MentionedMobileList []string `json:"mentioned_mobile_list"` //手机号列表，提醒手机号对应的群成员(@某个成员)，@all表示提醒所有人
}