lark

package module
v1.6.1 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2021 License: MIT Imports: 19 Imported by: 28

README

go-lark

build Go Report Card codecov Go Reference

简体中文

go-lark is an easy-to-use SDK for Feishu and Lark Open Platform, which implements messaging APIs, with full-fledged supports on building Chat Bot and Notification Bot.

It is widely used and tested by ~450 ByteDance in-house developers with over 1.5k Go packages.

Features

  • Notification bot & chat bot supported
  • Send messages (Group, Private, Rich Text, and Card)
  • Quick to build message with MsgBuffer
  • Easy to create incoming message hook
  • Encryption and token verification supported
  • Middleware support for Gin web framework
  • Highly extensible
  • Documentation & tests

Installation

go get github.com/go-lark/lark

Quick Start

Prerequisite

There are two types of bot that is supported by go-lark. We need to create a bot manually.

Chat Bot:

Notification Bot:

  • Create from group chat.
  • Web Hook URL is required.
Sending Message

Chat Bot:

import "github.com/go-lark/lark"

func main() {
    bot := lark.NewChatBot("<App ID>", "<App Secret>")
    bot.StartHeartbeat()
    bot.PostText("hello, world", lark.WithEmail("someone@example.com"))
}

Notification Bot:

import "github.com/go-lark/lark"

func main() {
    bot := lark.NewNotificationBot("<WEB HOOK URL>")
    bot.PostNotification("title", "text")
}

Feishu/Lark API offers more features, please refers to Usage for further documentation.

Limits

  • go-lark is tested on Feishu endpoints, which literally compats Lark endpoints, because Feishu and Lark basically shares the same API specification. We do not guarantee all of the APIs work well with Lark, until we have tested it on Lark.
  • go-lark only supports Custom App. Marketplace App is not supported yet.
  • go-lark implements bot and messaging API, other APIs such as Lark Doc, Calendar and so so are not supported.
  • go-lark implements API in v3/v4 version* (official documents may also mention im/v1 version) and event with Schema 1.0.
Switch to Lark Endpoints

The default API endpoints are for Feishu, in order to switch to Lark, we should use SetDomain:

bot := lark.NewChatBot("<App ID>", "<App Secret>")
bot.SetDomain(lark.DomainLark)

Usage

Auth

Auto-renewable authentication:

// initialize a chat bot with appID and appSecret
bot := lark.NewChatBot(appID, appSecret)
// Renew access token periodically
bot.StartHeartbeat()
// Stop renewal
bot.StopHeartbeat()

Single-pass authentication:

bot := lark.NewChatBot(appID, appSecret)
resp, err := bot.GetTenantAccessTokenInternal(true)
// and we can now access the token value with `bot.tenantAccessToken()`

Example: examples/auth

Messaging

For Chat Bot, we can send simple messages with the following method:

  • PostText
  • PostTextMention
  • PostTextMentionAll
  • PostImage
  • PostShareChatCard

Basic message examples: examples/basic-message

To build rich messages, we may use Message Buffer (or simply MsgBuffer), which builds message conveniently with chaining methods.

Examples

Apart from the general auth and messaging chapter, there are comprehensive examples for almost all APIs. Here is a collection of ready-to-run examples for each part of go-lark:

Message Buffer

We can build message body with MsgBuffer and send with PostMessage, which supports the following message types:

  • MsgText: Text
  • MsgPost: Rich Text
  • MsgImage: Image
  • MsgShareCard: Group Share Card
  • MsgInteractive: Interactive Card

MsgBuffer provides binding functions and content functions.

Binding functions:

Function Usage Comment
BindChatID Bind a chat ID Either OpenID, UserID, Email or ChatID should be present
BindOpenID Bind a user open ID
BindUserID Bind a user ID
BindEmail Bind a user email
BindReply Bind a reply ID Required when reply other message

Content functions pair with message content types. If it mismatched, it would not have sent successfully. Content functions:

Function Message Type Usage Comment
Text MsgText Append plain text May build with TextBuilder
Post MsgPost Append rich text May build with PostBuilder
Image MsgImage Append image Required to upload to Lark server in advance
ShareChat MsgShareCard Append group share card
Card MsgInteractive Append interactive card May build with CardBuilder, see Declarative card builder
Error Handling

Each go-lark API function returns response and err. err is the error from HTTP client, when it was not nil, HTTP might have gone wrong.

While response is HTTP response from Lark API server, in which Code and Ok represent whether it succeeds. The meaning of Code is defined here.

Event

Lark provides a number of events and they are in two different schema (1.0/2.0). go-lark now only implements two of them in schema 1.0, which are needed for interacting between bot and Lark server:

  • URL Challenge
  • Receiving Messages

We recommend Gin middleware to handle these events.

Gin Middleware

Example: examples/gin-middleware

URL Challenge
r := gin.Default()
middleware := larkgin.NewLarkMiddleware()
middleware.BindURLPrefix("/handle") // supposed URL is http://your.domain.com/handle
r.Use(middleware.LarkChallengeHandler())
Receiving Message
r := gin.Default()
middleware := larkgin.NewLarkMiddleware()
middleware.BindURLPrefix("/handle") // supposed URL is http://your.domain.com/handle
r.POST("/handle", func(c *gin.Context) {
    if msg, ok := middleware.GetMessage(c); ok && msg != nil {
        text := msg.Event.Text
        // your awesome logic
    }
})
Security & Encryption

Lark Open Platform offers AES encryption and token verification to ensure security for events.

  • AES Encryption: when switch on, all traffic will be encrypted with AES.
  • Token Verification: simple token verification for incoming messages.

We recommend you to enable token verification. If HTTPS is not available on your host, then enable AES encryption.

middleware.WithTokenVerfication("<verification-token>")
middleware.WithEncryption("<encryption-key>")
Debugging

Lark does not provide messaging API debugger officially. Thus, we have to debug with real Lark conversation. We add PostEvent to simulate message sending to make it easier. PostEvent can also be used to redirect message, which acts like a reverse proxy.

Example: examples/event-forward

Notice: PostEvent does not support AES encryption at the moment.

Extensions

go-lark's dev utilities (authentication, HTTP handling, and etc.) are capable for easily implementing most of APIs provided by Lark Open Platform. And we may use that as an extension for go-lark.

Here is an example that implementing a Lark Doc API with go-lark:

package lark

import "github.com/go-lark/lark"

const copyFileAPIPattern = "/open-apis/drive/explorer/v2/file/copy/files/%s"

// CopyFileResponse .
type CopyFileResponse struct {
	lark.BaseResponse

	Data CopyFileData `json:"data"`
}

// CopyFileData .
type CopyFileData struct {
	FolderToken string `json:"folderToken"`
	Revision    int64  `json:"revision"`
	Token       string `json:"token"`
	Type        string `json:"type"`
	URL         string `json:"url"`
}

// CopyFile implementation
func CopyFile(bot *lark.Bot, fileToken, dstFolderToken, dstName string) (*CopyFileResponse, error) {
	var respData model.CopyFileResponse
	err := bot.PostAPIRequest(
		"CopyFile",
		fmt.Sprintf(copyFileAPIPattern, fileToken),
		true,
		map[string]interface{}{
			"type":             "doc",
			"dstFolderToken":   dstFolderToken,
			"dstName":          dstName,
			"permissionNeeded": true,
			"CommentNeeded":    false,
		},
		&respData,
	)
	return &respData, err
}

Compatibility

go-lark is based on Lark API v3 and v4. The compatibility of each API depends on actual implementation. Compatibility table:

API scope Compatibility Migration
auth N/A Lark does not offer v4
messaging v4 only
interactive card v4 only
bot N/A Lark does not offer v4
group partial v3 & v4 WIP

FAQ

  • I got 99991401 when sending messages
    • remove IP Whitelist from dashboard
  • My bot failed sending messages
    1. check authentication.
    2. not invite to the group.
    3. API permission not applied.
  • Does go-lark support interactive message card?
    • It can send but no card builder provided. You may need to build it manually and send with go-lark.

Contributing

  • If you think you've found a bug with go-lark, please file an issue.
  • Pull Request is welcomed.

License

Copyright (c) David Zhang, 2018-2021. Licensed under MIT License.

Documentation

Index

Constants

View Source 
const (
	// ChatBot should call NewChatBot
	// Create from https://open.feishu.cn/ or https://open.larksuite.com/
	ChatBot = iota
	// NotificationBot for webhook, behave as a simpler notification bot
	// Create from Lark group
	NotificationBot
)
View Source 
const (
	DomainFeishu = "https://open.feishu.cn"
	DomainLark   = "https://open.larksuite.com"
)

Domains

View Source 
const (
	LocaleZhCN = "zh_cn"
	LocaleEnUS = "en_us"
	LocaleJaJP = "ja_jp"
)

Supported Lark locales

View Source 
const (
	LogLevelTrace = iota + 1
	LogLevelDebug
	LogLevelInfo
	LogLevelWarn
	LogLevelError
)

LogLevels

View Source 
const (
	// EventGetMessage .
	EventGetMessage = 1
)

See https://open.feishu.cn/document/uYjL24iN/uUTNz4SN1MjL1UzM

Variables

View Source 
var (
	ErrBotTypeError           = errors.New("Bot type error")
	ErrParamUserID            = errors.New("Param error: UserID")
	ErrMessageTypeNotSuppored = errors.New("Message type not supported")
	ErrEncryptionNotEnabled   = errors.New("Encryption is not enabled")
	ErrCustomHTTPClientNotSet = errors.New("Custom HTTP client not set")
)

Errors

Functions

func BuildOutcomingMessageReq 

func BuildOutcomingMessageReq(om OutcomingMessage) map[string]interface{}

BuildOutcomingMessageReq for msg builder

func Decrypt 

func Decrypt(encryptedKey []byte, data string) ([]byte, error)

Decrypt with AES Cipher

func DownloadFile 

func DownloadFile(path, url string) error

DownloadFile downloads from a URL to local path

func EncryptKey 

func EncryptKey(key string) []byte

EncryptKey .

func PostEvent 

func PostEvent(client *http.Client, hookURL string, message EventMessage) (*http.Response, error)

PostEvent posts event 1. help to develop and test ServeEvent callback func much easier 2. otherwise, you may use it to forward event

Types

type AddBotToGroupResponse 

type AddBotToGroupResponse = BaseResponse

AddBotToGroupResponse .

type AddGroupMemberResponse 

type AddGroupMemberResponse struct {
	BaseResponse
	InvalidOpenID []string `json:"invalid_open_ids"`
}

AddGroupMemberResponse .

type AuthTokenInternalResponse 

type AuthTokenInternalResponse struct {
	BaseResponse
	AppAccessToken string `json:"app_access_token"`
	Expire         int    `json:"expire"`
}

AuthTokenInternalResponse .

type BaseResponse added in v1.6.0 

type BaseResponse struct {
	Code int    `json:"code"`
	Msg  string `json:"msg"`
}

BaseResponse of an API

type Bot 

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

Bot definition

func NewChatBot 

func NewChatBot(appID, appSecret string) *Bot

NewChatBot with appID and appSecret

func NewNotificationBot 

func NewNotificationBot(hookURL string) *Bot

NewNotificationBot with URL

func (Bot) AccessToken 

func (bot Bot) AccessToken() string

AccessToken returns bot.accessToken for external use

func (*Bot) AddBotToGroup 

func (bot *Bot) AddBotToGroup(openChatID string) (*AddBotToGroupResponse, error)

AddBotToGroup .

func (*Bot) AddGroupMember 

func (bot *Bot) AddGroupMember(openChatID string, openID []string) (*AddGroupMemberResponse, error)

AddGroupMember adds a group member

func (*Bot) AddGroupMemberByUserID 

func (bot *Bot) AddGroupMemberByUserID(openChatID string, userID []string) (*AddGroupMemberResponse, error)

AddGroupMemberByUserID adds a group member

func (Bot) AppID 

func (bot Bot) AppID() string

AppID returns bot.appID for external use

func (Bot) BotType 

func (bot Bot) BotType() int

BotType returns bot.botType for external use

func (*Bot) CreateGroup 

func (bot *Bot) CreateGroup(name, description string, openID []string) (*CreateGroupResponse, error)

CreateGroup creates a group

func (*Bot) DeleteEphemeralMessage added in v1.6.0 

func (bot *Bot) DeleteEphemeralMessage(messageID string) (*DeleteEphemeralMessageResponse, error)

DeleteEphemeralMessage deletes an ephemeral message

func (*Bot) DeleteGroupMember 

func (bot *Bot) DeleteGroupMember(openChatID string, openID []string) (*DeleteGroupMemberResponse, error)

DeleteGroupMember deletes a group member

func (*Bot) DisbandGroup 

func (bot *Bot) DisbandGroup(openChatID string) (*DisbandGroupResponse, error)

DisbandGroup .

func (Bot) DoAPIRequest added in v1.2.0 

func (bot Bot) DoAPIRequest(
	method string,
	prefix, urlPath string,
	header http.Header, auth bool,
	body io.Reader,
	output interface{}) error

DoAPIRequest builds http request

func (Bot) Domain added in v1.4.2 

func (bot Bot) Domain() string

Domain returns current domain

func (Bot) ExpandURL added in v1.1.0 

func (bot Bot) ExpandURL(urlPath string) string

ExpandURL expands url path to full url

func (*Bot) GetAccessTokenInternal 

func (bot *Bot) GetAccessTokenInternal(updateToken bool) (*AuthTokenInternalResponse, error)

GetAccessTokenInternal gets AppAccessToken for internal use

func (*Bot) GetBotInfo 

func (bot *Bot) GetBotInfo() (*GetBotInfoResponse, error)

GetBotInfo returns bot info

func (*Bot) GetGroupInfo 

func (bot *Bot) GetGroupInfo(openChatID string) (*GroupInfoResponse, error)

GetGroupInfo returns group info

func (*Bot) GetGroupList 

func (bot *Bot) GetGroupList(pageNum, pageSize int) (*GroupListResponse, error)

GetGroupList returns group list

func (*Bot) GetTenantAccessTokenInternal 

func (bot *Bot) GetTenantAccessTokenInternal(updateToken bool) (*TenantAuthTokenInternalResponse, error)

GetTenantAccessTokenInternal gets AppAccessToken for internal use

func (Bot) Logger added in v1.1.0 

func (bot Bot) Logger() LogWrapper

Logger returns current logger

func (*Bot) MessageReadReceipt 

func (bot *Bot) MessageReadReceipt(messageID string) (*MessageReceiptResponse, error)

MessageReadReceipt queries message read receipt

func (Bot) PostAPIRequest 

func (bot Bot) PostAPIRequest(prefix, urlPath string, auth bool, params interface{}, output interface{}) error

PostAPIRequest call Lark API

func (*Bot) PostEphemeralMessage added in v1.6.0 

func (bot *Bot) PostEphemeralMessage(om OutcomingMessage) (*PostEphemeralMessageResponse, error)

PostEphemeralMessage posts an ephemeral message

func (*Bot) PostImage 

func (bot *Bot) PostImage(imageKey string, userID *OptionalUserID) (*PostMessageResponse, error)

PostImage is a simple way to send image

func (*Bot) PostMessage 

func (bot *Bot) PostMessage(om OutcomingMessage) (*PostMessageResponse, error)

PostMessage posts message

func (*Bot) PostNotification 

func (bot *Bot) PostNotification(title, text string) (*PostNotificationResp, error)

PostNotification send message to a webhook

func (*Bot) PostNotificationV2 

func (bot *Bot) PostNotificationV2(om OutcomingMessage) (*PostNotificationV2Resp, error)

PostNotificationV2 support v2 format

func (*Bot) PostRichText 

func (bot *Bot) PostRichText(postContent *PostContent, userID *OptionalUserID) (*PostMessageResponse, error)

PostRichText is a simple way to send rich text messages

func (*Bot) PostShareChat 

func (bot *Bot) PostShareChat(openChatID string, userID *OptionalUserID) (*PostMessageResponse, error)

PostShareChat is a simple way to share chat

func (*Bot) PostText 

func (bot *Bot) PostText(text string, userID *OptionalUserID) (*PostMessageResponse, error)

PostText is a simple way to send text messages

func (*Bot) PostTextMention 

func (bot *Bot) PostTextMention(text string, atUserID string, userID *OptionalUserID) (*PostMessageResponse, error)

PostTextMention is a simple way to send text messages with @user

func (*Bot) PostTextMentionAll 

func (bot *Bot) PostTextMentionAll(text string, userID *OptionalUserID) (*PostMessageResponse, error)

PostTextMentionAll is a simple way to send text messages with @all

func (*Bot) PostTextMentionAndReply 

func (bot *Bot) PostTextMentionAndReply(text string, atUserID string, userID *OptionalUserID, replyID string) (*PostMessageResponse, error)

PostTextMentionAndReply is a simple way to send text messages with @user and reply a message

func (*Bot) RecallMessage 

func (bot *Bot) RecallMessage(messageID string) (*RecallMessageResponse, error)

RecallMessage recalls a message with ID

func (*Bot) RemoveBotFromGroup 

func (bot *Bot) RemoveBotFromGroup(openChatID string) (*RemoveBotFromGroupResponse, error)

RemoveBotFromGroup .

func (*Bot) SetClient 

func (bot *Bot) SetClient(c *http.Client)

SetClient assigns a new client to bot.client

func (*Bot) SetCustomClient added in v1.2.0 

func (bot *Bot) SetCustomClient(c HTTPWrapper)

SetCustomClient .

func (*Bot) SetDomain 

func (bot *Bot) SetDomain(domain string)

SetDomain set domain of endpoint, so we could call Feishu/Lark go-lark does not check your host, just use the right one or fail.

func (*Bot) SetLogger 

func (bot *Bot) SetLogger(logger LogWrapper)

SetLogger set a new logger

func (*Bot) StartHeartbeat 

func (bot *Bot) StartHeartbeat()

StartHeartbeat renew auth token periodically

func (*Bot) StopHeartbeat 

func (bot *Bot) StopHeartbeat()

StopHeartbeat stop auto-renew

func (Bot) TenantAccessToken 

func (bot Bot) TenantAccessToken() string

TenantAccessToken returns bot.tenantAccessToken for external use

func (*Bot) UnsetCustomClient added in v1.2.0 

func (bot *Bot) UnsetCustomClient()

UnsetCustomClient .

func (*Bot) UpdateGroupInfo 

func (bot *Bot) UpdateGroupInfo(params *UpdateGroupInfoReq) (*UpdateGroupInfoResponse, error)

UpdateGroupInfo update lark group info

func (*Bot) UploadImage 

func (bot *Bot) UploadImage(path string) (*UploadImageResponse, error)

UploadImage uploads image to Lark server

func (*Bot) UploadImageObject 

func (bot *Bot) UploadImageObject(img image.Image) (*UploadImageResponse, error)

UploadImageObject uploads image to Lark server

func (*Bot) WithContext added in v1.4.0 

func (bot *Bot) WithContext(ctx context.Context) *Bot

WithContext .

type CardBlock added in v1.5.0 

type CardBlock = card.Block

CardBlock 卡片元素

type CardBuilder added in v1.5.0 

type CardBuilder interface {
	Card(elements ...card.Element) *CardBlock
	Action(actions ...card.Element) *card.ActionBlock
	Button(text *card.TextBlock) *card.ButtonBlock
	Confirm(title, text string) *card.ConfirmBlock
	DatePicker() *card.DatePickerBlock
	TimePicker() *card.TimePickerBlock
	DatetimePicker() *card.DatetimePickerBlock
	Div(fields ...*card.FieldBlock) *card.DivBlock
	Field(text *card.TextBlock) *card.FieldBlock
	Hr() *card.HrBlock
	Img(key string) *card.ImgBlock
	Note() *card.NoteBlock
	Option(value string) *card.OptionBlock
	Overflow(options ...*card.OptionBlock) *card.OverflowBlock
	SelectMenu(options ...*card.OptionBlock) *card.SelectMenuBlock
	Text(s string) *card.TextBlock
	Markdown(s string) *card.MarkdownBlock
	URL() *card.URLBlock
}

CardBuilder 卡片构造方法

func NewCardBuilder added in v1.5.0 

func NewCardBuilder() CardBuilder

NewCardBuilder 新建卡片构造器

type CardContent 

type CardContent *map[string]interface{}

CardContent struct of card content

type CreateGroupResponse 

type CreateGroupResponse struct {
	BaseResponse
	OpenChatID    string   `json:"open_chat_id"`
	InvalidOpenID []string `json:"invalid_open_ids"`
}

CreateGroupResponse .

type DeleteEphemeralMessageResponse added in v1.6.0 

type DeleteEphemeralMessageResponse = BaseResponse

DeleteEphemeralMessageResponse .

type DeleteGroupMemberResponse 

type DeleteGroupMemberResponse AddGroupMemberResponse

DeleteGroupMemberResponse .

type DisbandGroupResponse 

type DisbandGroupResponse = BaseResponse

DisbandGroupResponse .

type EncryptedReq 

type EncryptedReq struct {
	Encrypt string `json:"encrypt,omitempty"`
}

EncryptedReq request of encrypted challagen

type EventBody 

type EventBody struct {
	Type          string `json:"type"`
	AppID         string `json:"app_id"`
	TenantKey     string `json:"tenant_key"`
	ChatType      string `json:"chat_type"`
	MsgType       string `json:"msg_type"`
	RootID        string `json:"root_id,omitempty"`
	ParentID      string `json:"parent_id,omitempty"`
	OpenID        string `json:"open_id,omitempty"`
	OpenChatID    string `json:"open_chat_id,omitempty"`
	OpenMessageID string `json:"open_message_id,omitempty"`
	IsMention     bool   `json:"is_mention,omitempty"`
	Title         string `json:"title,omitempty"`
	Text          string `json:"text,omitempty"`
	RealText      string `json:"text_without_at_bot,omitempty"`
	ImageKey      string `json:"image_key,omitempty"`
	ImageURL      string `json:"image_url,omitempty"`
	FileKey       string `json:"file_key,omitempty"`
}

EventBody .

type EventChallengeReq 

type EventChallengeReq struct {
	Token     string `json:"token,omitempty"`
	Challenge string `json:"challenge,omitempty"`
	Type      string `json:"type,omitempty"`
}

EventChallengeReq request of add event hook

type EventMessage 

type EventMessage struct {
	UUID      string `json:"uuid"`
	Timestamp string `json:"ts"`
	// Token is shown by Lark to indicate it is not a fake message, check at your own need
	Token     string    `json:"token"`
	EventType string    `json:"type"`
	Event     EventBody `json:"event"`
}

EventMessage .

type GetBotInfoResponse 

type GetBotInfoResponse struct {
	BaseResponse
	Bot struct {
		ActivateStatus int      `json:"activate_status"`
		AppName        string   `json:"app_name"`
		AvatarURL      string   `json:"avatar_url"`
		IPWhiteList    []string `json:"ip_white_list"`
		OpenID         string   `json:"open_id"`
	} `json:"bot"`
}

GetBotInfoResponse .

type GroupInfoResponse 

type GroupInfoResponse struct {
	BaseResponse
	Data struct {
		AddMemberVerify        bool   `json:"add_member_verify"`
		Avatar                 string `json:"avatar"`
		ChatID                 string `json:"chat_id"`
		Description            string `json:"description"`
		GroupEmailEnabled      bool   `json:"group_email_enabled"`
		JoinMessageVisibility  string `json:"join_message_visibility"`
		LeaveMessageVisibility string `json:"leave_message_visibility"`
		Members                []struct {
			OpenID string `json:"open_id"`
		} `json:"members"`
		Name                     string `json:"name"`
		OnlyOwnerAdd             bool   `json:"only_owner_add"`
		OnlyOwnerAtAll           bool   `json:"only_owner_at_all"`
		OnlyOwnerEdit            bool   `json:"only_owner_edit"`
		OwnerOpenID              string `json:"owner_open_id"`
		SendGroupEmailPermission string `json:"send_group_email_permission"`
		SendMessagePermission    string `json:"send_message_permission"`
		ShareAllowed             bool   `json:"share_allowed"`
		Type                     string `json:"type"`
	} `json:"data"`
}

GroupInfoResponse .

type GroupListResponse 

type GroupListResponse struct {
	BaseResponse
	HasMore bool `json:"has_more"`
	Chats   []struct {
		ID      string `json:"id"`
		Name    string `json:"name"`
		OwnerID string `json:"owner_id"`
	} `json:"chats"`
}

GroupListResponse .

type HTTPWrapper added in v1.2.0 

type HTTPWrapper interface {
	Do(
		ctx context.Context,
		method, url string,
		header http.Header,
		body io.Reader) (io.ReadCloser, error)
}

HTTPWrapper is a wrapper interface, which enables extension on HTTP part. Typicall, we do not need this because default client is sufficient.

type LogLevel added in v1.3.0 

type LogLevel int

LogLevel defs

func (LogLevel) String added in v1.3.0 

func (ll LogLevel) String() string

String .

type LogWrapper added in v1.3.0 

type LogWrapper interface {
	// for log print
	Log(context.Context, LogLevel, string)
	// for test redirection
	SetOutput(io.Writer)
}

LogWrapper interface

type MessageContent 

type MessageContent struct {
	Text      *string      `json:"text,omitempty"`
	ImageKey  *string      `json:"image_key,omitempty"`
	ShareChat *string      `json:"share_open_chat_id,omitempty"`
	Post      *PostContent `json:"post,omitempty"`
}

MessageContent struct of message content

type MessageReceiptResponse 

type MessageReceiptResponse struct {
	BaseResponse
	Data struct {
		ReadUsers []struct {
			OpenID    string `json:"open_id"`
			UserID    string `json:"user_id"`
			Timestamp string `json:"timestamp"`
		} `json:"read_users"`
	} `json:"data"`
}

MessageReceiptResponse .

type MessageType 

type MessageType string

MessageType message type 

const (
	// MsgText simple text message
	MsgText MessageType = "text"
	// MsgPost rich text message
	MsgPost MessageType = "post"
	// MsgImage simple image message
	MsgImage MessageType = "image"
	// MsgShareCard share chat group card
	MsgShareCard MessageType = "share_chat"
	// MsgInteractive interactive widget
	MsgInteractive MessageType = "interactive"
)

type MsgBuffer 

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

MsgBuffer stores all the messages attached You can call every function, but some of which is only available for specific condition

func NewMsgBuffer 

func NewMsgBuffer(newMsgType MessageType) *MsgBuffer

NewMsgBuffer create a message buffer

func (*MsgBuffer) BindChatID 

func (m *MsgBuffer) BindChatID(chatID string) *MsgBuffer

BindChatID binds chat_id

func (*MsgBuffer) BindEmail 

func (m *MsgBuffer) BindEmail(email string) *MsgBuffer

BindEmail binds email

func (*MsgBuffer) BindOpenChatID 

func (m *MsgBuffer) BindOpenChatID(openChatID string) *MsgBuffer

BindOpenChatID binds open_chat_id

func (*MsgBuffer) BindOpenID 

func (m *MsgBuffer) BindOpenID(openID string) *MsgBuffer

BindOpenID binds open_id

func (*MsgBuffer) BindReply 

func (m *MsgBuffer) BindReply(rootID string) *MsgBuffer

BindReply binds root id for reply rootID is OpenMessageID of the message you reply

func (*MsgBuffer) BindUserID 

func (m *MsgBuffer) BindUserID(userID string) *MsgBuffer

BindUserID binds open_id

func (*MsgBuffer) Build 

func (m *MsgBuffer) Build() OutcomingMessage

Build message and return message body

func (*MsgBuffer) Card 

func (m *MsgBuffer) Card(cardContent string) *MsgBuffer

Card binds card content with V4 format

func (*MsgBuffer) Clear 

func (m *MsgBuffer) Clear() *MsgBuffer

Clear message in buffer

func (*MsgBuffer) Error added in v1.3.0 

func (m *MsgBuffer) Error() error

Error returns last error

func (*MsgBuffer) Image 

func (m *MsgBuffer) Image(imageKey string) *MsgBuffer

Image attaches image key for MsgImage only

func (*MsgBuffer) Post 

func (m *MsgBuffer) Post(postContent *PostContent) *MsgBuffer

Post sets raw post content

func (*MsgBuffer) ShareChat 

func (m *MsgBuffer) ShareChat(chatID string) *MsgBuffer

ShareChat attaches chat id for MsgShareChat only

func (*MsgBuffer) Text 

func (m *MsgBuffer) Text(text string) *MsgBuffer

Text attaches text

func (*MsgBuffer) UpdateMulti 

func (m *MsgBuffer) UpdateMulti(flag bool) *MsgBuffer

UpdateMulti set multi, shared card default false, not share

type MsgPostBuilder 

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

MsgPostBuilder for build text buf

func NewPostBuilder 

func NewPostBuilder() *MsgPostBuilder

NewPostBuilder creates a text builder

func (*MsgPostBuilder) AtTag 

func (pb *MsgPostBuilder) AtTag(text, userID string) *MsgPostBuilder

AtTag creates an at tag

func (*MsgPostBuilder) Clear 

func (pb *MsgPostBuilder) Clear()

Clear all message

func (*MsgPostBuilder) CurLocale added in v1.1.0 

func (pb *MsgPostBuilder) CurLocale() *PostBuf

CurLocale switches to locale and returns the buffer of that locale

func (*MsgPostBuilder) ImageTag 

func (pb *MsgPostBuilder) ImageTag(imageKey string, imageWidth, imageHeight int) *MsgPostBuilder

ImageTag creates an image tag

func (MsgPostBuilder) Len 

func (pb MsgPostBuilder) Len() int

Len returns buf len

func (*MsgPostBuilder) LinkTag 

func (pb *MsgPostBuilder) LinkTag(text, href string) *MsgPostBuilder

LinkTag creates a link tag

func (*MsgPostBuilder) Locale 

func (pb *MsgPostBuilder) Locale(locale string) *MsgPostBuilder

Locale renamed to WithLocale but still available

func (*MsgPostBuilder) Render 

func (pb *MsgPostBuilder) Render() *PostContent

Render message

func (*MsgPostBuilder) TextTag 

func (pb *MsgPostBuilder) TextTag(text string, lines int, unescape bool) *MsgPostBuilder

TextTag creates a text tag

func (*MsgPostBuilder) Title 

func (pb *MsgPostBuilder) Title(title string) *MsgPostBuilder

Title sets title

func (*MsgPostBuilder) WithLocale added in v1.1.0 

func (pb *MsgPostBuilder) WithLocale(locale string) *MsgPostBuilder

WithLocale switches to locale and returns self

type MsgTextBuilder 

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

MsgTextBuilder for build text buf

func NewTextBuilder 

func NewTextBuilder() *MsgTextBuilder

NewTextBuilder creates a text builder

func (*MsgTextBuilder) Clear 

func (tb *MsgTextBuilder) Clear()

Clear all message

func (MsgTextBuilder) Len 

func (tb MsgTextBuilder) Len() int

Len returns buf len

func (*MsgTextBuilder) Mention 

func (tb *MsgTextBuilder) Mention(userID string) *MsgTextBuilder

Mention @somebody

func (*MsgTextBuilder) MentionAll 

func (tb *MsgTextBuilder) MentionAll() *MsgTextBuilder

MentionAll @all

func (*MsgTextBuilder) Render 

func (tb *MsgTextBuilder) Render() string

Render message

func (*MsgTextBuilder) Text 

func (tb *MsgTextBuilder) Text(text ...interface{}) *MsgTextBuilder

Text add simple texts

func (*MsgTextBuilder) Textf 

func (tb *MsgTextBuilder) Textf(textFmt string, text ...interface{}) *MsgTextBuilder

Textf add texts with format

func (*MsgTextBuilder) Textln 

func (tb *MsgTextBuilder) Textln(text ...interface{}) *MsgTextBuilder

Textln add simple texts with a newline

type OptionalUserID 

type OptionalUserID struct {
	IDType string
	RealID string
}

OptionalUserID to contain openID, chatID, userID, email

func WithChatID 

func WithChatID(chatID string) *OptionalUserID

WithChatID uses chatID as userID

func WithEmail 

func WithEmail(email string) *OptionalUserID

WithEmail uses email as userID

func WithOpenID 

func WithOpenID(openID string) *OptionalUserID

WithOpenID uses openID as userID

func WithUserID 

func WithUserID(userID string) *OptionalUserID

WithUserID uses userID as userID

type OutcomingMessage 

type OutcomingMessage struct {
	MsgType MessageType `json:"msg_type"`
	// ID for user
	OpenID *string `json:"open_id,omitempty"`
	Email  *string `json:"email,omitempty"`
	UserID *string `json:"user_id,omitempty"`
	ChatID *string `json:"chat_id,omitempty"`
	// For reply
	RootID *string `json:"root_id,omitempty"`
	// Content
	Content MessageContent `json:"content"`
	Card    CardContent    `json:"card"`
	// UpdateMulti card
	UpdateMulti bool `json:"update_multi"`
}

OutcomingMessage struct of an outcoming message

type PostBody 

type PostBody struct {
	Title   string       `json:"title"`
	Content [][]PostElem `json:"content"`
}

PostBody .

type PostBuf added in v1.1.0 

type PostBuf struct {
	Title   string     `json:"title"`
	Content []PostElem `json:"content"`
}

PostBuf .

type PostContent 

type PostContent map[string]PostBody

PostContent .

type PostElem 

type PostElem struct {
	Tag string `json:"tag"`
	// For Text
	UnEscape *bool   `json:"un_escape,omitempty"`
	Text     *string `json:"text,omitempty"`
	Lines    *int    `json:"lines,omitempty"`
	// For Link
	Href *string `json:"href,omitempty"`
	// For At
	UserID *string `json:"user_id,omitempty"`
	// For Image
	ImageKey    *string `json:"image_key,omitempty"`
	ImageWidth  *int    `json:"width,omitempty"`
	ImageHeight *int    `json:"height,omitempty"`
}

PostElem .

type PostEphemeralMessageResponse added in v1.6.0 

type PostEphemeralMessageResponse = PostMessageResponse

PostEphemeralMessageResponse .

type PostMessageResponse 

type PostMessageResponse struct {
	BaseResponse
	Data struct {
		MessageID string `json:"message_id"`
	} `json:"data"`
}

PostMessageResponse .

type PostNotificationResp 

type PostNotificationResp struct {
	Ok bool `json:"ok,omitempty"`
}

PostNotificationResp response of PostNotification

type PostNotificationV2Resp 

type PostNotificationV2Resp struct {
	StatusCode    int    `json:"StatusCode"`
	StatusMessage string `json:"StatusMessage"`
}

PostNotificationV2Resp response of PostNotificationV2

type RecallMessageResponse 

type RecallMessageResponse = BaseResponse

RecallMessageResponse .

type RemoveBotFromGroupResponse 

type RemoveBotFromGroupResponse = BaseResponse

RemoveBotFromGroupResponse .

type TenantAuthTokenInternalResponse 

type TenantAuthTokenInternalResponse struct {
	BaseResponse
	TenantAppAccessToken string `json:"tenant_access_token"`
	Expire               int    `json:"expire"`
}

TenantAuthTokenInternalResponse .

type UpdateGroupInfoReq 

type UpdateGroupInfoReq struct {
	OpenChatID      string            `json:"open_chat_id"`
	OwnerID         string            `json:"owner_id,omitempty"`
	OwnerEmployeeID string            `json:"owner_employee_id,omitempty"`
	Name            string            `json:"name,omitempty"`
	I18nNames       map[string]string `json:"i18n_names,omitempty"`
}

UpdateGroupInfoReq .

type UpdateGroupInfoResponse 

type UpdateGroupInfoResponse struct {
	BaseResponse
	OpenChatID string `json:"open_chat_id"`
}

UpdateGroupInfoResponse .

type UploadImageResponse 

type UploadImageResponse struct {
	BaseResponse
	Data struct {
		ImageKey string `json:"image_key"`
	} `json:"data"`
}

UploadImageResponse .

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.