lark

package module
v3.5.3 Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2026 License: MIT Imports: 62 Imported by: 216

README

飞书开放接口SDK/Feishu OpenPlatform Server SDK

旨在让开发者便捷的调用飞书开放API、处理订阅的事件、处理服务端推送的卡片行为等。

Feishu Open Platform offers a series of server-side atomic APIs to achieve diverse functionalities. However, actual coding requires additional work, such as obtaining and maintaining access tokens, encrypting and decrypting data, and verifying request signatures. Furthermore, the lack of semantic descriptions for function calls and type system support can increase coding burdens.

To address these issues, Feishu Open Platform has developed the Open Interface SDK, which incorporates all lengthy logic processes, provides a comprehensive type system, and offers a semantic programming interface to enhance the coding experience.

介绍文档 Introduction Documents

扩展示例

我们还基于 SDK 封装了常用的 API 组合调用及业务场景示例，如：

更多示例可参考：https://github.com/larksuite/oapi-sdk-go-demo

加入交流互助群

单击加入交流互助

License

使用 MIT

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var FeishuBaseUrl = "https://open.feishu.cn"
View Source 
var LarkBaseUrl = "https://open.larksuite.com"

Functions

This section is empty.

Types

type Client 

type Client struct {
	Acs                    *acs.Service
	Cardkit                *cardkit.Service
	Performance            *performance.Service
	Compensation           *compensation.Service
	Wiki                   *wiki.Service
	Minutes                *minutes.Service
	Sheets                 *sheets.Service
	Task                   *task.Service
	Directory              *directory.Service
	Event                  *event.Service
	Payroll                *payroll.Service
	Vc                     *vc.Service
	Calendar               *calendar.Service
	Mdm                    *mdm.Service
	HumanAuthentication    *human_authentication.Service
	MeetingRoom            *meeting_room.Service
	Attendance             *attendance.Service
	Baike                  *baike.Service
	Contact                *contact.Service
	DocumentAi             *document_ai.Service
	SpeechToText           *speech_to_text.Service
	Auth                   *auth.Service
	Base                   *base.Service
	OpticalCharRecognition *optical_char_recognition.Service
	Authen                 *authen.Service
	Corehr                 *corehr.Service
	Drive                  *drive.Service
	Admin                  *admin.Service
	Apaas                  *apaas.Service
	Report                 *report.Service
	Board                  *board.Service
	Ehr                    *ehr.Service
	Im                     *im.Service
	Passport               *passport.Service
	Approval               *approval.Service
	Hire                   *hire.Service
	Okr                    *okr.Service
	Lingo                  *lingo.Service
	Aily                   *aily.Service
	Docs                   *docs.Service
	Verification           *verification.Service
	Application            *application.Service
	Moments                *moments.Service
	Docx                   *docx.Service
	Mail                   *mail.Service
	Search                 *search.Service
	SecurityAndCompliance  *security_and_compliance.Service
	Tenant                 *tenant.Service
	PersonalSettings       *personal_settings.Service
	Helpdesk               *helpdesk.Service
	Translation            *translation.Service
	Workplace              *workplace.Service
	Bitable                *bitable.Service
	Block                  *block.Service
	Ext                    *larkext.ExtService
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(appId, appSecret string, options ...ClientOptionFunc) *Client

func (*Client) Delete 

func (cli *Client) Delete(ctx context.Context, httpPath string, body interface{}, accessTokeType larkcore.AccessTokenType, options ...larkcore.RequestOptionFunc) (*larkcore.ApiResp, error)

func (*Client) Do added in v3.0.1 

func (cli *Client) Do(ctx context.Context, apiReq *larkcore.ApiReq, options ...larkcore.RequestOptionFunc) (*larkcore.ApiResp, error)

func (*Client) Get 

func (cli *Client) Get(ctx context.Context, httpPath string, body interface{}, accessTokeType larkcore.AccessTokenType, options ...larkcore.RequestOptionFunc) (*larkcore.ApiResp, error)

func (*Client) GetAppAccessTokenByMarketplaceApp added in v3.0.1 

func (cli *Client) GetAppAccessTokenByMarketplaceApp(ctx context.Context, req *larkcore.MarketplaceAppAccessTokenReq) (*larkcore.AppAccessTokenResp, error)

func (*Client) GetAppAccessTokenBySelfBuiltApp added in v3.0.1 

func (cli *Client) GetAppAccessTokenBySelfBuiltApp(ctx context.Context, req *larkcore.SelfBuiltAppAccessTokenReq) (*larkcore.AppAccessTokenResp, error)

func (*Client) GetTenantAccessTokenByMarketplaceApp added in v3.0.1 

func (cli *Client) GetTenantAccessTokenByMarketplaceApp(ctx context.Context, req *larkcore.MarketplaceTenantAccessTokenReq) (*larkcore.TenantAccessTokenResp, error)

func (*Client) GetTenantAccessTokenBySelfBuiltApp added in v3.0.1 

func (cli *Client) GetTenantAccessTokenBySelfBuiltApp(ctx context.Context, req *larkcore.SelfBuiltTenantAccessTokenReq) (*larkcore.TenantAccessTokenResp, error)

func (*Client) Patch 

func (cli *Client) Patch(ctx context.Context, httpPath string, body interface{}, accessTokeType larkcore.AccessTokenType, options ...larkcore.RequestOptionFunc) (*larkcore.ApiResp, error)

func (*Client) Post 

func (cli *Client) Post(ctx context.Context, httpPath string, body interface{}, accessTokeType larkcore.AccessTokenType, options ...larkcore.RequestOptionFunc) (*larkcore.ApiResp, error)

func (*Client) Put 

func (cli *Client) Put(ctx context.Context, httpPath string, body interface{}, accessTokeType larkcore.AccessTokenType, options ...larkcore.RequestOptionFunc) (*larkcore.ApiResp, error)

func (*Client) ResendAppTicket added in v3.0.1 

func (cli *Client) ResendAppTicket(ctx context.Context, req *larkcore.ResendAppTicketReq) (*larkcore.ResendAppTicketResp, error)

type ClientOptionFunc 

type ClientOptionFunc func(config *larkcore.Config)

func WithAppType 

func WithAppType(appType larkcore.AppType) ClientOptionFunc

func WithEnableTokenCache 

func WithEnableTokenCache(enableTokenCache bool) ClientOptionFunc

func WithHeaders added in v3.0.3 

func WithHeaders(header http.Header) ClientOptionFunc

设置每次请求都会携带的 header

func WithHelpdeskCredential 

func WithHelpdeskCredential(helpdeskID, helpdeskToken string) ClientOptionFunc

func WithHttpClient 

func WithHttpClient(httpClient larkcore.HttpClient) ClientOptionFunc

func WithLogLevel 

func WithLogLevel(logLevel larkcore.LogLevel) ClientOptionFunc

func WithLogReqAtDebug added in v3.0.1 

func WithLogReqAtDebug(printReqRespLog bool) ClientOptionFunc

func WithLogger 

func WithLogger(logger larkcore.Logger) ClientOptionFunc

func WithMarketplaceApp 

func WithMarketplaceApp() ClientOptionFunc

func WithOpenBaseUrl 

func WithOpenBaseUrl(baseUrl string) ClientOptionFunc

func WithReqTimeout 

func WithReqTimeout(reqTimeout time.Duration) ClientOptionFunc

func WithSerialization added in v3.0.10 

func WithSerialization(serializable larkcore.Serializable) ClientOptionFunc

func WithTokenCache 

func WithTokenCache(cache larkcore.Cache) ClientOptionFunc

Source Files

View all Source files

Directories

Path Synopsis
httpserverext
dispatcher
Package dispatcher code generated by oapi sdk gen
 Package dispatcher code generated by oapi sdk gen
dispatcher/callback
service
acs
acs/v1
admin
admin/v1
aily
aily/v1
apaas
apaas/v1
application
application/v6
approval
approval/v4
attendance
attendance/v1
auth
auth/v3
authen
authen/v1
baike
baike/v1
base
base/v2
bitable
bitable/v1
block
block/v2
board
board/v1
calendar
calendar/v4
cardkit
cardkit/v1
compensation
compensation/v1
contact
contact/v3
corehr
corehr/v1
corehr/v2
directory
directory/v1
docs
docs/v1
document_ai
document_ai/v1
docx
docx/v1
drive
drive/v1
drive/v2
ehr
ehr/v1
event
event/v1
ext
face_detection/v1
helpdesk
helpdesk/v1
hire
hire/v1
hire/v2
human_authentication
human_authentication/v1
im
im/v1
im/v2
lingo
lingo/v1
mail
mail/v1
mdm
mdm/v1
mdm/v3
meeting_room
meeting_room/v1
minutes
minutes/v1
moments
moments/v1
okr
okr/v1
optical_char_recognition
optical_char_recognition/v1
passport
passport/v1
payroll
payroll/v1
performance
performance/v2
personal_settings
personal_settings/v1
report
report/v1
search
search/v2
security_and_compliance
security_and_compliance/v1
security_and_compliance/v2
sheets
sheets/v3
speech_to_text
speech_to_text/v1
task
task/v1
task/v2
tenant
tenant/v2
translation
translation/v1
vc
vc/v1
verification
verification/v1
wiki
wiki/v1
wiki/v2
workplace
workplace/v1

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.