Feishu/Lark Open API Go Sdk, Support ALL Open API and Event Callback.
Supported Features
- Many APIs and events
- Support mock to support test
- Support isv and self-built apps
- Support Logger interface
- Support UserAccessToken
- Use code generation to create, api and document update timely
Click Lark Chat Link to discuss.
go get github.com/chyroc/larkhttps://godoc.org/github.com/chyroc/lark
API Count: 515, Event Count: 76
Click This to See ALL
- Auth
- ResendAppTicket
- GetAccessToken
- RefreshAccessToken
- GetUserInfo
- Contact
- SearchUserOld
- CreateUser
- DeleteUser
- GetUser
- GetUserList
- GetUserListOld
- BatchGetUser
- UpdateUserPatch
- UpdateUser
- BatchGetUserByID
- BatchGetUserByIDOld
- CreateDepartment
- GetDepartment
- GetDepartmentList
- GetDepartmentListOld
- GetParentDepartment
- SearchDepartment
- UpdateDepartmentPatch
- UpdateDepartment
- DeleteDepartment
- CreateContactGroup
- UpdateContactGroup
- DeleteContactGroup
- GetContactGroup
- GetContactGroupList
- AddContactGroupMember
- DeleteContactGroupMember
- GetContactGroupMember
- GetEmployeeTypeEnumList
- UpdateEmployeeTypeEnumPatch
- DeleteEmployeeTypeEnum
- CreateEmployeeTypeEnum
- GetContactCustomAttrList
- CreateContactUnit
- UpdateContactUnit
- DeleteContactUnit
- GetContactUnit
- GetContactUnitList
- BindContactUnitDepartment
- UnbindContactUnitDepartment
- GetContactUnitDepartmentList
- GetContactScopeList
- Message
- SendEphemeralMessage
- SendUrgentAppMessage
- SendUrgentSmsMessage
- SendUrgentPhoneMessage
- SendRawMessage
- SendRawMessageOld
- BatchSendOldRawMessage
- ReplyRawMessage
- DeleteMessage
- BatchDeleteMessage
- UpdateMessage
- UpdateMessageDelay
- GetMessageReadUserList
- GetBatchSentMessageReadUser
- GetMessageList
- GetMessageFile
- GetMessage
- DeleteEphemeralMessage
- Chat
- CreateChat
- GetChat
- GetChatOld
- UpdateChat
- DeleteChat
- GetChatListOfSelf
- SearchChat
- GetChatMemberList
- IsInChat
- AddChatMember
- DeleteChatMember
- JoinChat
- GetChatAnnouncement
- UpdateChatAnnouncement
- Bot
- GetBotInfo
- AddBotToChat
- Calendar
- CreateCalendarACL
- DeleteCalendarACL
- GetCalendarACLList
- SubscribeCalendarACL
- CreateCalendar
- DeleteCalendar
- GetCalendar
- GetCalendarList
- UpdateCalendar
- SearchCalendar
- SubscribeCalendar
- UnsubscribeCalendar
- SubscribeCalendarChangeEvent
- CreateCalendarEvent
- DeleteCalendarEvent
- GetCalendarEvent
- GetCalendarEventList
- UpdateCalendarEvent
- SearchCalendarEvent
- SubscribeCalendarEvent
- CreateCalendarEventAttendee
- GetCalendarEventAttendeeList
- DeleteCalendarEventAttendee
- GetCalendarEventAttendeeChatMemberList
- GetCalendarFreeBusyList
- CreateCalendarTimeoffEvent
- DeleteCalendarTimeoffEvent
- GenerateCaldavConf
- CreateCalendarExchangeBinding
- GetCalendarExchangeBinding
- DeleteCalendarExchangeBinding
- Drive
- SearchDriveFile
- GetDriveFileMeta
- CreateDriveFile
- CopyDriveFile
- DeleteDriveFile
- DeleteDriveDocFile
- DeleteDriveSheetFile
- CreateDriveFolder
- GetDriveFolderMeta
- GetDriveRootFolderMeta
- GetDriveFolderChildren
- GetDriveFileStatistics
- DownloadDriveFile
- UploadDriveFile
- PrepareUploadDriveFile
- PartUploadDriveFile
- FinishUploadDriveFile
- DownloadDriveMedia
- UploadDriveMedia
- PrepareUploadDriveMedia
- PartUploadDriveMedia
- FinishUploadDriveMedia
- CreateDriveMemberPermissionOld
- TransferDriveMemberPermission
- GetDriveMemberPermissionList
- CreateDriveMemberPermission
- DeleteDriveMemberPermission
- DeleteDriveMemberPermissionOld
- UpdateDriveMemberPermissionOld
- UpdateDriveMemberPermission
- CheckDriveMemberPermission
- UpdateDrivePublicPermissionV1Old
- UpdateDrivePublicPermissionV2Old
- GetDrivePublicPermissionV2
- UpdateDrivePublicPermission
- BatchGetDriveMediaTmpDownloadURL
- GetDriveCommentList
- GetDriveComment
- CreateDriveComment
- UpdateDriveComment
- DeleteDriveComment
- UpdateDriveCommentPatch
- CreateDriveDoc
- GetDriveDocContent
- GetDriveDocRawContent
- GetDriveDocMeta
- CreateSheet
- GetSheetMeta
- UpdateSheetProperty
- BatchUpdateSheet
- ImportSheet
- CreateDriveImportTask
- GetDriveImportTask
- MoveSheetDimension
- PrependSheetValue
- AppendSheetValue
- InsertSheetDimensionRange
- AddSheetDimensionRange
- UpdateSheetDimensionRange
- DeleteSheetDimensionRange
- GetSheetValue
- BatchGetSheetValue
- SetSheetValue
- BatchSetSheetValue
- SetSheetStyle
- BatchSetSheetStyle
- MergeSheetCell
- UnmergeSheetCell
- SetSheetValueImage
- FindSheet
- ReplaceSheet
- CreateSheetConditionFormat
- GetSheetConditionFormat
- UpdateSheetConditionFormat
- DeleteSheetConditionFormat
- CreateSheetProtectedDimension
- GetSheetProtectedDimension
- UpdateSheetProtectedDimension
- DeleteSheetProtectedDimension
- CreateSheetDataValidationDropdown
- DeleteSheetDataValidationDropdown
- UpdateSheetDataValidationDropdown
- GetSheetDataValidationDropdown
- CreateSheetFilter
- DeleteSheetFilter
- UpdateSheetFilter
- GetSheetFilter
- CreateSheetFilterView
- DeleteSheetFilterView
- UpdateSheetFilterView
- GetSheetFilterView
- QuerySheetFilterView
- CreateSheetFilterViewCondition
- DeleteSheetFilterViewCondition
- UpdateSheetFilterViewCondition
- GetSheetFilterViewCondition
- QuerySheetFilterViewCondition
- CreateSheetFloatImage
- DeleteSheetFloatImage
- UpdateSheetFloatImage
- GetSheetFloatImage
- QuerySheetFloatImage
- CreateWikiSpace
- GetWikiSpaceList
- GetWikiSpace
- UpdateWikiSpaceSetting
- AddWikiSpaceMember
- CreateWikiNode
- GetWikiNodeList
- GetWikiNode
- MoveDocsToWiki
- Bitable
- GetBitableViewList
- CreateBitableView
- DeleteBitableView
- GetBitableRecordList
- GetBitableRecord
- CreateBitableRecord
- BatchCreateBitableRecord
- UpdateBitableRecord
- BatchUpdateBitableRecord
- DeleteBitableRecord
- BatchDeleteBitableRecord
- GetBitableFieldList
- CreateBitableField
- UpdateBitableField
- DeleteBitableField
- GetBitableTableList
- CreateBitableTable
- BatchCreateBitableTable
- DeleteBitableTable
- BatchDeleteBitableTable
- GetBitableMeta
- MeetingRoom
- GetMeetingRoomCustomization
- BatchGetMeetingRoomSummary
- GetMeetingRoomBuildingList
- BatchGetMeetingRoomBuilding
- GetMeetingRoomRoomList
- BatchGetMeetingRoomRoom
- BatchGetMeetingRoomFreebusy
- ReplyMeetingRoomInstance
- CreateMeetingRoomBuilding
- UpdateMeetingRoomBuilding
- DeleteMeetingRoomBuilding
- BatchGetMeetingRoomBuildingID
- CreateMeetingRoomRoom
- UpdateMeetingRoomRoom
- DeleteMeetingRoomRoom
- BatchGetMeetingRoomRoomID
- GetMeetingRoomCountryList
- GetMeetingRoomDistrictList
- Jssdk
- GetJssdkTicket
- VC
- ApplyVCReserve
- UpdateVCReserve
- DeleteVCReserve
- GetVCReserve
- GetVCReserveActiveMeeting
- GetVCMeeting
- InviteVCMeeting
- KickoutVCMeeting
- SetVCHostMeeting
- EndVCMeeting
- StartVCMeetingRecording
- StopVCMeetingRecording
- GetVCMeetingRecording
- SetVCPermissionMeetingRecording
- GetVCDailyReport
- GetVCTopUserReport
- GetVCRoomConfig
- SetVCRoomConfig
- Application
- IsApplicationUserAdmin
- GetApplicationUserAdminScope
- GetApplicationAppVisibility
- GetApplicationUserVisibleApp
- GetApplicationAppList
- UpdateApplicationAppVisibility
- GetApplicationAppAdminUserList
- CheckUserIsInApplicationPaidScope
- GetApplicationOrderList
- GetApplicationOrder
- GetApplicationUsageOverview
- GetApplicationUsageTrend
- GetApplicationUsageDetail
- GetApplicationMessageOverview
- GetApplicationMessageTrend
- GetApplicationMessageDetail
- Mail
- CreateMailGroup
- GetMailGroup
- GetMailGroupList
- UpdateMailGroupPatch
- UpdateMailGroup
- DeleteMailGroup
- CreateMailGroupMember
- GetMailGroupMember
- GetMailGroupMemberList
- DeleteMailGroupMember
- CreateMailGroupPermissionMember
- GetMailGroupPermissionMember
- GetMailGroupPermissionMemberList
- DeleteMailGroupPermissionMember
- CreatePublicMailbox
- GetPublicMailbox
- GetPublicMailboxList
- UpdatePublicMailboxPatch
- UpdatePublicMailbox
- DeletePublicMailbox
- CreatePublicMailboxMember
- GetPublicMailboxMember
- GetPublicMailboxMemberList
- DeletePublicMailboxMember
- ClearPublicMailboxMember
- CreateMailUserAlias
- DeleteMailUserAlias
- GetMailUserAliasList
- Approval
- GetApproval
- GetApprovalInstanceList
- GetApprovalInstance
- CreateApprovalInstance
- ApproveApprovalInstance
- RejectApprovalInstance
- TransferApprovalInstance
- RollbackApprovalInstance
- CancelApprovalInstance
- SearchApprovalInstance
- AddApprovalInstanceSign
- UploadApprovalFile
- SearchApprovalTask
- GetApprovalUserTaskList
- SearchApprovalCarbonCopy
- CreateApprovalCarbonCopy
- PreviewApprovalInstance
- UpdateApprovalMessage
- SubscribeApprovalSubscription
- UnsubscribeApprovalSubscription
- Helpdesk
- StartHelpdeskService
- GetHelpdeskTicket
- UpdateHelpdeskTicket
- GetHelpdeskTicketList
- DownloadHelpdeskTicketImage
- AnswerHelpdeskTicketUserQuery
- GetHelpdeskTicketMessageList
- SendHelpdeskTicketMessage
- SendHelpdeskMessage
- GetHelpdeskTicketCustomizedFieldList
- DeleteHelpdeskTicketCustomizedField
- UpdateHelpdeskTicketCustomizedField
- CreateHelpdeskTicketCustomizedField
- GetHelpdeskTicketCustomizedField
- CreateHelpdeskCategory
- GetHelpdeskCategory
- UpdateHelpdeskCategory
- DeleteHelpdeskCategory
- GetHelpdeskCategoryList
- CreateHelpdeskFAQ
- GetHelpdeskFAQ
- UpdateHelpdeskFAQ
- DeleteHelpdeskFAQ
- GetHelpdeskFAQList
- GetHelpdeskFAQImage
- SearchHelpdeskFAQ
- UpdateHelpdeskAgent
- GetHelpdeskAgentEmail
- CreateHelpdeskAgentSchedule
- DeleteHelpdeskAgentSchedule
- UpdateHelpdeskAgentSchedule
- GetHelpdeskAgentSchedule
- GetHelpdeskAgentScheduleList
- CreateHelpdeskAgentSkill
- GetHelpdeskAgentSkill
- UpdateHelpdeskAgentSkill
- DeleteHelpdeskAgentSkill
- GetHelpdeskAgentSkillList
- GetHelpdeskAgentSkillRuleList
- SubscribeHelpdeskEvent
- UnsubscribeHelpdeskEvent
- Admin
- GetAdminDeptStats
- GetAdminUserStats
- HumanAuth
- GetFaceVerifyAuthResult
- UploadFaceVerifyImage
- CropFaceVerifyImage
- CreateIdentity
- AI
- RecognizeBasicImage
- RecognizeSpeechStream
- RecognizeSpeechFile
- TranslateText
- DetectTextLanguage
- DetectFaceAttributes
- Attendance
- DownloadAttendanceFile
- UploadAttendanceFile
- QueryAttendanceUserSettings
- UpdateAttendanceUserSettings
- CreateUpdateAttendanceGroup
- DeleteAttendanceGroup
- GetAttendanceGroup
- CreateAttendanceShift
- DeleteAttendanceShift
- GetAttendanceShiftByID
- GetAttendanceShiftByName
- GetAttendanceStatisticsData
- GetAttendanceStatisticsHeader
- UpdateAttendanceUserStatisticsSettings
- GetAttendanceUserStatisticsSettings
- GetAttendanceUserDailyShift
- GetAttendanceUserTask
- GetAttendanceUserFlow
- BatchGetAttendanceUserFlow
- BatchCreateAttendanceUserFlow
- GetAttendanceUserTaskRemedy
- CreateUpdateAttendanceUserDailyShift
- GetAttendanceUserApproval
- CreateAttendanceUserApproval
- GetAttendanceUserAllowedRemedy
- InitAttendanceRemedyApproval
- UpdateAttendanceRemedyApproval
- File
- UploadImage
- DownloadImage
- UploadFile
- DownloadFile
- OKR
- GetOKRPeriodList
- BatchGetOKR
- GetUserOKRList
- EHR
- GetEHREmployeeList
- DownloadEHRAttachments
- Tenant
- GetTenant
- Search
- CreateSearchDataSourceItem
- GetSearchDataSourceItem
- DeleteSearchDataSourceItem
- CreateSearchDataSource
- GetSearchDataSource
- UpdateSearchDataSource
- GetSearchDataSourceList
- DeleteSearchDataSource
- Hire
- GetHireJob
- GetHireJobManager
- GetHireTalent
- GetHireAttachment
- GetHireAttachmentPreview
- GetHireResumeSource
- CreateHireNote
- UpdateHireNote
- GetHireNote
- GetHireNoteList
- GetHireReferralByApplication
- GetHireJobProcessList
- CreateHireApplication
- TerminateHireApplication
- GetHireApplication
- GetHireApplicationList
- GetHireApplicationInterviewList
- GetHireOfferByApplication
- GetHireOfferSchema
- MakeHireTransferOnboardByApplication
- UpdateHireEmployee
- GetHireEmployeeByApplication
- GetHireEmployee
- Task
- CreateTaskCollaborator
- GetTaskCollaboratorList
- DeleteTaskCollaborator
- CreateTaskFollower
- GetTaskFollowerList
- DeleteTaskFollower
- CreateTaskReminder
- GetTaskReminderList
- DeleteTaskReminder
- CreateTask
- GetTask
- DeleteTask
- UpdateTask
- CompleteTask
- UncompleteTask
- CreateTaskComment
- GetTaskComment
- DeleteTaskComment
- UpdateTaskComment
- ACS
- GetACSAccessRecordPhoto
- GetACSAccessRecordList
- GetACSDeviceList
- GetACSUserFace
- UpdateACSUserFace
- GetACSUser
- UpdateACSUser
- GetACSUserList
- Ecosystem
- GetEcosystemBindAwemeUser
- EventCallback
- EventV2DriveFileTitleUpdatedV1
- EventV2DriveFileReadV1
- EventV2DriveFileEditV1
- EventV1AppOpen
- EventV1ShiftApproval
- EventV1LeaveApprovalV2
- EventV1OutApproval
- EventV1WorkApproval
- EventV2DriveFilePermissionMemberAddedV1
- EventV2DriveFileTrashedV1
- EventV2DriveFileDeletedV1
- EventV2DriveFilePermissionMemberRemovedV1
- EventV2ApprovalApprovalUpdatedV4
- EventV1TripApproval
- EventV1RemedyApproval
- EventV2MeetingRoomMeetingRoomUpdatedV1
- EventV2MeetingRoomMeetingRoomStatusChangedV1
- EventV2MeetingRoomMeetingRoomDeletedV1
- EventV2MeetingRoomMeetingRoomCreatedV1
- EventV1OrderPaid
- EventV1AppTicket
- EventV1AppUninstalled
- EventV1AppStatusChange
- EventV2ApplicationApplicationVisibilityAddedV6
- EventV2AttendanceUserTaskUpdatedV1
- EventV2AttendanceUserFlowCreatedV1
- EventV2AwemeEcosystemAwemeUserBindedAccountV1
- EventV2TaskTaskUpdatedV1
- EventV2TaskTaskCommentUpdatedV1
- EventV2HelpdeskTicketMessageCreatedV1
- EventV2HelpdeskTicketCreatedV1
- EventV2HelpdeskTicketMessageUpdatedV1
- EventV2ContactDepartmentCreatedV3
- EventV2ContactDepartmentDeletedV3
- EventV2ContactDepartmentUpdatedV3
- EventV2ContactUserUpdatedV3
- EventV2ContactUserCreatedV3
- EventV2ContactUserDeletedV3
- EventV2ContactScopeUpdatedV3
- EventV2ContactEmployeeTypeEnumCreatedV3
- EventV2ContactEmployeeTypeEnumActivedV3
- EventV2ContactEmployeeTypeEnumDeactivatedV3
- EventV2ContactEmployeeTypeEnumUpdatedV3
- EventV2ContactEmployeeTypeEnumDeletedV3
- EventV2IMMessageReceiveV1
- EventV2IMMessageReadV1
- EventV2IMChatDisbandedV1
- EventV2IMChatUpdatedV1
- EventV2IMChatMemberBotAddedV1
- EventV2IMChatMemberBotDeletedV1
- EventV2IMChatMemberUserAddedV1
- EventV2IMChatMemberUserWithdrawnV1
- EventV2IMChatMemberUserDeletedV1
- EventV2VCMeetingMeetingStartedV1
- EventV2VCMeetingMeetingEndedV1
- EventV2VCMeetingJoinMeetingV1
- EventV2VCMeetingLeaveMeetingV1
- EventV2VCMeetingRecordingStartedV1
- EventV2VCMeetingRecordingEndedV1
- EventV2VCMeetingRecordingReadyV1
- EventV2VCMeetingShareStartedV1
- EventV2VCMeetingShareEndedV1
- EventV2ACSAccessRecordCreatedV1
- EventV2ACSUserUpdatedV1
- EventV2CalendarCalendarACLCreatedV4
- EventV2CalendarCalendarACLDeletedV4
- EventV2CalendarCalendarEventChangedV4
- EventV2CalendarCalendarChangedV4
- EventV1AddBot
- EventV1RemoveBot
- EventV1P2PChatCreate
- EventV1ReceiveMessage
- EventV1AddUserToChat
- EventV1RemoveUserFromChat
- EventV1RevokeAddUserFromChat
- EventV1ChatDisband
- AppLink
- OpenLark
- OpenMiniProgram
- OpenWebApp
- OpenChat
- OpenCalender
- OpenCalenderView
- OpenCalenderEventCreate
- OpenCalenderAccount
- OpenDocs
- OpenBot
- OpenSSOLogin
- OpenWebURL
- OpenTask
- OpenTaskCreate
- OpenTaskDetail
- OpenTaskTab
- for sample bot and app:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))- processing larksuite (non-China region) request
cli := lark.New(
lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"),
lark.WithOpenBaseURL("https://open.larksuite.com"),
lark.WithWWWBaseURL("https://www.larksuite.com"),
)- for need handle event callback:
cli := lark.New(
lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"),
lark.WithEventCallbackVerify("<ENCRYPT_KEY>", "<VERIFICATION_TOKEN>"),
)- for helpdesk app:
cli := lark.New(
lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"),
lark.WithHelpdeskCredential("<HELPDESK_ID>", "HELPDESK_TOKEN"),
)for more about event callback example, see ./_examples/event_callback.go .
handle message callback example:
cli := lark.New(
lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"),
lark.WithEventCallbackVerify("<ENCRYPT_KEY>", "<VERIFICATION_TOKEN>"),
)
// handle message callback
cli.EventCallback.HandlerEventIMMessageReceiveV1(func(ctx context.Context, cli *lark.Lark, schema string, header *lark.EventV2Header, event *lark.EventV2IMMessageReceiveV1) (string, error) {
_, _, err := cli.Message.Reply(event.Message.MessageID).SendText(ctx, "hi, "+event.Message.Content)
return "", err
})
http.HandleFunc("/api", func(w http.ResponseWriter, r *http.Request) {
cli.EventCallback.ListenCallback(r.Context(), r.Body, w)
})
fmt.Println("start server ...")
log.Fatal(http.ListenAndServe(":9726", nil))for more about isv example, see ./_examples/isv.go .
create isv chat:
cli := lark.New(
lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"),
lark.WithISV(true),
lark.WithStore("<NEW_STORE>"),
)
tenantKey1Cli := cli.WithTenant("<TENANT_KEY_1>")
resp, _, err := tenantKey1cli.Chat.CreateChat(ctx, &lark.CreateChatReq{
Name: ptr.String("<CHAT_NAME_1>"),
})
fmt.Println(resp, err)for more about bot example, see ./_examples/bot.go .
get bot info example:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))
resp, _, err := cli.Bot.GetBotInfo(ctx, &lark.GetBotInfoReq{})
fmt.Println(resp, err)for more about send message example, see ./_examples/send_message.go .
send text message example:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))
resp, _, err := cli.Message.Send().ToChatID("<CHAT_ID>").SendText(ctx, "<TEXT>")
fmt.Println(resp, err)for more about other message example, see ./_examples/other_message.go .
send delete message example:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))
resp, _, err := cli.Message.DeleteMessage(ctx, &lark.DeleteMessageReq{
MessageID: "<MESSAGE_ID>",
})
fmt.Println(resp, err)for more about chat example, see ./_examples/chat.go .
create chat example:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))
resp, _, err := cli.Chat.CreateChat(ctx, &lark.CreateChatReq{
Name: ptr.String("<CHAT_NAME>"),
})
fmt.Println(resp, err)for more about file example, see ./_examples/file.go .
upload image example:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))
f, err := os.Open("<FILE_PATH>")
if err != nil {
panic(err)
}
resp, _, err := cli.File.UploadImage(ctx, &lark.UploadImageReq{
ImageType: lark.ImageTypeMessage,
Image: f,
})
fmt.Println(resp, err)for more about calendar example, see ./_examples/calendar.go .
create calendar example:
cli := lark.New(lark.WithAppCredential("<APP_ID>", "<APP_SECRET>"))
resp, _, err := cli.Calendar.CreateCalendar(ctx, &lark.CreateCalendarReq{
Summary: ptr.String("<SUMMARY>"),
})
fmt.Println(resp, err)