lark

package module
v0.0.113 Latest Latest
Warning

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

Go to latest
Published: Jan 10, 2024 License: Apache-2.0 Imports: 23 Imported by: 46

README

lark

codecov go report card test status Apache-2.0 license Go.Dev reference Mentioned in Awesome Go Go project version Used by

中文版 README

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

Chat

⁣Click Lark Chat Link to discuss.

Install

go get github.com/chyroc/lark

Docs

https://godoc.org/github.com/chyroc/lark

Support APIs

API Count: 996, Event Count: 139

Click This to See ALL
  • ACS
    • GetACSAccessRecordPhoto
    • GetACSAccessRecordList
    • GetACSDeviceList
    • GetACSUserFace
    • UpdateACSUserFace
    • GetACSUser
    • UpdateACSUser
    • GetACSUserList
  • AI
    • RecognizeAIVehicleInvoice
    • RecognizeAIHealthCertificate
    • RecognizeAIHkmMainlandTravelPermit
    • RecognizeAITwMainlandTravelPermit
    • RecognizeAIChinesePassport
    • RecognizeAIBankCard
    • RecognizeAIVehicleLicense
    • RecognizeAITrainInvoice
    • RecognizeAITaxiInvoice
    • RecognizeAiidCard
    • RecognizeAIFoodProduceLicense
    • RecognizeAIFoodManageLicense
    • RecognizeAIDrivingLicense
    • RecognizeAIVatInvoice
    • RecognizeAIBusinessLicense
    • ExtractAIContractField
    • RecognizeAIBusinessCard
    • RecognizeBasicImage
    • RecognizeSpeechStream
    • RecognizeSpeechFile
    • TranslateText
    • DetectTextLanguage
    • DetectFaceAttributes
  • Admin
    • AdminResetPassword
    • GetAdminDeptStats
    • GetAdminUserStats
    • UploadAdminBadgeImage
    • CreateAdminBadge
    • UpdateAdminBadge
    • GetAdminBadgeList
    • GetAdminBadge
    • CreateAdminBadgeGrant
    • UpdateAdminBadgeGrant
    • GetAdminBadgeGrantList
    • GetAdminBadgeGrant
    • DeleteAdminBadgeGrant
  • AppLink
    • OpenLark
    • OpenScan
    • OpenWorkbench
    • OpenMiniProgram
    • OpenWebApp
    • OpenChat
    • OpenCalender
    • OpenCalenderView
    • OpenCalenderEventCreate
    • OpenCalenderAccount
    • OpenDocs
    • OpenBot
    • OpenSSOLogin
    • OpenWebURL
    • OpenTask
    • OpenTaskCreate
    • OpenTaskDetail
    • OpenTaskTab
  • Application
    • SearchApplicationWorkplaceAccessData
    • SearchApplicationCustomWorkplaceAccessData
    • SearchApplicationWorkplaceBlockAccessData
    • GetApplicationFavourite
    • GetApplicationRecommend
    • GetApplicationRecommendRuleList
    • IsApplicationUserAdmin
    • GetApplicationUserAdminScope
    • GetApplicationAppVisibility
    • GetApplicationContactsRangeConfiguration
    • UpdateApplicationContactsRangeConfiguration
    • GetApplicationUserVisibleApp
    • CheckApplicationVisibleWhiteBlackList
    • GetApplicationAppList
    • UpdateApplicationAppVisibility
    • UpdateApplicationAppVisibilityV6
    • GetApplicationAppAdminUserList
    • CheckUserIsInApplicationPaidScope
    • GetApplicationOrderList
    • GetApplicationOrder
    • GetApplicationUnderAuditList
    • GetApplication
    • GetApplicationVersion
    • GetApplicationVersionList
    • GetApplicationVersionContactsRangeSuggest
    • UpdateApplicationVersion
    • UpdateApplication
    • GetApplicationUsageDepartmentOverview
    • GetApplicationUsageOverview
    • GetApplicationUsageTrend
    • UpdateApplicationFeedback
    • GetApplicationFeedbackList
    • SetApplicationAppBadge
  • Approval
    • CreateApproval
    • GetApproval
    • GetApprovalList
    • SubscribeApprovalSubscription
    • UnsubscribeApprovalSubscription
    • CreateApprovalInstance
    • GetApprovalInstance
    • GetApprovalInstanceList
    • CancelApprovalInstance
    • CreateApprovalCarbonCopy
    • PreviewApprovalInstance
    • ApproveApprovalInstance
    • RejectApprovalInstance
    • TransferApprovalInstance
    • ResubmitApprovalInstanceTask
    • RollbackApprovalInstance
    • AddApprovalInstanceSign
    • CreateApprovalComment
    • GetApprovalComment
    • DeleteApprovalComment
    • RemoveApprovalComment
    • CreateApprovalExternalApproval
    • GetApprovalExternalApproval
    • CreateApprovalExternalInstance
    • CheckApprovalExternalInstance
    • GetApprovalExternalList
    • UploadApprovalFile
    • UpdateApprovalMessage
    • SendApprovalMessage
    • SearchApprovalInstance
    • SearchApprovalCarbonCopy
    • SearchApprovalTask
    • GetApprovalUserTaskList
    • TransformApprovalUserID
  • Attendance
    • GetAttendanceGroupList
    • CreateAttendanceGroup
    • SearchAttendanceGroup
    • GetAttendanceGroup
    • DeleteAttendanceGroup
    • GetAttendanceShiftList
    • GetAttendanceShift
    • GetAttendanceShiftDetail
    • DeleteAttendanceShift
    • UpdateAttendanceLeaveAccrualRecord
    • GetAttendanceLeaveEmployExpireRecord
    • CreateAttendanceShift
    • GetAttendanceUserDailyShift
    • BatchCreateAttendanceUserDailyShift
    • GetAttendanceUserStatsField
    • GetAttendanceUserStatsView
    • UpdateAttendanceUserStatsView
    • GetAttendanceUserStatsData
    • GetAttendanceUserApproval
    • CreateAttendanceUserApproval
    • UpdateAttendanceRemedyApproval
    • BatchGetAttendanceUserFlow
    • GetAttendanceUserFlow
    • GetAttendanceUserTask
    • BatchCreateAttendanceUserFlow
    • GetAttendanceUserTaskRemedyAllowedRemedyList
    • GetAttendanceUserTaskRemedy
    • CreateAttendanceUserTaskRemedy
    • GetAttendanceUserSettingList
    • UpdateAttendanceUserSetting
    • DownloadAttendanceFile
    • UploadAttendanceFile
  • Auth
    • ResendAppTicket
    • GetAccessToken
    • RefreshAccessToken
    • GetUserInfo
  • Baike
    • CreateBaikeDraft
    • CreateBaikeUpdate
    • CreateBaikeEntity
    • UpdateBaikeEntity
    • GetBaikeEntity
    • GetBaikeEntityList
    • MatchBaikeEntity
    • SearchBaikeEntity
    • HighlightBaikeEntity
    • ExtractBaikeEntity
    • GetBaikeClassificationList
    • UploadBaikeImage
    • DownloadBaikeImage
  • Bitable
    • CopyBitableDashboard
    • GetBitableDashboardList
    • UpdateBitableView
    • GetBitableView
    • GetBitableViewList
    • CreateBitableView
    • DeleteBitableView
    • GetBitableRecordList
    • GetBitableRecord
    • CreateBitableRecord
    • BatchCreateBitableRecord
    • UpdateBitableRecord
    • BatchUpdateBitableRecord
    • DeleteBitableRecord
    • BatchDeleteBitableRecord
    • GetBitableFieldList
    • CreateBitableField
    • UpdateBitableField
    • DeleteBitableField
    • GetBitableAppRoleList
    • CreateBitableAppRole
    • DeleteBitableAppRole
    • UpdateBitableAppRole
    • BatchDeleteBitableAppRoleMember
    • BatchCreateBitableAppRoleMember
    • GetBitableAppRoleMemberList
    • CreateBitableAppRoleMember
    • DeleteBitableAppRoleMember
    • CreateBitableTable
    • BatchCreateBitableTable
    • DeleteBitableTable
    • BatchDeleteBitableTable
    • UpdateBitableTable
    • GetBitableTableList
    • UpdateBitableTableForm
    • GetBitableTableForm
    • UpdateBitableTableFormField
    • GetBitableTableFormFieldList
    • CopyBitableApp
    • CreateBitableApp
    • GetBitableMeta
    • UpdateBitableMeta
  • Bot
    • GetBotInfo
    • AddBotToChat
  • Calendar
    • CreateCalendarACL
    • DeleteCalendarACL
    • GetCalendarACLList
    • SubscribeCalendarACL
    • UnsubscribeCalendarACL
    • GetPrimaryCalendar
    • CreateCalendar
    • DeleteCalendar
    • GetCalendar
    • GetCalendarList
    • UpdateCalendar
    • SearchCalendar
    • SubscribeCalendar
    • UnsubscribeCalendar
    • SubscribeCalendarChangeEvent
    • UnsubscribeCalendarChangeEvent
    • CreateCalendarEvent
    • DeleteCalendarEvent
    • GetCalendarEvent
    • GetCalendarEventList
    • UpdateCalendarEvent
    • SearchCalendarEvent
    • SubscribeCalendarEvent
    • UnsubscribeCalendarEvent
    • ReplyCalendarEvent
    • GetCalendarEventInstanceList
    • DeleteCalendarEventMeetingChat
    • CreateCalendarEventMeetingChat
    • CreateCalendarEventAttendee
    • GetCalendarEventAttendeeList
    • DeleteCalendarEventAttendee
    • GetCalendarEventAttendeeChatMemberList
    • GetCalendarFreeBusyList
    • CreateCalendarTimeoffEvent
    • DeleteCalendarTimeoffEvent
    • GenerateCaldavConf
    • CreateCalendarExchangeBinding
    • GetCalendarExchangeBinding
    • DeleteCalendarExchangeBinding
  • Chat
    • CreateChat
    • GetChat
    • GetChatOld
    • UpdateChat
    • DeleteChat
    • GetChatListOfSelf
    • SearchChat
    • GetChatMemberList
    • IsInChat
    • CreateChatManager
    • DeleteChatManager
    • AddChatMember
    • DeleteChatMember
    • JoinChat
    • GetChatModeration
    • UpdateChatModeration
    • UpdateChatTopNotice
    • DeleteChatTopNotice
    • GenChatShareLink
    • GetChatAnnouncement
    • UpdateChatAnnouncement
    • CreateChatTab
    • DeleteChatTab
    • GetChatTabList
    • UpdateChatTab
    • SortChatTab
    • CreateChatMenuTree
    • DeleteChatMenuTree
    • UpdateChatMenuTree
    • SortChatMenuTree
    • GetChatMenuTree
  • Contact
    • CreateUser
    • DeleteUser
    • ResurrectUser
    • GetUser
    • BatchGetUser
    • GetUserList
    • GetUserListOld
    • UpdateUserPatch
    • UpdateUser
    • BatchGetUserByID
    • BatchGetUserByIDOld
    • SearchUserOld
    • UpdateUserID
    • CreateDepartment
    • GetDepartment
    • BatchGetDepartment
    • GetDepartmentList
    • UpdateDepartmentPatch
    • UpdateDepartment
    • GetDepartmentListOld
    • GetParentDepartment
    • SearchDepartment
    • UpdateDepartmentID
    • DeleteDepartment
    • UnbindDepartmentChat
    • CreateContactGroup
    • UpdateContactGroup
    • DeleteContactGroup
    • GetContactGroup
    • GetContactGroupList
    • GetContactMemberGroupList
    • AddContactGroupMember
    • BatchAddContactGroupMember
    • DeleteContactGroupMember
    • BatchDeleteContactGroupMember
    • GetContactGroupMember
    • CreateContactFunctionalRole
    • DeleteContactFunctionalRole
    • UpdateContactFunctionalRole
    • BatchCreateContactFunctionalRoleMember
    • BatchDeleteContactFunctionalRoleMember
    • UpdateContactFunctionalRoleMemberScope
    • GetContactFunctionalRoleMemberScope
    • GetContactFunctionalRoleMember
    • CreateContactJobLevel
    • DeleteContactJobLevel
    • UpdateContactJobLevel
    • GetContactJobLevel
    • GetContactJobLevelList
    • CreateContactJobFamily
    • DeleteContactJobFamily
    • UpdateContactJobFamily
    • GetContactJobFamily
    • GetContactJobFamilyList
    • GetContactJobTitle
    • GetContactJobTitleList
    • GetContactWorkCity
    • GetContactWorkCityList
    • GetEmployeeTypeEnumList
    • UpdateEmployeeTypeEnumPatch
    • DeleteEmployeeTypeEnum
    • CreateEmployeeTypeEnum
    • GetContactCustomAttrList
    • CreateContactUnit
    • UpdateContactUnit
    • DeleteContactUnit
    • GetContactUnit
    • GetContactUnitList
    • BindContactUnitDepartment
    • UnbindContactUnitDepartment
    • GetContactUnitDepartmentList
    • GetContactScopeList
  • CoreHR
    • SearchCoreHRNationality
    • SearchCoreHRBank
    • SearchCoreHRBankBranch
    • GetCoreHRCustomField
    • GetCoreHRCustomFieldList
    • GetCoreHRCustomFieldObjectApiNameList
    • SearchCoreHRCountryRegion
    • SearchCoreHRCountryRegionSubdivision
    • SearchCoreHRCity
    • SearchCoreHRDistrict
    • GetCoreHRCountryRegion
    • GetCoreHRCountryRegionList
    • GetCoreHRSubdivision
    • GetCoreHRSubdivisionList
    • GetCoreHRSubregion
    • GetCoreHRSubregionList
    • CreateCoreHREmployeeType
    • DeleteCoreHREmployeeType
    • UpdateCoreHREmployeeType
    • GetCoreHREmployeeType
    • GetCoreHREmployeeTypeList
    • CreateCoreHRNationalIDType
    • DeleteCoreHRNationalIDType
    • UpdateCoreHRNationalIDType
    • GetCoreHRNationalIDType
    • GetCoreHRNationalIDTypeList
    • CreateCoreHRWorkingHoursType
    • DeleteCoreHRWorkingHoursType
    • UpdateCoreHRWorkingHoursType
    • GetCoreHRWorkingHoursType
    • GetCoreHRWorkingHoursTypeList
    • SearchCoreHRCurrency
    • GetCoreHRCurrency
    • GetCoreHRCurrencyList
    • BatchGetCoreHREmployee
    • SearchCoreHREmployee
    • CreateCoreHREmployment
    • DeleteCoreHREmployment
    • UpdateCoreHREmployment
    • CreateCoreHRPerson
    • UpdateCoreHRPerson
    • DeleteCoreHRPerson
    • UploadCoreHRPersonFile
    • DownloadCoreHRPersonFile
    • GetCoreHRPerson
    • CreateCoreHRJobData
    • DeleteCoreHRJobData
    • UpdateCoreHRJobData
    • GetCoreHRJobData
    • BatchGetCoreHRJobData
    • GetCoreHRJobDataList
    • GetCoreHRDepartmentParentList
    • SearchCoreHRDepartment
    • CreateCoreHRDepartment
    • DeleteCoreHRDepartment
    • UpdateCoreHRDepartment
    • GetCoreHRDepartment
    • GetCoreHRDepartmentList
    • BatchGetCoreHRLocation
    • CreateCoreHRLocation
    • DeleteCoreHRLocation
    • GetCoreHRLocation
    • GetCoreHRLocationList
    • GetCoreHRCompany
    • GetCoreHRCompanyList
    • BatchGetCoreHRCompany
    • CreateCoreHRCompany
    • UpdateCoreHRCompany
    • DeleteCoreHRCompany
    • CreateCoreHRCostCenter
    • ActiveCoreHRCostCenter
    • DeleteCoreHRCostCenter
    • SearchCoreHRCostCenter
    • CreateCoreHRCostCenterVersion
    • UpdateCoreHRCostCenterVersion
    • DeleteCoreHRCostCenterVersion
    • BatchGetCoreHRJobLevel
    • CreateCoreHRJobLevel
    • DeleteCoreHRJobLevel
    • UpdateCoreHRJobLevel
    • GetCoreHRJobLevel
    • GetCoreHRJobLevelList
    • BatchGetCoreHRJobFamily
    • CreateCoreHRJobFamily
    • DeleteCoreHRJobFamily
    • UpdateCoreHRJobFamily
    • GetCoreHRJobFamily
    • GetCoreHRJobFamilyList
    • CreateCoreHRJob
    • DeleteCoreHRJob
    • UpdateCoreHRJob
    • GetCoreHRJobV2
    • GetCoreHRJobListV2
    • GetCoreHRJob
    • GetCoreHRJobList
    • CreateCoreHRPreHire
    • DeleteCoreHRPreHire
    • UpdateCoreHRPreHire
    • GetCoreHRPreHire
    • GetCoreHRPreHireList
    • SearchCoreHRContract
    • CreateCoreHRContract
    • DeleteCoreHRContract
    • UpdateCoreHRContract
    • GetCoreHRContract
    • GetCoreHRContractList
    • SearchCoreHRProbation
    • EnableDisableCoreHRProbationAssessment
    • CreateCoreHRProbationAssessment
    • UpdateCoreHRProbationAssessment
    • DeleteCoreHRProbationAssessment
    • GetCoreHRTransferReasonList
    • GetCoreHRTransferTypeList
    • CreateCoreHRJobChange
    • SearchCoreHRJobChange
    • GetCoreHROffboardingList
    • CreateCoreHROffboarding
    • SearchCoreHROffboarding
    • CreateCoreHRLeaveGrantingRecord
    • DeleteCoreHRLeaveGrantingRecord
    • GetCoreHRLeaveTypeList
    • GetCoreHRLeaveBalanceList
    • GetCoreHRLeaveRequestHistoryList
    • BatchGetCoreHrbpByEmployee
    • GetCoreHrbpByDepartment
    • GetCoreHrbpList
    • GetCoreHRSecurityGroupBp
    • SearchCoreHRAssignedUser
    • GetCoreHRAuthorization
    • GetCoreHRAuthorizationList
    • GetCoreHRSecurityGroupList
    • GetCoreHRProcessList
    • GetCoreHRProcess
    • GetCoreHRProcessFormVariableData
    • MatchCoreHRCompensationStandard
  • Drive
    • GetDriveRootFolderMeta
    • GetDriveFileList
    • GetDriveFolderMeta
    • CreateDriveFolder
    • GetDriveFileMeta
    • CreateDriveFile
    • CopyDriveFile
    • MoveDriveFile
    • DeleteDriveFile
    • GetDriveFileStatistics
    • CreateDriveFileShortcut
    • GetDriveFileTask
    • UploadDriveMedia
    • DownloadDriveMedia
    • PrepareUploadDriveMedia
    • PartUploadDriveMedia
    • FinishUploadDriveMedia
    • GetDocxDocument
    • GetDocxDocumentRawContent
    • GetDocxBlockListOfDocument
    • CreateDocx
    • GetDocxBlock
    • CreateDocxBlock
    • UpdateDocxBlock
    • BatchDeleteDocxBlock
    • GetDocxBlockListOfBlock
    • SubscribeDriveFile
    • UnsubscribeDriveFile
    • GetSubscribeDriveFile
    • SearchDriveFile
    • DeleteDriveSheetFile
    • GetDriveFolderChildren
    • CreateDriveExportTask
    • GetDriveExportTask
    • DownloadDriveExportTask
    • GetDriveFileViewRecordList
    • CreateDriveFileVersion
    • DeleteDriveFileVersion
    • GetDriveFileVersion
    • GetDriveFileVersionList
    • DownloadDriveFile
    • UploadDriveFile
    • PrepareUploadDriveFile
    • PartUploadDriveFile
    • FinishUploadDriveFile
    • CreateDriveMemberPermissionOld
    • TransferDriveOwnerPermission
    • CheckDriveMemberPermission
    • GetDriveMemberPermissionList
    • GetDriveMemberPermissionListOld
    • CreateDriveMemberPermission
    • UpdateDriveMemberPermission
    • DeleteDriveMemberPermission
    • GetDrivePublicPermissionOld
    • CreateDrivePermissionPublicPassword
    • UpdateDrivePermissionPublicPassword
    • DeleteDrivePermissionPublicPassword
    • GetDrivePublicPermission
    • UpdateDrivePublicPermission
    • GetDrivePublicPermissionV2
    • UpdateDrivePublicPermissionV2
    • BatchGetDriveMediaTmpDownloadURL
    • GetDriveCommentList
    • CreateDriveComment
    • GetDriveComment
    • BatchGetDriveComment
    • GetDriveCommentReplyList
    • UpdateDriveComment
    • DeleteDriveComment
    • UpdateDriveCommentPatch
    • CreateDriveFileSubscription
    • GetDriveFileSubscription
    • UpdateDriveFileSubscription
    • CreateDriveDoc
    • GetDriveDocContent
    • UpdateDriveDocContent
    • GetDriveDocRawContent
    • GetDriveDocMeta
    • UpdateSpreadsheet
    • GetSpreadsheet
    • CreateSpreadsheet
    • GetSheetMeta
    • UpdateSheetProperty
    • GetSheet
    • GetSheetList
    • 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
    • DeleteWikiSpaceMember
    • AddWikiSpaceMember
    • CreateWikiNode
    • GetWikiNodeList
    • MoveWikiNode
    • UpdateWikiNodeTitle
    • CopyWikiNode
    • GetWikiNode
    • MoveDocsToWiki
    • GetWikiTask
    • DeleteDriveMemberPermissionOld
    • UpdateDriveMemberPermissionOld
    • TransferDriveMemberPermission
    • CheckDriveMemberPermissionOld
  • EHR
    • GetEHREmployeeList
    • DownloadEHRAttachments
  • Event
    • GetEventOutboundIpList
  • EventCallback
    • EventV2CorehrJobCreatedV1
    • EventV2CorehrJobUpdatedV1
    • EventV2CorehrJobDeletedV1
    • EventV2CorehrProcessUpdatedV2
    • EventV2CorehrProcessCcUpdatedV2
    • EventV2CorehrProcessApproverUpdatedV2
    • EventV2ApplicationApplicationAppVersionAuditV6
    • EventV2ApplicationApplicationAppVersionPublishApplyV6
    • EventV2ApplicationApplicationAppVersionPublishRevokeV6
    • EventV2ApplicationApplicationCreatedV6
    • EventV2ContactCustomAttrEventUpdatedV3
    • EventV2DriveFileBitableRecordChangedV1
    • EventV2DriveFileTitleUpdatedV1
    • EventV2DriveFileReadV1
    • EventV2DriveFileEditV1
    • EventV1AppOpen
    • EventV1ShiftApproval
    • EventV1LeaveApprovalV2
    • EventV1LeaveApprovalRevert
    • EventV1OutApproval
    • EventV1WorkApproval
    • EventV2DriveFilePermissionMemberAddedV1
    • EventV2DriveFileTrashedV1
    • EventV2DriveFileDeletedV1
    • EventV2DriveFilePermissionMemberRemovedV1
    • EventV2ApprovalApprovalUpdatedV4
    • EventV1RemedyApproval
    • EventV1ThirdPartyMeetingRoomEventUpdated
    • EventV1ThirdPartyMeetingRoomEventDeleted
    • EventV2MeetingRoomMeetingRoomCreatedV1
    • EventV2MeetingRoomMeetingRoomUpdatedV1
    • EventV2MeetingRoomMeetingRoomStatusChangedV1
    • EventV2MeetingRoomMeetingRoomDeletedV1
    • EventV1ThirdPartyMeetingRoomEventCreated
    • EventV1OrderPaid
    • EventV1AppTicket
    • EventV1AppUninstalled
    • EventV1AppStatusChange
    • EventV2ApplicationApplicationVisibilityAddedV6
    • EventV2ApplicationApplicationFeedbackCreatedV6
    • EventV2ApplicationApplicationFeedbackUpdatedV6
    • EventV2TaskTaskUpdateTenantV1
    • EventV2TaskTaskUpdatedV1
    • EventV2TaskTaskCommentUpdatedV1
    • EventV2HelpdeskTicketMessageCreatedV1
    • EventV2HelpdeskTicketCreatedV1
    • EventV2HelpdeskTicketUpdatedV1
    • EventV2HelpdeskNotificationApproveV1
    • EventV2ContactDepartmentCreatedV3
    • EventV2ContactDepartmentDeletedV3
    • EventV2ContactDepartmentUpdatedV3
    • EventV2ContactUserUpdatedV3
    • EventV2ContactUserCreatedV3
    • EventV2ContactUserDeletedV3
    • EventV2ContactScopeUpdatedV3
    • EventV2ContactEmployeeTypeEnumCreatedV3
    • EventV2ContactEmployeeTypeEnumActivedV3
    • EventV2ContactEmployeeTypeEnumDeactivatedV3
    • EventV2ContactEmployeeTypeEnumUpdatedV3
    • EventV2ContactEmployeeTypeEnumDeletedV3
    • EventV2IMMessageReceiveV1
    • EventV2IMMessageReadV1
    • EventV2IMMessageReactionDeletedV1
    • EventV2IMMessageReactionCreatedV1
    • 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
    • EventV1ApprovalInstance
    • EventV1ApprovalTask
    • EventV1ApprovalCc
    • EventV2AttendanceUserTaskUpdatedV1
    • EventV2AttendanceUserFlowCreatedV1
    • EventV2IMMessageRecalledV1
    • EventV2VCRoomCreatedV1
    • EventV2VCRoomDeletedV1
    • EventV2VCRoomUpdatedV1
    • EventV2DriveFileBitableFieldChangedV1
    • EventV2VCMeetingAllMeetingStartedV1
    • EventV2VCMeetingAllMeetingEndedV1
    • EventV2VCRoomLevelCreatedV1
    • EventV2VCRoomLevelDeletedV1
    • EventV2VCRoomLevelUpdatedV1
    • EventV2VCReserveConfigUpdatedV1
    • EventV2ApplicationBotMenuV6
    • EventV2HireOfferStatusChangedV1
    • EventV2CorehrEmploymentCreatedV1
    • EventV2CorehrEmploymentUpdatedV1
    • EventV2CorehrEmploymentDeletedV1
    • EventV2CorehrPersonCreatedV1
    • EventV2CorehrPersonUpdatedV1
    • EventV2CorehrPersonDeletedV1
    • EventV2CorehrDepartmentCreatedV1
    • EventV2CorehrDepartmentUpdatedV1
    • EventV2CorehrDepartmentDeletedV1
    • EventV2CorehrJobDataEmployedV1
    • EventV2CorehrContractCreatedV1
    • EventV2CorehrEmploymentConvertedV1
    • EventV2CorehrJobChangeUpdatedV1
    • EventV2CorehrJobDataChangedV1
    • EventV2CorehrOffboardingUpdatedV1
    • EventV2CorehrEmploymentResignedV1
    • EventV2CorehrOrgRoleAuthorizationUpdatedV1
    • EventV2HireEHRImportTaskForInternshipOfferImportedV1
    • EventV2CorehrProbationUpdatedV2
    • EventV2CorehrPreHireUpdatedV1
    • EventV2HireEcoAccountCreatedV1
    • EventV2HireEcoBackgroundCheckCreatedV1
    • EventV2HireEcoBackgroundCheckCanceledV1
    • EventV2HireEcoExamCreatedV1
    • EventV2HireReferralAccountAssetsUpdateV1
    • EventV2CorehrContractDeletedV1
    • EventV2CorehrContractUpdatedV1
  • File
    • UploadImage
    • DownloadImage
    • UploadFile
    • DownloadFile
  • Helpdesk
    • CreateHelpdeskNotification
    • UpdateHelpdeskNotification
    • GetHelpdeskNotification
    • PreviewHelpdeskNotification
    • SubmitApproveHelpdeskNotification
    • CancelApproveHelpdeskNotification
    • ExecuteSendHelpdeskNotification
    • CancelSendHelpdeskNotification
    • StartHelpdeskService
    • GetHelpdeskTicket
    • UpdateHelpdeskTicket
    • GetHelpdeskTicketList
    • DownloadHelpdeskTicketImage
    • AnswerHelpdeskTicketUserQuery
    • GetHelpdeskTicketCustomizedFields
    • 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
  • Hire
    • GetHireJobConfig
    • CreateHireJob
    • UpdateHireJob
    • UpdateHireJobConfig
    • GetHireJob
    • GetHireJobManager
    • GetHireTalent
    • GetHireAttachment
    • GetHireAttachmentPreview
    • GetHireReferralWebsiteJobPostList
    • GetHireReferralWebsiteJobPost
    • GetHireReferralByApplication
    • CreateHireExternalApplication
    • UpdateHireExternalApplication
    • DeleteHireExternalApplication
    • CreateHireExternalInterview
    • CreateHireExternalInterviewAssessment
    • CreateHireExternalBackgroundCheck
    • AddHireTalentToFolder
    • GetHireTalentFolderList
    • BatchGetHireTalent
    • GetHireJobProcessList
    • CreateHireApplication
    • TerminateHireApplication
    • GetHireApplication
    • GetHireApplicationList
    • GetHireEvaluationList
    • GetHireQuestionnaireList
    • GetHireInterviewList
    • CreateHireOffer
    • UpdateHireOffer
    • GetHireOfferByApplication
    • GetHireOffer
    • GetHireOfferList
    • UpdateHireOfferStatus
    • UpdateHireOfferInternStatus
    • GetHireApplicationInterviewList
    • GetHireOfferSchema
    • UpdateHireEHRImportTask
    • MakeHireTransferOnboardByApplication
    • UpdateHireEmployee
    • GetHireEmployeeByApplication
    • GetHireEmployee
    • CreateHireNote
    • UpdateHireNote
    • GetHireNote
    • GetHireNoteList
    • GetHireResumeSource
    • CreateHireEcoAccountCustomField
    • BatchUpdateHireEcoAccountCustomField
    • BatchDeleteHireEcoAccountCustomField
    • CreateHireEcoBackgroundCheckCustomField
    • BatchUpdateHireEcoBackgroundCheckCustomField
    • BatchDeleteHireEcoBackgroundCheckCustomField
    • CreateHireEcoBackgroundCheckPackage
    • BatchUpdateHireEcoBackgroundCheckPackage
    • BatchDeleteHireEcoBackgroundCheckPackage
    • UpdateHireEcoBackgroundCheckProgress
    • UpdateHireEcoBackgroundCheckResult
    • CancelHireEcoBackgroundCheck
    • CreateHireEcoExamPaper
    • BatchUpdateHireEcoExamPaper
    • BatchDeleteHireEcoExamPaper
    • CreateHireEcoExamLoginInfo
    • UpdateHiredEcoExamResult
    • CreateHireReferralAccount
    • DeactivateHireReferralAccount
    • WithdrawHireReferralAccount
    • ReconcileHireReferralAccount
  • HumanAuth
    • GetFaceVerifyAuthResult
    • UploadFaceVerifyImage
    • CropFaceVerifyImage
    • CreateIdentity
  • Jssdk
    • GetJssdkTicket
  • Lingo
    • CreateLingoDraft
    • UpdateLingoDraft
    • DeleteLingoEntity
    • CreateLingoEntity
    • UpdateLingoEntity
    • GetLingoEntity
    • GetLingoEntityList
    • MatchLingoEntity
    • SearchLingoEntity
    • HighlightLingoEntity
    • ExtractLingoEntity
    • GetLingoClassificationList
    • GetLingoRepoList
    • UploadLingoFile
    • DownloadLingoFile
  • Mail
    • GetMailUser
    • CreateMailGroup
    • DeleteMailGroup
    • UpdateMailGroupPatch
    • UpdateMailGroup
    • GetMailGroup
    • GetMailGroupList
    • BatchCreateMailGroupManager
    • BatchDeleteMailGroupManager
    • GetMailGroupManagerList
    • CreateMailGroupMember
    • DeleteMailGroupMember
    • GetMailGroupMember
    • GetMailGroupMemberList
    • BatchCreateMailGroupMember
    • BatchDeleteMailGroupMember
    • CreateMailGroupPermissionMember
    • DeleteMailGroupPermissionMember
    • GetMailGroupPermissionMember
    • GetMailGroupPermissionMemberList
    • BatchCreateMailGroupPermissionMember
    • BatchDeleteMailGroupPermissionMember
    • CreateMailGroupAlias
    • GetMailGroupAliasList
    • DeleteMailGroupAlias
    • CreatePublicMailbox
    • GetPublicMailbox
    • GetPublicMailboxList
    • UpdatePublicMailboxPatch
    • UpdatePublicMailbox
    • DeletePublicMailbox
    • CreatePublicMailboxMember
    • GetPublicMailboxMember
    • GetPublicMailboxMemberList
    • BatchCreatePublicMailboxMember
    • BatchDeletePublicMailboxMember
    • DeletePublicMailboxMember
    • ClearPublicMailboxMember
    • CreateMailPublicMailboxAlias
    • GetMailPublicMailboxAliasList
    • DeleteMailPublicMailboxAlias
    • CreateMailUserMailboxAlias
    • DeleteMailUserMailboxAlias
    • GetMailUserMailboxAliasList
    • DeleteMailUserMailbox
  • Message
    • SendEphemeralMessage
    • SendUrgentAppMessage
    • SendUrgentSmsMessage
    • SendUrgentPhoneMessage
    • SendRawMessage
    • SendRawMessageOld
    • BatchSendOldRawMessage
    • ReplyRawMessage
    • UpdateMessageEdit
    • DeleteMessage
    • ForwardMessage
    • MergeForwardMessage
    • BatchDeleteMessage
    • UpdateMessage
    • UpdateMessageDelay
    • GetMessageReadUserList
    • GetBatchSentMessageReadUser
    • GetBatchSentMessageProgress
    • GetMessageList
    • GetMessageFile
    • GetMessage
    • DeleteEphemeralMessage
    • CreateMessageReaction
    • GetMessageReactionList
    • DeleteMessageReaction
    • CreateMessagePin
    • DeleteMessagePin
    • GetMessagePinList
    • GetMessageSpecialFocusList
    • GetMessageSpecialFocusUnread
  • Mina
    • MinaCodeToSession
  • Minutes
    • GetMinutesStatistics
    • GetMinutesMinute
  • OKR
    • GetOKRPeriodList
    • BatchGetOKR
    • GetUserOKRList
    • DeleteOKRProgressRecord
    • UpdateOKRProgressRecord
    • GetOKRProgressRecord
    • CreateOKRProgressRecord
    • UploadOKRImage
    • GetOKRMetricSourceList
    • GetOKRMetricSourceTableList
    • BatchUpdateOKRMetricSourceTableItem
    • UpdateOKRMetricSourceTableItem
    • GetOKRMetricSourceTableItem
    • GetOKRMetricSourceTableItemList
  • Passport
    • GetPassportSession
  • Performance
    • GetPerformanceSemesterList
    • GetPerformanceStageTaskByUser
    • GetPerformanceStageTaskByPage
  • PersonalSettings
    • CreatePersonalSettingsSystemStatus
    • DeletePersonalSettingsSystemStatus
    • UpdatePersonalSettingsSystemStatus
    • GetPersonalSettingsSystemStatusList
    • BatchOpenPersonalSettingsSystemStatus
    • BatchClosePersonalSettingsSystemStatus
  • Search
    • SearchMessage
    • SearchApp
    • CreateSearchDataSource
    • GetSearchDataSource
    • UpdateSearchDataSource
    • GetSearchDataSourceList
    • DeleteSearchDataSource
    • BatchCreateSearchDataSourceItem
    • CreateSearchDataSourceItem
    • GetSearchDataSourceItem
    • DeleteSearchDataSourceItem
    • UpdateSearchSchema
    • DeleteSearchSchema
    • GetSearchSchema
    • CreateSearchSchema
  • Task
    • CreateTaskFollower
    • DeleteTaskFollower
    • BatchDeleteTaskFollower
    • GetTaskFollowerList
    • CreateTaskCollaborator
    • DeleteTaskCollaborator
    • BatchDeleteTaskCollaborator
    • GetTaskCollaboratorList
    • CreateTaskReminder
    • GetTaskReminderList
    • DeleteTaskReminder
    • CreateTask
    • GetTask
    • GetTaskList
    • DeleteTask
    • UpdateTask
    • CompleteTask
    • UncompleteTask
    • CreateTaskComment
    • GetTaskComment
    • GetTaskCommentList
    • DeleteTaskComment
    • UpdateTaskComment
  • Tenant
    • GetTenantProductAssignInfo
    • GetTenant
  • VC
    • ApplyVCReserve
    • UpdateVCReserve
    • DeleteVCReserve
    • GetVCReserve
    • GetVCReserveActiveMeeting
    • GetVCMeeting
    • ListVCMeetingByNo
    • InviteVCMeeting
    • KickoutVCMeeting
    • SetVCHostMeeting
    • EndVCMeeting
    • StartVCMeetingRecording
    • StopVCMeetingRecording
    • GetVCMeetingRecording
    • SetVCPermissionMeetingRecording
    • GetVCDailyReport
    • GetVCTopUserReport
    • GetVCRoomList
    • GetVCRoom
    • BatchGetVCRoom
    • CreateVCRoom
    • UpdateVCRoom
    • DeleteVCRoom
    • SearchVCRoom
    • GetVCRoomLevelList
    • GetVCRoomLevel
    • BatchGetVCRoomLevel
    • CreateVCRoomLevel
    • UpdateVCRoomLevel
    • DeleteVCRoomLevel
    • SearchVCRoomLevel
    • SetVCScopeConfig
    • GetVCScopeConfig
    • GetVCReserveConfig
    • UpdateVCReserveConfig
    • GetVCReserveConfigForm
    • UpdateVCReserveConfigForm
    • GetVCReserveConfigAdmin
    • UpdateVCReserveConfigAdmin
    • GetVCReserveConfigDisableInform
    • UpdateVCReserveConfigDisableInform
    • ExportVCMeetingList
    • ExportVCParticipantList
    • ExportVCParticipantQualityList
    • ExportVCResourceReservationList
    • GetVCExportTask
    • DownloadVCExportFile
    • GetVCAlertList
    • GetVCMeetingList
    • GetVCParticipantList
    • GetVCParticipantQualityList
    • GetVCResourceReservationList
  • Verification
    • GetVerification

Usage

Example: create lark client
  • 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"),
)
Example: handle event callback

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))
Example: ISV APP

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: ptrString("<CHAT_NAME_1>"),
})
fmt.Println(resp, err)
Example: get bot info

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)
Example: send message

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)
Example: other message

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)
Example: chat

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: ptrString("<CHAT_NAME>"),
})
fmt.Println(resp, err)
Example: file

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)
Example: calendar

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: ptrString("<SUMMARY>"),
})
fmt.Println(resp, err)

Documentation

Overview

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

*

  • Copyright 2022 chyroc *
  • Licensed under the Apache License, Version 2.0 (the "License");
  • you may not use this file except in compliance with the License.
  • You may obtain a copy of the License at *
  • http://www.apache.org/licenses/LICENSE-2.0 *
  • Unless required by applicable law or agreed to in writing, software
  • distributed under the License is distributed on an "AS IS" BASIS,
  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  • See the License for the specific language governing permissions and
  • limitations under the License.

Index

Constants

View Source
const (
	CalendarPermissionPrivate          = "private"             // 私密
	CalendarPermissionShowOnlyFreeBusy = "show_only_free_busy" // 仅展示忙闲信息
	CalendarPermissionPublic           = "public"              // 他人可查看日程详情
)

CalendarPermissionPrivate ...

Variables

View Source
var AppLink = New().AppLink

AppLink ref Lark.AppLink instance

View Source
var AtBuilder atBuilder

AtBuilder ...

View Source
var ErrStoreNotFound = errors.New("store not found")

ErrStoreNotFound ...

View Source
var MdBuilder mdBuilder

MdBuilder Markdown标签

doc: https://open.feishu.cn/document/ukTMukTMukTM/uADOwUjLwgDM14CM4ATN doc: https://open.feishu.cn/document/common-capabilities/message-card/message-cards-content/using-markdown-tags

Functions

func GetErrorCode

func GetErrorCode(err error) int64

GetErrorCode ...

func NewError added in v0.0.3

func NewError(scope, funcName string, code int64, msg string) error

NewError ...

Types

type ACSService added in v0.0.66

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

func (*ACSService) GetACSAccessRecordList added in v0.0.66

func (r *ACSService) GetACSAccessRecordList(ctx context.Context, request *GetACSAccessRecordListReq, options ...MethodOptionFunc) (*GetACSAccessRecordListResp, *Response, error)

GetACSAccessRecordList 用户在门禁考勤机上成功开门或打卡后, 智能门禁应用都会生成一条门禁记录。

该接口返回满足查询参数的识别记录。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list new doc: https://open.feishu.cn/document/server-docs/acs-v1/access_record/list

func (*ACSService) GetACSAccessRecordPhoto added in v0.0.66

func (r *ACSService) GetACSAccessRecordPhoto(ctx context.Context, request *GetACSAccessRecordPhotoReq, options ...MethodOptionFunc) (*GetACSAccessRecordPhotoResp, *Response, error)

GetACSAccessRecordPhoto 用户在门禁考勤机上成功开门或打卡后, 智能门禁应用都会生成一条门禁记录, 对于使用人脸识别方式进行开门的识别记录, 还会有抓拍图。

可以用该接口下载开门时的人脸识别照片。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get new doc: https://open.feishu.cn/document/server-docs/acs-v1/access_record/get

func (*ACSService) GetACSDeviceList added in v0.0.66

func (r *ACSService) GetACSDeviceList(ctx context.Context, request *GetACSDeviceListReq, options ...MethodOptionFunc) (*GetACSDeviceListResp, *Response, error)

GetACSDeviceList 使用该接口获取租户内所有门禁设备。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list new doc: https://open.feishu.cn/document/server-docs/acs-v1/device/list

func (*ACSService) GetACSUser added in v0.0.66

func (r *ACSService) GetACSUser(ctx context.Context, request *GetACSUserReq, options ...MethodOptionFunc) (*GetACSUserResp, *Response, error)

GetACSUser 该接口用于获取智能门禁中单个用户的信息。

只能获取已加入智能门禁权限组的用户

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get new doc: https://open.feishu.cn/document/server-docs/acs-v1/user/get

func (*ACSService) GetACSUserFace added in v0.0.66

func (r *ACSService) GetACSUserFace(ctx context.Context, request *GetACSUserFaceReq, options ...MethodOptionFunc) (*GetACSUserFaceResp, *Response, error)

GetACSUserFace 对于已经录入人脸图片的用户, 可以使用该接口下载用户人脸图片。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get new doc: https://open.feishu.cn/document/server-docs/acs-v1/user/get-2

func (*ACSService) GetACSUserList added in v0.0.66

func (r *ACSService) GetACSUserList(ctx context.Context, request *GetACSUserListReq, options ...MethodOptionFunc) (*GetACSUserListResp, *Response, error)

GetACSUserList 使用该接口获取智能门禁中所有用户信息。

只能获取已加入智能门禁权限组的用户。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list new doc: https://open.feishu.cn/document/server-docs/acs-v1/user/list

func (*ACSService) UpdateACSUser added in v0.0.66

func (r *ACSService) UpdateACSUser(ctx context.Context, request *UpdateACSUserReq, options ...MethodOptionFunc) (*UpdateACSUserResp, *Response, error)

UpdateACSUser 飞书智能门禁在人脸识别成功后会有韦根信号输出, 输出用户的卡号。

对于使用韦根协议的门禁系统, 企业可使用该接口录入用户卡号。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch new doc: https://open.feishu.cn/document/server-docs/acs-v1/user/patch

func (*ACSService) UpdateACSUserFace added in v0.0.66

func (r *ACSService) UpdateACSUserFace(ctx context.Context, request *UpdateACSUserFaceReq, options ...MethodOptionFunc) (*UpdateACSUserFaceResp, *Response, error)

UpdateACSUserFace 用户需要录入人脸图片才可以使用门禁考勤机。使用该 API 上传门禁用户的人脸图片。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update new doc: https://open.feishu.cn/document/server-docs/acs-v1/user/update

type AIService added in v0.0.9

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

func (*AIService) DetectFaceAttributes added in v0.0.61

func (r *AIService) DetectFaceAttributes(ctx context.Context, request *DetectFaceAttributesReq, options ...MethodOptionFunc) (*DetectFaceAttributesResp, *Response, error)

DetectFaceAttributes 检测图片中的人脸属性和质量等信息。

注意: 返回值为 -1 表示该功能还暂未实现

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/face_detection-v1/image/detect_face_attributes

Deprecated

func (*AIService) DetectTextLanguage added in v0.0.9

func (r *AIService) DetectTextLanguage(ctx context.Context, request *DetectTextLanguageReq, options ...MethodOptionFunc) (*DetectTextLanguageResp, *Response, error)

DetectTextLanguage 机器翻译 (MT), 支持 100 多种语言识别, 返回符合 ISO 639-1 标准。

单租户限流: 20QPS, 同租户下的应用没有限流, 共享本租户的 20QPS 限流。免费版不支持调用。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/detect new doc: https://open.feishu.cn/document/server-docs/ai/translation-v1/detect

func (*AIService) ExtractAIContractField added in v0.0.113

func (r *AIService) ExtractAIContractField(ctx context.Context, request *ExtractAIContractFieldReq, options ...MethodOptionFunc) (*ExtractAIContractFieldResp, *Response, error)

ExtractAIContractField 支持从doc、docx和pdf文件类型中提取合同字段

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/contract/field_extraction new doc: https://open.feishu.cn/document/server-docs/ai/document_ai-v1/contract/field_extraction

func (*AIService) RecognizeAIBankCard added in v0.0.113

func (r *AIService) RecognizeAIBankCard(ctx context.Context, request *RecognizeAIBankCardReq, options ...MethodOptionFunc) (*RecognizeAIBankCardResp, *Response, error)

RecognizeAIBankCard 银行卡识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/bank_card/recognize

func (*AIService) RecognizeAIBusinessCard added in v0.0.113

func (r *AIService) RecognizeAIBusinessCard(ctx context.Context, request *RecognizeAIBusinessCardReq, options ...MethodOptionFunc) (*RecognizeAIBusinessCardResp, *Response, error)

RecognizeAIBusinessCard 名片识别接口, 通过上传 JPG / PNG / PDF 等文件类型进行一次性的名片识别。接口适用于20MB以下的文件, 适用于英文、日语的名片。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/business_card/recognize new doc: https://open.feishu.cn/document/server-docs/ai/document_ai-v1/business_card/recognize

func (*AIService) RecognizeAIBusinessLicense added in v0.0.113

func (r *AIService) RecognizeAIBusinessLicense(ctx context.Context, request *RecognizeAIBusinessLicenseReq, options ...MethodOptionFunc) (*RecognizeAIBusinessLicenseResp, *Response, error)

RecognizeAIBusinessLicense 营业执照识别接口, 支持JPG/JPEG/PNG/BMP/PDF五种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/business_license/recognize

func (*AIService) RecognizeAIChinesePassport added in v0.0.113

func (r *AIService) RecognizeAIChinesePassport(ctx context.Context, request *RecognizeAIChinesePassportReq, options ...MethodOptionFunc) (*RecognizeAIChinesePassportResp, *Response, error)

RecognizeAIChinesePassport 中国护照识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/chinese_passport/recognize

func (*AIService) RecognizeAIDrivingLicense added in v0.0.113

func (r *AIService) RecognizeAIDrivingLicense(ctx context.Context, request *RecognizeAIDrivingLicenseReq, options ...MethodOptionFunc) (*RecognizeAIDrivingLicenseResp, *Response, error)

RecognizeAIDrivingLicense 驾驶证识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/driving_license/recognize

func (*AIService) RecognizeAIFoodManageLicense added in v0.0.113

func (r *AIService) RecognizeAIFoodManageLicense(ctx context.Context, request *RecognizeAIFoodManageLicenseReq, options ...MethodOptionFunc) (*RecognizeAIFoodManageLicenseResp, *Response, error)

RecognizeAIFoodManageLicense 食品经营许可证识别接口, 支持JPG/JPEG/PNG/BMP/PDF五种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/food_manage_license/recognize

func (*AIService) RecognizeAIFoodProduceLicense added in v0.0.113

func (r *AIService) RecognizeAIFoodProduceLicense(ctx context.Context, request *RecognizeAIFoodProduceLicenseReq, options ...MethodOptionFunc) (*RecognizeAIFoodProduceLicenseResp, *Response, error)

RecognizeAIFoodProduceLicense 食品生产许可证识别接口, 支持JPG/JPEG/PNG/BMP/PDF五种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/food_produce_license/recognize

func (*AIService) RecognizeAIHealthCertificate added in v0.0.113

func (r *AIService) RecognizeAIHealthCertificate(ctx context.Context, request *RecognizeAIHealthCertificateReq, options ...MethodOptionFunc) (*RecognizeAIHealthCertificateResp, *Response, error)

RecognizeAIHealthCertificate 健康证识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/health_certificate/recognize

func (*AIService) RecognizeAIHkmMainlandTravelPermit added in v0.0.113

func (r *AIService) RecognizeAIHkmMainlandTravelPermit(ctx context.Context, request *RecognizeAIHkmMainlandTravelPermitReq, options ...MethodOptionFunc) (*RecognizeAIHkmMainlandTravelPermitResp, *Response, error)

RecognizeAIHkmMainlandTravelPermit 港澳居民来往内地通行证识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/hkm_mainland_travel_permit/recognize

func (*AIService) RecognizeAITaxiInvoice added in v0.0.113

func (r *AIService) RecognizeAITaxiInvoice(ctx context.Context, request *RecognizeAITaxiInvoiceReq, options ...MethodOptionFunc) (*RecognizeAITaxiInvoiceResp, *Response, error)

RecognizeAITaxiInvoice 出租车发票识别接口, 支持JPG/JPEG/PNG/PDF/OFD五种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/taxi_invoice/recognize

func (*AIService) RecognizeAITrainInvoice added in v0.0.113

func (r *AIService) RecognizeAITrainInvoice(ctx context.Context, request *RecognizeAITrainInvoiceReq, options ...MethodOptionFunc) (*RecognizeAITrainInvoiceResp, *Response, error)

RecognizeAITrainInvoice 火车票识别接口, 支持JPG/JPEG/PNG/PDF/OFD五种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/train_invoice/recognize

func (*AIService) RecognizeAITwMainlandTravelPermit added in v0.0.113

func (r *AIService) RecognizeAITwMainlandTravelPermit(ctx context.Context, request *RecognizeAITwMainlandTravelPermitReq, options ...MethodOptionFunc) (*RecognizeAITwMainlandTravelPermitResp, *Response, error)

RecognizeAITwMainlandTravelPermit 台湾居民来往大陆通行证识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/tw_mainland_travel_permit/recognize

func (*AIService) RecognizeAIVatInvoice added in v0.0.113

func (r *AIService) RecognizeAIVatInvoice(ctx context.Context, request *RecognizeAIVatInvoiceReq, options ...MethodOptionFunc) (*RecognizeAIVatInvoiceResp, *Response, error)

RecognizeAIVatInvoice 增值税发票识别接口, 支持JPG/JPEG/PNG/PDF/BMP五种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vat_invoice/recognize

func (*AIService) RecognizeAIVehicleInvoice added in v0.0.113

func (r *AIService) RecognizeAIVehicleInvoice(ctx context.Context, request *RecognizeAIVehicleInvoiceReq, options ...MethodOptionFunc) (*RecognizeAIVehicleInvoiceResp, *Response, error)

RecognizeAIVehicleInvoice 机动车发票识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vehicle_invoice/recognize

func (*AIService) RecognizeAIVehicleLicense added in v0.0.113

func (r *AIService) RecognizeAIVehicleLicense(ctx context.Context, request *RecognizeAIVehicleLicenseReq, options ...MethodOptionFunc) (*RecognizeAIVehicleLicenseResp, *Response, error)

RecognizeAIVehicleLicense 行驶证识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/vehicle_license/recognize

func (*AIService) RecognizeAiidCard added in v0.0.113

func (r *AIService) RecognizeAiidCard(ctx context.Context, request *RecognizeAiidCardReq, options ...MethodOptionFunc) (*RecognizeAiidCardResp, *Response, error)

RecognizeAiidCard 身份证识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。

单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/id_card/recognize

func (*AIService) RecognizeBasicImage added in v0.0.9

func (r *AIService) RecognizeBasicImage(ctx context.Context, request *RecognizeBasicImageReq, options ...MethodOptionFunc) (*RecognizeBasicImageResp, *Response, error)

RecognizeBasicImage 可识别图片中的文字, 按图片中的区域划分, 分段返回文本列表。

单租户限流: 20QPS, 同租户下的应用没有限流, 共享本租户的 20QPS 限流

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize new doc: https://open.feishu.cn/document/server-docs/ai/optical_char_recognition-v1/basic_recognize

func (*AIService) RecognizeSpeechFile added in v0.0.9

func (r *AIService) RecognizeSpeechFile(ctx context.Context, request *RecognizeSpeechFileReq, options ...MethodOptionFunc) (*RecognizeSpeechFileResp, *Response, error)

RecognizeSpeechFile 语音文件识别接口, 上传整段语音文件进行一次性识别。接口适合 60 秒以内音频识别。

单租户限流: 20QPS, 同租户下的应用没有限流, 共享本租户的 20QPS 限流。免费版不支持调用。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/file_recognize new doc: https://open.feishu.cn/document/server-docs/ai/speech_to_text-v1/file_recognize

func (*AIService) RecognizeSpeechStream added in v0.0.9

func (r *AIService) RecognizeSpeechStream(ctx context.Context, request *RecognizeSpeechStreamReq, options ...MethodOptionFunc) (*RecognizeSpeechStreamResp, *Response, error)

RecognizeSpeechStream 语音流式接口, 将整个音频文件分片进行传入模型。能够实时返回数据。建议每个音频分片的大小为 100-200ms。

单租户限流: 20 路(一个 stream_id 称为一路会话), 同租户下的应用没有限流, 共享本租户的 20路限流。免费版不支持调用。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/stream_recognize new doc: https://open.feishu.cn/document/server-docs/ai/speech_to_text-v1/stream_recognize

func (*AIService) TranslateText added in v0.0.9

func (r *AIService) TranslateText(ctx context.Context, request *TranslateTextReq, options ...MethodOptionFunc) (*TranslateTextResp, *Response, error)

TranslateText 机器翻译 (MT), 支持以下语种互译:

"zh": 汉语; "zh-Hant": 繁体汉语; "en": 英语; "ja": 日语; "ru": 俄语; "de": 德语; "fr": 法语; "it": 意大利语; "pl": 波兰语; "th": 泰语; "hi": 印地语; "id": 印尼语; "es": 西班牙语; "pt": 葡萄牙语; "ko": 朝鲜语; "vi": 越南语; 单租户限流: 20QPS, 同租户下的应用没有限流, 共享本租户的 20QPS 限流。免费版不支持调用。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/translate new doc: https://open.feishu.cn/document/server-docs/ai/translation-v1/translate

type ActiveCoreHRCostCenterReq added in v0.0.113

type ActiveCoreHRCostCenterReq struct {
	CostCenterID    string  `path:"cost_center_id" json:"-"`    // 成本中心ID, 示例值: "6862995757234914824"
	UserIDType      *IDType `query:"user_id_type" json:"-"`     // 用户 ID 类型, 示例值: people_corehr_id, 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), people_corehr_id: 以飞书人事的 ID 来识别用户, 默认值: `people_corehr_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
	EffectiveTime   string  `json:"effective_time,omitempty"`   // 生效时间, 示例值: "2020-01-01"
	Active          bool    `json:"active,omitempty"`           // 启用停用状态, 示例值: true
	OperationReason string  `json:"operation_reason,omitempty"` // 操作原因, 示例值: "强行操作"
}

ActiveCoreHRCostCenterReq ...

type ActiveCoreHRCostCenterResp added in v0.0.113

type ActiveCoreHRCostCenterResp struct {
	CostCenter *ActiveCoreHRCostCenterRespCostCenter `json:"cost_center,omitempty"` // 成本中心结果
}

ActiveCoreHRCostCenterResp ...

type ActiveCoreHRCostCenterRespCostCenter added in v0.0.113

type ActiveCoreHRCostCenterRespCostCenter struct {
	CostCenterID       string                                             `json:"cost_center_id,omitempty"`        // 成本中心ID
	Name               []*ActiveCoreHRCostCenterRespCostCenterName        `json:"name,omitempty"`                  // 成本中心名称
	Code               string                                             `json:"code,omitempty"`                  // 编码
	ParentCostCenterID string                                             `json:"parent_cost_center_id,omitempty"` // 上级成本中心ID
	Managers           []string                                           `json:"managers,omitempty"`              // 成本中心负责人ID 列表
	Description        []*ActiveCoreHRCostCenterRespCostCenterDescription `json:"description,omitempty"`           // 成本中心描述
	EffectiveTime      string                                             `json:"effective_time,omitempty"`        // 生效时间
	ExpirationTime     string                                             `json:"expiration_time,omitempty"`       // 过期时间
	Active             bool                                               `json:"active,omitempty"`                // 当前实体是否启用
}

ActiveCoreHRCostCenterRespCostCenter ...

type ActiveCoreHRCostCenterRespCostCenterDescription added in v0.0.113

type ActiveCoreHRCostCenterRespCostCenterDescription struct {
	Lang  string `json:"lang,omitempty"`  // 语言
	Value string `json:"value,omitempty"` // 内容
}

ActiveCoreHRCostCenterRespCostCenterDescription ...

type ActiveCoreHRCostCenterRespCostCenterName added in v0.0.113

type ActiveCoreHRCostCenterRespCostCenterName struct {
	Lang  string `json:"lang,omitempty"`  // 语言
	Value string `json:"value,omitempty"` // 内容
}

ActiveCoreHRCostCenterRespCostCenterName ...

type AddApprovalInstanceSignReq added in v0.0.67

type AddApprovalInstanceSignReq struct {
	ApprovalCode   string   `json:"approval_code,omitempty"`     // 审批定义 Code
	InstanceCode   string   `json:"instance_code,omitempty"`     // 审批实例 Code
	UserID         string   `json:"user_id,omitempty"`           // 操作用户
	TaskID         string   `json:"task_id,omitempty"`           // 任务 ID 审批实例详情task_list中id, 详情请参考[](https://open.feishu.cn/document/ukTMukTMukTM/uEDNyUjLxQjM14SM0ITN)
	Comment        *string  `json:"comment,omitempty"`           // 意见
	AddSignUserIDs []string `json:"add_sign_user_ids,omitempty"` // 被加签人id
	AddSignType    int64    `json:"add_sign_type,omitempty"`     // 1/2/3分别代表前加签/后加签/并加签
	ApprovalMethod *int64   `json:"approval_method,omitempty"`   // 仅在前加签、后加签时需要填写, 1/2 分别代表或签/会签
}

AddApprovalInstanceSignReq ...

type AddApprovalInstanceSignResp added in v0.0.67

type AddApprovalInstanceSignResp struct {
}

AddApprovalInstanceSignResp ...

type AddBotToChatReq added in v0.0.24

type AddBotToChatReq struct {
	ChatID string `json:"chat_id,omitempty"` // 群的id
}

AddBotToChatReq ...

type AddBotToChatResp added in v0.0.24

type AddBotToChatResp struct {
}

AddBotToChatResp ...

type AddChatMemberReq added in v0.0.13

type AddChatMemberReq struct {
	ChatID       string   `path:"chat_id" json:"-"`         // 群 ID, 详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description), 注意: 仅支持群模式为`group`、`topic`的群组ID, 示例值: "oc_a0553eda9014c201e6969b478895c230"
	MemberIDType *IDType  `query:"member_id_type" json:"-"` // 进群成员 ID 类型 open_id/user_id/union_id/app_id, 注意: 拉机器人入群请使用 [app_id], 示例值: open_id, 可选值有: user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), app_id: 飞书开放平台应用的唯一标识。在创建应用时, 由系统自动生成, 用户不能自行修改。[了解更多: 如何获取应用的 App ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id), 默认值: `open_id`
	SucceedType  *int64   `query:"succeed_type" json:"-"`   // 出现不可用ID后的处理方式 0/1/2, 示例值: 0, 可选值有: 0: 兼容之前的策略, 不存在/不可见的 ID 会拉群失败, 并返回错误响应。存在已离职 ID 时, 会将其他可用 ID 拉入群聊, 返回拉群成功的响应。, 1: 将参数中可用的 ID 全部拉入群聊, 返回拉群成功的响应, 并展示剩余不可用的 ID 及原因。, 2: 参数中只要存在任一不可用的 ID, 就会拉群失败, 返回错误响应, 并展示出不可用的 ID。
	IDList       []string `json:"id_list,omitempty"`        // 成员ID列表。邀请用户进群时推荐使用 OpenID, 获取方式可参考文档[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid);邀请机器人进群时需填写应用的App ID, 请参考[如何获取应用的 App ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id), 注意: 成员列表不可为空, 列表中填写的成员ID类型应与 [member_id_type] 参数中选择的类型相对应, 每次请求最多拉50个用户且不超过群人数上限。对于已认证企业的飞书的群人数默认上限: 普通群5000人, 会议群3000人, 话题群5000人。若租户管理员配置了群人数上限, 则群人数上限为该人数上限, 最多同时邀请5个机器人, 且邀请后群组中机器人数量不能超过 15 个, 示例值: ["4d7a3c6g"]
}

AddChatMemberReq ...

type AddChatMemberResp added in v0.0.13

type AddChatMemberResp struct {
	InvalidIDList         []string `json:"invalid_id_list,omitempty"`          // 无效成员列表, 注意: 当`success_type=0`时, `invalid_id_list`只包含已离职的用户ID, 当`success_type=1`时, `invalid_id_list`中包含已离职的、不可见的、应用未激活的ID
	NotExistedIDList      []string `json:"not_existed_id_list,omitempty"`      // ID不存在的成员列表
	PendingApprovalIDList []string `json:"pending_approval_id_list,omitempty"` // 等待群主或管理员审批的成员ID列表
}

AddChatMemberResp ...

type AddContactGroupMemberReq added in v0.0.69

type AddContactGroupMemberReq struct {
	GroupID      string `path:"group_id" json:"-"`        // 用户组ID, 示例值: "g281721"
	MemberType   string `json:"member_type,omitempty"`    // 用户组成员的类型, 取值为 user, 示例值: "user", 可选值有: user: 用户成员, 默认值: `user`
	MemberIDType IDType `json:"member_id_type,omitempty"` // 当member_type =user时候, member_id_type表示user_id_type, 枚举值为open_id, union_id, user_id, 示例值: "open_id", 可选值有: open_id: member_type =user时候, 表示用户的open_id, union_id: member_type =user时候, 表示用户的union_id, user_id: member_type =user时候, 表示用户的user_id
	MemberID     string `json:"member_id,omitempty"`      // 添加的成员ID, 示例值: "ou_7dab8a3d3cdcc9da365777c7ad535d62"
}

AddContactGroupMemberReq ...

type AddContactGroupMemberResp added in v0.0.69

type AddContactGroupMemberResp struct {
}

AddContactGroupMemberResp ...

type AddHireTalentToFolderReq added in v0.0.111

type AddHireTalentToFolderReq struct {
	TalentIDList []string `json:"talent_id_list,omitempty"` // 人才 ID 列表, 示例值: ["7039620186502138157"], 最大长度: `50`
	FolderID     *string  `json:"folder_id,omitempty"`      // 文件夹 ID, 示例值: "7039620186502138156"
}

AddHireTalentToFolderReq ...

type AddHireTalentToFolderResp added in v0.0.111

type AddHireTalentToFolderResp struct {
	TalentIDList []string `json:"talent_id_list,omitempty"` // 人才 ID 列表
	FolderID     string   `json:"folder_id,omitempty"`      // 文件夹 ID
}

AddHireTalentToFolderResp ...

type AddMemberPermission added in v0.0.13

type AddMemberPermission string

AddMemberPermission 加 user/bot 入群权限

const (
	AddMemberPermissionAllMembers AddMemberPermission = "all_members"
	AddMemberPermissionOnlyOwner  AddMemberPermission = "only_owner"
)

AddMemberPermissionAllMembers ...

func AddMemberPermissionPtr added in v0.0.13

func AddMemberPermissionPtr(v AddMemberPermission) *AddMemberPermission

AddMemberPermissionPtr ...

type AddSheetDimensionRangeReq added in v0.0.15

type AddSheetDimensionRangeReq struct {
	SpreadSheetToken string                              `path:"spreadsheetToken" json:"-"` // spreadsheet 的 token, 详见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)
	Dimension        *AddSheetDimensionRangeReqDimension `json:"dimension,omitempty"`       // 需要增加行列的维度信息
}

AddSheetDimensionRangeReq ...

type AddSheetDimensionRangeReqDimension added in v0.0.15

type AddSheetDimensionRangeReqDimension struct {
	SheetID        string `json:"sheetId,omitempty"`        // sheetId
	MajorDimension string `json:"majorDimension,omitempty"` // 可选 ROWS、COLUMNS
	Length         int64  `json:"length,omitempty"`         // 要增加的行/列数, 0<length<5000
}

AddSheetDimensionRangeReqDimension ...

type AddSheetDimensionRangeResp added in v0.0.15

type AddSheetDimensionRangeResp struct {
	AddCount       int64  `json:"addCount,omitempty"`       // 增加的行/列数
	MajorDimension string `json:"majorDimension,omitempty"` // 插入维度
}

AddSheetDimensionRangeResp ...

type AddWikiSpaceMemberReq added in v0.0.82

type AddWikiSpaceMemberReq struct {
	SpaceID          string `path:"space_id" json:"-"`           // 知识空间id, 示例值: "1565676577122621"
	NeedNotification *bool  `query:"need_notification" json:"-"` // 添加权限后是否通知对方, 示例值: true
	MemberType       string `json:"member_type,omitempty"`       // “openchat” - 群id, “userid” - 用户id, “email” - 邮箱, “opendepartmentid” - 部门id, “openid” - 应用openid, “unionid” - [unionid](/:ssltoken/home/user-identity-introduction/union-id, ), 示例值: "userid"
	MemberID         string `json:"member_id,omitempty"`         // 用户id, 值的类型由上面的 member_type 参数决定, 示例值: "1565676577122621"
	MemberRole       string `json:"member_role,omitempty"`       // 角色: “admin” - 管理员, “member” - 成员, 示例值: "admin"
}

AddWikiSpaceMemberReq ...

type AddWikiSpaceMemberResp added in v0.0.82

type AddWikiSpaceMemberResp struct {
	Member *AddWikiSpaceMemberRespMember `json:"member,omitempty"` // 知识空间成员
}

AddWikiSpaceMemberResp ...

type AddWikiSpaceMemberRespMember added in v0.0.82

type AddWikiSpaceMemberRespMember struct {
	MemberType string `json:"member_type,omitempty"` // “openchat” - 群id, “userid” - 用户id, “email” - 邮箱, “opendepartmentid” - 部门id, “openid” - 应用openid, “unionid” - [unionid](/:ssltoken/home/user-identity-introduction/union-id, )
	MemberID   string `json:"member_id,omitempty"`   // 用户id, 值的类型由上面的 member_type 参数决定
	MemberRole string `json:"member_role,omitempty"` // 角色: “admin” - 管理员, “member” - 成员
}

AddWikiSpaceMemberRespMember ...

type AdminResetPasswordReq added in v0.0.96

type AdminResetPasswordReq struct {
	UserIDType IDType                         `query:"user_id_type" json:"-"` // 用户 ID 类型, 示例值: "open_id", 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), 默认值: `open_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
	Password   *AdminResetPasswordReqPassword `json:"password,omitempty"`     // 需要重置的密码参数, 不少于8个字符, 字母、数字和符号, 至少三选二, 示例值: 1234abcd
	UserID     string                         `json:"user_id,omitempty"`      // 待修改密码的用户ID, 只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效, 示例值: "abc123", 长度范围: `0` ~ `200` 字符
}

AdminResetPasswordReq ...

type AdminResetPasswordReqPassword added in v0.0.96

type AdminResetPasswordReqPassword struct {
	EntEmailPassword string `json:"ent_email_password,omitempty"` // 企业邮箱密码, 示例值: "abcd*efg"
}

AdminResetPasswordReqPassword ...

type AdminResetPasswordResp added in v0.0.96

type AdminResetPasswordResp struct {
}

AdminResetPasswordResp ...

type AdminService added in v0.0.9

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

func (*AdminService) AdminResetPassword added in v0.0.96

func (r *AdminService) AdminResetPassword(ctx context.Context, request *AdminResetPasswordReq, options ...MethodOptionFunc) (*AdminResetPasswordResp, *Response, error)

AdminResetPassword 重置用户的企业邮箱密码, 仅当用户的邮箱和企业邮箱(别名)一致时生效, 可用于处理飞书企业邮箱登录死锁的问题。

邮箱死锁: 当用户的登录凭证与飞书企业邮箱一致时, 目前飞书登录流程要求用户输入验证码, 由于飞书邮箱无单独的帐号体系, 则未登录时无法收取邮箱验证码, 即陷入死锁。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset new doc: https://open.feishu.cn/document/server-docs/admin-v1/password/reset

func (*AdminService) CreateAdminBadge added in v0.0.98

func (r *AdminService) CreateAdminBadge(ctx context.Context, request *CreateAdminBadgeReq, options ...MethodOptionFunc) (*CreateAdminBadgeResp, *Response, error)

CreateAdminBadge 使用该接口可以创建一枚完整的勋章信息, 一个租户下最多可创建1000枚勋章。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/create-2

func (*AdminService) CreateAdminBadgeGrant added in v0.0.98

func (r *AdminService) CreateAdminBadgeGrant(ctx context.Context, request *CreateAdminBadgeGrantReq, options ...MethodOptionFunc) (*CreateAdminBadgeGrantResp, *Response, error)

CreateAdminBadgeGrant 通过该接口可以为特定勋章创建一份授予名单, 一枚勋章下最多可创建1000份授予名单。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge-grant/create

func (*AdminService) DeleteAdminBadgeGrant added in v0.0.98

func (r *AdminService) DeleteAdminBadgeGrant(ctx context.Context, request *DeleteAdminBadgeGrantReq, options ...MethodOptionFunc) (*DeleteAdminBadgeGrantResp, *Response, error)

DeleteAdminBadgeGrant 通过该接口可以删除特定授予名单的信息。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge-grant/delete

func (*AdminService) GetAdminBadge added in v0.0.98

func (r *AdminService) GetAdminBadge(ctx context.Context, request *GetAdminBadgeReq, options ...MethodOptionFunc) (*GetAdminBadgeResp, *Response, error)

GetAdminBadge 可以通过该接口查询勋章的详情。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/get

func (*AdminService) GetAdminBadgeGrant added in v0.0.98

func (r *AdminService) GetAdminBadgeGrant(ctx context.Context, request *GetAdminBadgeGrantReq, options ...MethodOptionFunc) (*GetAdminBadgeGrantResp, *Response, error)

GetAdminBadgeGrant 通过该接口可以获取特定授予名单的信息。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge-grant/get

func (*AdminService) GetAdminBadgeGrantList added in v0.0.98

func (r *AdminService) GetAdminBadgeGrantList(ctx context.Context, request *GetAdminBadgeGrantListReq, options ...MethodOptionFunc) (*GetAdminBadgeGrantListResp, *Response, error)

GetAdminBadgeGrantList 通过该接口可以获取特定勋章下的授予名单列表, 授予名单的排列顺序按照创建时间倒序排列。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge-grant/list

func (*AdminService) GetAdminBadgeList added in v0.0.98

func (r *AdminService) GetAdminBadgeList(ctx context.Context, request *GetAdminBadgeListReq, options ...MethodOptionFunc) (*GetAdminBadgeListResp, *Response, error)

GetAdminBadgeList 可以通过该接口列出租户下所有的勋章, 勋章的排列顺序是按照创建时间倒序排列。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/list

func (*AdminService) GetAdminDeptStats added in v0.0.9

func (r *AdminService) GetAdminDeptStats(ctx context.Context, request *GetAdminDeptStatsReq, options ...MethodOptionFunc) (*GetAdminDeptStatsResp, *Response, error)

GetAdminDeptStats 该接口用于获取部门维度的用户活跃和功能使用数据, 即IM(即时通讯)、日历、云文档、音视频会议、邮箱功能的使用数据。

- 只有企业自建应用才有权限调用此接口 - 当天的数据会在第二天的早上九点半产出(UTC+8)

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list new doc: https://open.feishu.cn/document/server-docs/admin-v1/data-report-management/list

func (*AdminService) GetAdminUserStats added in v0.0.9

func (r *AdminService) GetAdminUserStats(ctx context.Context, request *GetAdminUserStatsReq, options ...MethodOptionFunc) (*GetAdminUserStatsResp, *Response, error)

GetAdminUserStats 用于获取用户维度的用户活跃和功能使用数据, 即IM(即时通讯)、日历、云文档、音视频会议、邮箱功能的使用数据。

- 只有企业自建应用才有权限调用此接口 - 当天的数据会在第二天的早上九点半产出(UTC+8)

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list new doc: https://open.feishu.cn/document/server-docs/admin-v1/data-report-management/list-2

func (*AdminService) UpdateAdminBadge added in v0.0.98

func (r *AdminService) UpdateAdminBadge(ctx context.Context, request *UpdateAdminBadgeReq, options ...MethodOptionFunc) (*UpdateAdminBadgeResp, *Response, error)

UpdateAdminBadge 通过该接口可以修改勋章的信息。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/update

func (*AdminService) UpdateAdminBadgeGrant added in v0.0.98

func (r *AdminService) UpdateAdminBadgeGrant(ctx context.Context, request *UpdateAdminBadgeGrantReq, options ...MethodOptionFunc) (*UpdateAdminBadgeGrantResp, *Response, error)

UpdateAdminBadgeGrant 通过该接口可以修改特定授予名单的相关信息。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge-grant/update

func (*AdminService) UploadAdminBadgeImage added in v0.0.98

func (r *AdminService) UploadAdminBadgeImage(ctx context.Context, request *UploadAdminBadgeImageReq, options ...MethodOptionFunc) (*UploadAdminBadgeImageResp, *Response, error)

UploadAdminBadgeImage 通过该接口可以上传勋章详情图、挂饰图的文件, 获取对应的文件key。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create new doc: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/create

type AnswerHelpdeskTicketUserQueryReq added in v0.0.21

type AnswerHelpdeskTicketUserQueryReq struct {
	TicketID string                                 `path:"ticket_id" json:"-"` // 工单ID, 示例值: "6945345902185807891"
	EventID  string                                 `json:"event_id,omitempty"` // 事件ID, 可从订阅事件中提取, 示例值: "abcd"
	Faqs     []*AnswerHelpdeskTicketUserQueryReqFAQ `json:"faqs,omitempty"`     // faq结果列表
}

AnswerHelpdeskTicketUserQueryReq ...

type AnswerHelpdeskTicketUserQueryReqFAQ added in v0.0.33

type AnswerHelpdeskTicketUserQueryReqFAQ struct {
	ID    *string  `json:"id,omitempty"`    // faq服务台内唯一标识, 示例值: "12345"
	Score *float64 `json:"score,omitempty"` // faq匹配得分, 示例值: 0.9
}

AnswerHelpdeskTicketUserQueryReqFAQ ...

type AnswerHelpdeskTicketUserQueryResp added in v0.0.21

type AnswerHelpdeskTicketUserQueryResp struct {
}

AnswerHelpdeskTicketUserQueryResp ...

type ApiEndpoint added in v0.0.98

type ApiEndpoint func(ctx context.Context, rawHttpReq *RawRequestReq, resp interface{}) (*Response, error)

type ApiMiddleware added in v0.0.98

type ApiMiddleware func(ApiEndpoint) ApiEndpoint

type AppLinkService added in v0.0.66

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

func (*AppLinkService) OpenBot added in v0.0.66

func (r *AppLinkService) OpenBot(req *OpenBotReq) string

OpenBot 打开机器人会话

打开一个机器人的聊天窗。 如果访问用户没有机器人的可用性,将看到相关的引导提示。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-a-bot new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-a-bot

func (*AppLinkService) OpenCalender added in v0.0.66

func (r *AppLinkService) OpenCalender(req *OpenCalenderReq) string

OpenCalender 打开日历

跳转并打开日历,打开界面为上一次离开日历时的视图。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-calender/open-a-calender new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-calender/open-a-calender

func (*AppLinkService) OpenCalenderAccount added in v0.0.66

func (r *AppLinkService) OpenCalenderAccount(req *OpenCalenderAccountReq) string

OpenCalenderAccount 打开第三方日历账户管理页

打开第三方日历账户管理页,方便用户添加或导入谷歌/Exchange 日历。移动端打开页面,PC端打开弹层。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-calender/open new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-calender/open

func (*AppLinkService) OpenChat added in v0.0.66

func (r *AppLinkService) OpenChat(req *OpenChatReq) string

OpenChat 打开聊天页面

打开一个聊天页面,单聊会话或群聊会话

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-a-chat-page new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-a-chat-page

func (*AppLinkService) OpenDocs added in v0.0.66

func (r *AppLinkService) OpenDocs(req *OpenDocsReq) string

OpenDocs 打开云文档

打开云文档(docs)。使用外部浏览器打开文档时,提供入口从飞书中打开。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-docs new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-docs

func (*AppLinkService) OpenMiniProgram added in v0.0.66

func (r *AppLinkService) OpenMiniProgram(req *OpenMiniProgramReq) string

OpenMiniProgram 打开小程序

打开一个小程序或者小程序中的一个页面

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-a-gadget new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-a-gadget

func (*AppLinkService) OpenSSOLogin added in v0.0.66

func (r *AppLinkService) OpenSSOLogin(req *OpenSSOLoginReq) string

OpenSSOLogin 打开SSO登录页

在飞书客户端中打开租户在admin后台配置的SSO登录页

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-the-sso-login-page new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-the-sso-login-page

func (*AppLinkService) OpenTask added in v0.0.86

func (r *AppLinkService) OpenTask(req *OpenTaskReq) string

OpenTask 打开任务

打开任务首页,查看任务。

**什么是「任务」**:[任务](https://www.feishu.cn/hc/zh-CN/articles/798052212434)是一个轻量级的团队任务管理工具,可有效帮助成员:集中管理任务、追踪任务进度、推进团队协作。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-todo/open-todo new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-todo/open-todo

func (*AppLinkService) OpenTaskCreate added in v0.0.86

func (r *AppLinkService) OpenTaskCreate(req *OpenTaskCreateReq) string

OpenTaskCreate 创建任务

唤起创建任务页。

**什么是「任务」**:[任务](https://www.feishu.cn/hc/zh-CN/articles/798052212434)是一个轻量级的团队任务管理工具,可有效帮助成员:集中管理任务、追踪任务进度、推进团队协作。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-todo/create-task new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-todo/create-task

func (*AppLinkService) OpenTaskDetail added in v0.0.86

func (r *AppLinkService) OpenTaskDetail(req *OpenTaskDetailReq) string

OpenTaskDetail 打开任务详情页

唤起任务详情页。

**什么是「任务」**:[任务](https://www.feishu.cn/hc/zh-CN/articles/798052212434)是一个轻量级的团队任务管理工具,可有效帮助成员:集中管理任务、追踪任务进度、推进团队协作。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-todo/open-the-task-details-page new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-todo/open-the-task-details-page

func (*AppLinkService) OpenTaskTab added in v0.0.86

func (r *AppLinkService) OpenTaskTab(req *OpenTaskTabReq) string

OpenTaskTab 打开任务tab页

唤起任务tab页,跳转到指定tab。

**什么是「任务」**:[任务](https://www.feishu.cn/hc/zh-CN/articles/798052212434)是一个轻量级的团队任务管理工具,可有效帮助成员:集中管理任务、追踪任务进度、推进团队协作。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-todo/open-the-task-tab-page new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-todo/open-the-task-tab-page

func (*AppLinkService) OpenWebURL added in v0.0.66

func (r *AppLinkService) OpenWebURL(req *OpenWebURLReq) string

OpenWebURL 打开端内web-view访问指定URL

用户在端内点击这类applink,不必跳转外部浏览器,可以直接在聊天的侧边栏、或飞书的独立窗口中打开指定的网页。 可以配置这类applink在消息卡片的“查看详情”跳转上,使用户连贯地消费消息中的详情内容。

![image.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/761f68be5274fea59bf8145489633c88_Z6KZ6NyGCh.png?height=962&lazyload=true&maxWidth=600&width=1649)

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-the-web-view-in-feishu-to-access-the-specified-url new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-the-web-view-in-feishu-to-access-the-specified-url

func (*AppLinkService) OpenWorkbench added in v0.0.107

func (r *AppLinkService) OpenWorkbench(req *OpenWorkbenchReq) string

OpenWorkbench 打开工作台

打开工作台(定制工作台)或打开网页工作台的特定页面。

doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-a-workplace new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-a-workplace

type AppendSheetValueReq added in v0.0.8

type AppendSheetValueReq struct {
	SpreadSheetToken string                         `path:"spreadsheetToken" json:"-"`  // spreadsheet 的 token, 获取方式见[在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)
	InsertDataOption *string                        `query:"insertDataOption" json:"-"` // 遇到空行追加, 默认 OVERWRITE, 若空行的数量小于追加数据的行数, 则会覆盖已有数据;可选 INSERT_ROWS, 会在插入足够数量的行后再进行数据追加
	ValueRange       *AppendSheetValueReqValueRange `json:"valueRange,omitempty"`       // 值与范围
}

AppendSheetValueReq ...

type AppendSheetValueReqValueRange added in v0.0.8

type AppendSheetValueReqValueRange struct {
	Range  string           `json:"range,omitempty"`  // ⁣查询范围, 包含 sheetId 与单元格范围两部分, 目前支持四种索引方式, 详见 [在线表格开发指南](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。range所表示的范围需要大于等于values占用的范围。
	Values [][]SheetContent `json:"values,omitempty"` // 需要写入的值, 如要写入公式、超链接、email、@人等, 可详看附录[sheet 支持写入数据类型](https://open.feishu.cn/document/ukTMukTMukTM/ugjN1UjL4YTN14CO2UTN)
}

AppendSheetValueReqValueRange ...

type AppendSheetValueResp added in v0.0.8

type AppendSheetValueResp struct {
	SpreadSheetToken string                       `json:"spreadsheetToken,omitempty"` // spreadsheet 的 token
	TableRange       string                       `json:"tableRange,omitempty"`       // 写入的范围
	Revision         int64                        `json:"revision,omitempty"`         // sheet 的版本号
	Updates          *AppendSheetValueRespUpdates `json:"updates,omitempty"`          // 插入数据的范围、行列数等
}

AppendSheetValueResp ...

type AppendSheetValueRespUpdates added in v0.0.8

type AppendSheetValueRespUpdates struct {
	SpreadSheetToken string `json:"spreadsheetToken,omitempty"` // spreadsheet 的 token
	UpdatedRange     string `json:"updatedRange,omitempty"`     // 写入的范围
	UpdatedRows      int64  `json:"updatedRows,omitempty"`      // 写入的行数
	UpdatedColumns   int64  `json:"updatedColumns,omitempty"`   // 写入的列数
	UpdatedCells     int64  `json:"updatedCells,omitempty"`     // 写入的单元格总数
	Revision         int64  `json:"revision,omitempty"`         // sheet 的版本号
}

AppendSheetValueRespUpdates ...

type ApplicationService added in v0.0.21

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

func (*ApplicationService) CheckApplicationVisibleWhiteBlackList added in v0.0.109

CheckApplicationVisibleWhiteBlackList 该接口用于查询用户、部门、用户组是否在应用的可用或禁用名单中

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/check_white_black_list new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/check_white_black_list

func (*ApplicationService) CheckUserIsInApplicationPaidScope added in v0.0.21

CheckUserIsInApplicationPaidScope 当付费套餐是按人数收费 或者 限制最大使用人数时, 开放平台会引导企业管理员设置“付费功能开通范围”。 但是受开通范围限制, 部分用户就无法使用对应的付费功能。 可以通过此接口, 在付费功能点入口判断是否允许某个用户进入使用。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uATNwUjLwUDM14CM1ATN new doc: https://open.feishu.cn/document/server-docs/application-v6/appstore-paid-info/query-a-user's-app-access

func (*ApplicationService) GetApplication added in v0.0.92

func (r *ApplicationService) GetApplication(ctx context.Context, request *GetApplicationReq, options ...MethodOptionFunc) (*GetApplicationResp, *Response, error)

GetApplication 根据app_id获取应用的基础信息

商店应用必须正式发布版本后, 才可以调用该接口获取应用信息。如果灰度发布应用, 调用该接口将会报错 210504 错误码。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/get new doc: https://open.feishu.cn/document/server-docs/application-v6/application/get

func (*ApplicationService) GetApplicationAppAdminUserList added in v0.0.21

GetApplicationAppAdminUserList 查询审核应用的管理员列表, 返回最新10个管理员账户id列表。

doc: https://open.feishu.cn/document/ukTMukTMukTM/ucDOwYjL3gDM24yN4AjN new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/query-app-administrator-list

func (*ApplicationService) GetApplicationAppList added in v0.0.21

func (r *ApplicationService) GetApplicationAppList(ctx context.Context, request *GetApplicationAppListReq, options ...MethodOptionFunc) (*GetApplicationAppListResp, *Response, error)

GetApplicationAppList 该接口用于查询企业安装的应用列表, 只能被企业自建应用调用。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uYDN3UjL2QzN14iN0cTN new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/obtain-the-apps-installed-by-an-organization

func (*ApplicationService) GetApplicationAppVisibility added in v0.0.21

GetApplicationAppVisibility 该接口用于查询应用在该企业内可以被使用的范围, 只能被企业自建应用调用。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uIjM3UjLyIzN14iMycTN new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/obtain-the-app-availability-in-an-organization

func (*ApplicationService) GetApplicationContactsRangeConfiguration added in v0.0.109

GetApplicationContactsRangeConfiguration 获取当前企业内某个自建应用线上实际生效的通讯录权限范围配置。

通讯录权限范围是指应用在调用通讯录相关接口, 可以获取的部门和用户的数据范围。应用无法获取权限范围之外的通讯录数据。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/contacts_range_configuration

func (*ApplicationService) GetApplicationOrder added in v0.0.21

func (r *ApplicationService) GetApplicationOrder(ctx context.Context, request *GetApplicationOrderReq, options ...MethodOptionFunc) (*GetApplicationOrderResp, *Response, error)

GetApplicationOrder 该接口用于查询某个订单的具体信息

doc: https://open.feishu.cn/document/ukTMukTMukTM/uITNwUjLyUDM14iM1ATN new doc: https://open.feishu.cn/document/server-docs/application-v6/appstore-paid-info/query-order-information

func (*ApplicationService) GetApplicationOrderList added in v0.0.21

func (r *ApplicationService) GetApplicationOrderList(ctx context.Context, request *GetApplicationOrderListReq, options ...MethodOptionFunc) (*GetApplicationOrderListResp, *Response, error)

GetApplicationOrderList 该接口用于分页查询应用租户下的已付费订单, 每次购买对应一个唯一的订单, 订单会记录购买的套餐的相关信息, 业务方需要自行处理套餐的有效期和付费方案的升级。

> 备注: 免费模式的应用不会产生订单, 仅收费应用会产生订单 (含免费版)。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uETNwUjLxUDM14SM1ATN new doc: https://open.feishu.cn/document/server-docs/application-v6/appstore-paid-info/query-an-app-tenant’s-paid-orders

func (*ApplicationService) GetApplicationUnderAuditList added in v0.0.92

GetApplicationUnderAuditList 查看本企业下所有待审核的自建应用列表

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist new doc: https://open.feishu.cn/document/server-docs/application-v6/application/underauditlist

func (*ApplicationService) GetApplicationUsageDepartmentOverview added in v0.0.112

GetApplicationUsageDepartmentOverview 查看应用在某一天/某一周/某一个月的使用数据, 可以根据部门做多层子部门的筛选

1. 仅支持企业版/旗舰版租户使用 2. 一般每天早上10点产出前一天的数据 3. 已经支持的指标包括: 应用的活跃用户数、累计用户数、新增用户数、访问页面数、打开次数 4. 按照部门查看数据时, 可以分别展示当前部门以及其子部门的使用情况 5. 如果查询的部门在查询日期没有使用过应用, 只返回指标: 应用的活跃用户数指标 6. 数据从飞书4.10版本开始统计, 使用飞书版本4.10及以下版本的用户数据不会被统计到 7. 调用频控为100次/分

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/department_overview new doc: https://open.feishu.cn/document/server-docs/application-v6/app-usage/department_overview

func (*ApplicationService) GetApplicationUsageOverview added in v0.0.61

GetApplicationUsageOverview 查看应用在某一天/某一周/某一个月的使用数据, 可以查看租户整体对应用的使用情况, 也可以分部门查看。

1. 仅支持企业版/旗舰版租户使用 2. 一般每天早上10点产出前一天的数据 3. 已经支持的指标包括: 应用的活跃用户数、累计用户数、新增用户数、访问页面数、打开次数 4. 数据从飞书4.10版本开始统计, 使用飞书版本4.10及以下版本的用户数据不会被统计到 5. 按照部门查看数据时, 会展示当前部门以及其子部门的整体使用情况 6. 调用频控为100次/分

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/overview new doc: https://open.feishu.cn/document/server-docs/application-v6/app-usage/overview

func (*ApplicationService) GetApplicationUsageTrend added in v0.0.61

GetApplicationUsageTrend 查询应用在指定时间段内企业员工的使用趋势信息。

:::warning 此接口目前仅支持小程序的使用情况查询, 不支持网页应用和机器人应用的使用情况查询;仅支持查询自建应用, 不支持查询商店应用

doc: https://open.feishu.cn/document/ukTMukTMukTM/uITN0YjLyUDN24iM1QjN

func (*ApplicationService) GetApplicationUserAdminScope added in v0.0.21

GetApplicationUserAdminScope 该接口用于获取应用管理员的管理范围, 即该应用管理员能够管理哪些部门。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uMzN3QjLzczN04yM3cDN new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/obtain-an-app-admin’s-management-permissions

func (*ApplicationService) GetApplicationUserVisibleApp added in v0.0.21

GetApplicationUserVisibleApp 该接口用于查询用户可用的应用列表, 只能被企业自建应用调用。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uMjM3UjLzIzN14yMycTN new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/obtain-the-apps-available-to-a-user

func (*ApplicationService) GetApplicationVersion added in v0.0.92

func (r *ApplicationService) GetApplicationVersion(ctx context.Context, request *GetApplicationVersionReq, options ...MethodOptionFunc) (*GetApplicationVersionResp, *Response, error)

GetApplicationVersion 根据应用 ID 和应用版本 ID 来获取同租户下的应用版本的信息

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/get new doc: https://open.feishu.cn/document/server-docs/application-v6/application/get-2

func (*ApplicationService) GetApplicationVersionContactsRangeSuggest added in v0.0.109

GetApplicationVersionContactsRangeSuggest 该接口用于根据应用的 App ID 和版本 ID 获取企业自建应用某个版本的通讯录权限范围。

由于通讯录权限范围需要提交发布新的应用版本, 并且企业管理员审核通过后才会生效, 因此该权限范围可能与实际生效的权限范围有差别, 如需获取线上实际生效的通讯录权限范围, 可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration) 获取。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/contacts_range_suggest new doc: https://open.feishu.cn/document/server-docs/application-v6/application/contacts_range_suggest

func (*ApplicationService) GetApplicationVersionList added in v0.0.98

GetApplicationVersionList 根据 app_id 获取对应应用版本列表。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list new doc: https://open.feishu.cn/document/server-docs/application-v6/application/list

func (*ApplicationService) IsApplicationUserAdmin added in v0.0.21

func (r *ApplicationService) IsApplicationUserAdmin(ctx context.Context, request *IsApplicationUserAdminReq, options ...MethodOptionFunc) (*IsApplicationUserAdminResp, *Response, error)

IsApplicationUserAdmin 该接口用于查询用户是否为应用管理员。

> 此处应用管理员是指可以进入企业管理后台对应用进行审核和管理的企业管理员, 并不是应用的开发者。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uITN1EjLyUTNx4iM1UTM new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/verify-app-admin

func (*ApplicationService) SearchApplicationCustomWorkplaceAccessData added in v0.0.111

SearchApplicationCustomWorkplaceAccessData 获取定制工作台访问数据

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search

func (*ApplicationService) SearchApplicationWorkplaceAccessData added in v0.0.111

SearchApplicationWorkplaceAccessData 获取工作台访问数据(包含默认工作台与定制工作台)

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search

func (*ApplicationService) SearchApplicationWorkplaceBlockAccessData added in v0.0.111

SearchApplicationWorkplaceBlockAccessData 获取定制工作台小组件访问数据

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search

func (*ApplicationService) SetApplicationAppBadge added in v0.0.113

func (r *ApplicationService) SetApplicationAppBadge(ctx context.Context, request *SetApplicationAppBadgeReq, options ...MethodOptionFunc) (*SetApplicationAppBadgeResp, *Response, error)

SetApplicationAppBadge 更新应用红点信息, 用于工作台场景

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_badge/set new doc: https://open.feishu.cn/document/server-docs/application-v6/app_badge/set

func (*ApplicationService) UpdateApplication added in v0.0.92

func (r *ApplicationService) UpdateApplication(ctx context.Context, request *UpdateApplicationReq, options ...MethodOptionFunc) (*UpdateApplicationResp, *Response, error)

UpdateApplication 更新应用的分组信息(分组会影响应用在工作台中的分类情况, 请谨慎更新)

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/patch new doc: https://open.feishu.cn/document/server-docs/application-v6/application/patch

func (*ApplicationService) UpdateApplicationAppVisibility added in v0.0.21

UpdateApplicationAppVisibility 该接口用于更新当前企业内自建应用或已安装的商店应用的可见范围, 包括可用人员与禁用人员。更新后对线上立即生效。

当通过接口新增用户或部门时, 提前判断对应用户或部门是否已在禁用名单中, 如果已在禁用名单中, 则即便将用户或部门添加到可用名单, 该用户或部门也无法看到该应用, 即禁用名单优先级高于可用名单。

doc: https://open.feishu.cn/document/ukTMukTMukTM/ucDN3UjL3QzN14yN0cTN new doc: https://open.feishu.cn/document/server-docs/application-v6/admin/update-the-availability-of-an-app

Deprecated

func (*ApplicationService) UpdateApplicationAppVisibilityV6 added in v0.0.112

UpdateApplicationAppVisibilityV6 该接口用于更新当前企业内自建应用或已安装的商店应用的可见范围, 包括可用人员与禁用人员。更新后对线上立即生效。

当通过接口新增用户或部门时, 提前判断对应用户或部门是否已在禁用名单中, 如果已在禁用名单中, 则即便将用户或部门添加到可用名单, 该用户或部门也无法看到该应用, 即禁用名单优先级高于可用名单。 同一个成员(user_id)在30s内不能重复添加到禁用名单, 否则会导致调用失败

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/patch

func (*ApplicationService) UpdateApplicationContactsRangeConfiguration added in v0.0.112

UpdateApplicationContactsRangeConfiguration 该接口用于更新当前企业内自建应用或已安装的商店应用的通讯录权限范围配置。更新后线上立即生效。

通讯录权限范围是指应用在调用通讯录相关接口, 可以获取的部门和用户的数据范围。应用无法获取权限范围之外的通讯录数据。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-contacts_range/patch

func (*ApplicationService) UpdateApplicationVersion added in v0.0.92

UpdateApplicationVersion 通过接口来更新应用版本的审核结果: 通过后应用可以直接上架;拒绝后则开发者可以看到拒绝理由, 并在修改后再次申请发布。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/patch new doc: https://open.feishu.cn/document/server-docs/application-v6/application/patch-2

type ApplyVCReserveReq added in v0.0.17

type ApplyVCReserveReq struct {
	UserIDType      *IDType                           `query:"user_id_type" json:"-"`     // 用户 ID 类型, 示例值: open_id, 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), 默认值: `open_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
	EndTime         *string                           `json:"end_time,omitempty"`         // 预约到期时间(unix时间, 单位sec), 多人会议必填, 示例值: "1608888867"
	OwnerID         *string                           `json:"owner_id,omitempty"`         // 指定会议归属人, 使用 tenant_access_token 时生效且必传, 指定对象必须为同租户下的合法飞书用户, 使用 user_access_token 时, 该参数不生效, 设置归属人无意义, 示例值: "ou_3ec3f6a28a0d08c45d895276e8e5e19b"
	MeetingSettings *ApplyVCReserveReqMeetingSettings `json:"meeting_settings,omitempty"` // 会议设置
}

ApplyVCReserveReq ...

type ApplyVCReserveReqMeetingSettings added in v0.0.17

type ApplyVCReserveReqMeetingSettings struct {
	Topic              *string                                             `json:"topic,omitempty"`                // 会议主题, 示例值: "my meeting"
	ActionPermissions  []*ApplyVCReserveReqMeetingSettingsActionPermission `json:"action_permissions,omitempty"`   // 会议权限配置列表, 如果存在相同的权限配置项则它们之间为"逻辑或"的关系(即 有一个为true则拥有该权限)
	MeetingInitialType *int64                                              `json:"meeting_initial_type,omitempty"` // 会议初始类型, 示例值: 1, 可选值有: 1: 多人会议, 2: 1v1呼叫(仅支持预约PSTN用户)
	CallSetting        *ApplyVCReserveReqMeetingSettingsCallSetting        `json:"call_setting,omitempty"`         // 1v1呼叫相关参数
	AutoRecord         *bool                                               `json:"auto_record,omitempty"`          // 使用飞书视频会议时, 是否开启自动录制, 默认false, 示例值: true
	AssignHostList     []*ApplyVCReserveReqMeetingSettingsAssignHost       `json:"assign_host_list,omitempty"`     // 指定主持人列表
}

ApplyVCReserveReqMeetingSettings ...

type ApplyVCReserveReqMeetingSettingsActionPermission added in v0.0.17

type ApplyVCReserveReqMeetingSettingsActionPermission struct {
	Permission         int64                                                                `json:"permission,omitempty"`          // 权限项, 示例值: 1, 可选值有: 1: 是否能成为主持人, 2: 是否能邀请参会人, 3: 是否能加入会议
	PermissionCheckers []*ApplyVCReserveReqMeetingSettingsActionPermissionPermissionChecker `json:"permission_checkers,omitempty"` // 权限检查器列表, 权限检查器之间为"逻辑或"的关系(即 有一个为true则拥有该权限)
}

ApplyVCReserveReqMeetingSettingsActionPermission ...

type ApplyVCReserveReqMeetingSettingsActionPermissionPermissionChecker added in v0.0.17

type ApplyVCReserveReqMeetingSettingsActionPermissionPermissionChecker struct {
	CheckField int64    `json:"check_field,omitempty"` // 检查字段类型, 示例值: 1, 可选值有: 1: 用户ID(check_list填入用户ID), 2: 用户类型(check_list可选值有, "1": 飞书用户、, "2": rooms用户、, "6": pstn用户、, "7": sip用户), 3: 租户ID(check_list填入租户tenant_key)
	CheckMode  int64    `json:"check_mode,omitempty"`  // 检查方式, 示例值: 1, 可选值有: 1: 在check_list中为有权限(白名单), 2: 不在check_list中为有权限(黑名单)
	CheckList  []string `json:"check_list,omitempty"`  // 检查字段列表(根据check_field的类型填入对应内容), 示例值: ["ou_3ec3f6a28a0d08c45d895276e8e5e19b"]
}

ApplyVCReserveReqMeetingSettingsActionPermissionPermissionChecker ...

type ApplyVCReserveReqMeetingSettingsAssignHost added in v0.0.98

type ApplyVCReserveReqMeetingSettingsAssignHost struct {
	UserType *int64  `json:"user_type,omitempty"` // 用户类型, 仅支持设置同租户下的 Lark 用户, 示例值: 1, 可选值有: 1: 飞书用户
	ID       *string `json:"id,omitempty"`        // 用户ID, 示例值: "ou_3ec3f6a28a0d08c45d895276e8e5e19b"
}

ApplyVCReserveReqMeetingSettingsAssignHost ...

type ApplyVCReserveReqMeetingSettingsCallSetting added in v0.0.17

type ApplyVCReserveReqMeetingSettingsCallSetting struct {
	Callee *ApplyVCReserveReqMeetingSettingsCallSettingCallee `json:"callee,omitempty"` // 被呼叫的用户
}

ApplyVCReserveReqMeetingSettingsCallSetting ...

type ApplyVCReserveReqMeetingSettingsCallSettingCallee added in v0.0.17

type ApplyVCReserveReqMeetingSettingsCallSettingCallee struct {
	ID          *string                                                       `json:"id,omitempty"`            // 用户ID, 示例值: "ou_3ec3f6a28a0d08c45d895276e8e5e19b"
	UserType    int64                                                         `json:"user_type,omitempty"`     // 用户类型, 当前仅支持用户类型6(pstn用户), 示例值: 1, 可选值有: 1: 飞书用户, 2: rooms用户, 3: 文档用户, 4: neo单品用户, 5: neo单品游客用户, 6: pstn用户, 7: sip用户
	PstnSipInfo *ApplyVCReserveReqMeetingSettingsCallSettingCalleePstnSipInfo `json:"pstn_sip_info,omitempty"` // pstn/sip信息
}

ApplyVCReserveReqMeetingSettingsCallSettingCallee ...

type ApplyVCReserveReqMeetingSettingsCallSettingCalleePstnSipInfo added in v0.0.17

type ApplyVCReserveReqMeetingSettingsCallSettingCalleePstnSipInfo struct {
	Nickname    *string `json:"nickname,omitempty"`     // 给pstn/sip用户设置的临时昵称, 示例值: "dodo"
	MainAddress string  `json:"main_address,omitempty"` // pstn/sip主机号, 格式为: [国际冠字]-[电话区号][电话号码], 当前仅支持国内手机及固定电话号码, 示例值: "+86-02187654321"
}

ApplyVCReserveReqMeetingSettingsCallSettingCalleePstnSipInfo ...

type ApplyVCReserveResp added in v0.0.17

type ApplyVCReserveResp struct {
	Reserve                    *ApplyVCReserveRespReserve                    `json:"reserve,omitempty"`                       // 预约数据
	ReserveCorrectionCheckInfo *ApplyVCReserveRespReserveCorrectionCheckInfo `json:"reserve_correction_check_info,omitempty"` // 预约参数检查信息
}

ApplyVCReserveResp ...

type ApplyVCReserveRespReserve added in v0.0.17

type ApplyVCReserveRespReserve struct {
	ID        string `json:"id,omitempty"`         // 预约ID(预约的唯一标识, 非会议ID, 会议ID仅在会议开始后才生成)
	MeetingNo string `json:"meeting_no,omitempty"` // 9位会议号(飞书用户可通过输入9位会议号快捷入会)
	URL       string `json:"url,omitempty"`        // 会议链接(飞书用户可通过点击会议链接快捷入会)
	AppLink   string `json:"app_link,omitempty"`   // APPLink用于唤起飞书APP入会。"{?}"为占位符, 用于配置入会参数, 使用时需替换具体值: 0表示关闭, 1表示打开。preview为入会前的设置页, mic为麦克风, speaker为扬声器, camera为摄像头
	LiveLink  string `json:"live_link,omitempty"`  // 会议转直播链接
	EndTime   string `json:"end_time,omitempty"`   // 预约到期时间(unix时间, 单位sec)
}

ApplyVCReserveRespReserve ...

type ApplyVCReserveRespReserveCorrectionCheckInfo added in v0.0.98

type ApplyVCReserveRespReserveCorrectionCheckInfo struct {
	InvalidHostIDList []string `json:"invalid_host_id_list,omitempty"` // 指定主持人无效id列表
}

ApplyVCReserveRespReserveCorrectionCheckInfo ...

type ApprovalService added in v0.0.9

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

func (*ApprovalService) AddApprovalInstanceSign added in v0.0.67

func (r *ApprovalService) AddApprovalInstanceSign(ctx context.Context, request *AddApprovalInstanceSignReq, options ...MethodOptionFunc) (*AddApprovalInstanceSignResp, *Response, error)

AddApprovalInstanceSign 对于单个审批任务进行加签操作。

doc: https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/approval-task-addsign

func (*ApprovalService) ApproveApprovalInstance added in v0.0.18

func (r *ApprovalService) ApproveApprovalInstance(ctx context.Context, request *ApproveApprovalInstanceReq, options ...MethodOptionFunc) (*ApproveApprovalInstanceResp, *Response, error)

ApproveApprovalInstance 对于单个审批任务进行同意操作。同意后审批流程会流转到下一个审批人。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/approve

func (*ApprovalService) CancelApprovalInstance added in v0.0.18

func (r *ApprovalService) CancelApprovalInstance(ctx context.Context, request *CancelApprovalInstanceReq, options ...MethodOptionFunc) (*CancelApprovalInstanceResp, *Response, error)

CancelApprovalInstance 如果管理员在后台设置了 允许撤销审批中的申请 或者 允许撤销 x 天内通过的审批, 则在符合规则时, 提交人可以调用该接口撤回审批实例。

- 如果撤回的是审批中的实例, 则撤回后审批流程结束。 - 如果撤回的是已通过的实例, 则审批实例会变更为 审批中 的状态。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance/cancel

func (*ApprovalService) CheckApprovalExternalInstance added in v0.0.97

func (r *ApprovalService) CheckApprovalExternalInstance(ctx context.Context, request *CheckApprovalExternalInstanceReq, options ...MethodOptionFunc) (*CheckApprovalExternalInstanceResp, *Response, error)

CheckApprovalExternalInstance 校验三方审批实例数据, 用于判断服务端数据是否为最新的。用户提交实例最新更新时间, 如果服务端不存在该实例, 或者服务端实例更新时间不是最新的, 则返回对应实例 id。

例如, 用户可以每隔5分钟, 将最近5分钟产生的实例使用该接口进行对比。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check new doc: https://open.feishu.cn/document/server-docs/approval-v4/external_instance/check

func (*ApprovalService) CreateApproval added in v0.0.97

func (r *ApprovalService) CreateApproval(ctx context.Context, request *CreateApprovalReq, options ...MethodOptionFunc) (*CreateApprovalResp, *Response, error)

CreateApproval 用于通过接口创建简单的审批定义, 可以灵活指定定义的基础信息、表单和流程等。创建成功后, 不支持从审批管理后台删除该定义。不推荐企业自建应用使用, 如有需要尽量联系管理员在审批管理后台创建定义。

接口谨慎调用, 创建后的审批定义无法停用/删除

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval/create

func (*ApprovalService) CreateApprovalCarbonCopy added in v0.0.21

func (r *ApprovalService) CreateApprovalCarbonCopy(ctx context.Context, request *CreateApprovalCarbonCopyReq, options ...MethodOptionFunc) (*CreateApprovalCarbonCopyResp, *Response, error)

CreateApprovalCarbonCopy 通过接口可以将当前审批实例抄送给其他人。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance/cc

func (*ApprovalService) CreateApprovalComment added in v0.0.97

func (r *ApprovalService) CreateApprovalComment(ctx context.Context, request *CreateApprovalCommentReq, options ...MethodOptionFunc) (*CreateApprovalCommentResp, *Response, error)

CreateApprovalComment 在某审批实例下创建、修改评论或评论回复(不包含审批同意、拒绝、转交等附加的理由或意见)。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance-comment/create

func (*ApprovalService) CreateApprovalExternalApproval added in v0.0.97

CreateApprovalExternalApproval 审批定义是审批的描述, 包括审批名称、图标、描述等基础信息。创建好审批定义, 用户就可以在审批应用的发起页中看到审批, 如果用户点击发起, 则会跳转到配置的发起三方系统地址去发起审批。

另外, 审批定义还配置了审批操作时的回调地址: 审批人在待审批列表中进行【同意】【拒绝】操作时, 审批中心会调用回调地址通知三方系统。 注意, 审批中心不负责审批流程的流转, 只负责展示、操作、消息通知。因此审批定义创建时没有审批流程的信息。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create new doc: https://open.feishu.cn/document/server-docs/approval-v4/external_approval/create

func (*ApprovalService) CreateApprovalExternalInstance added in v0.0.97

CreateApprovalExternalInstance 审批中心不负责审批的流转, 审批的流转在三方系统, 三方系统在审批流转后生成的审批实例、审批任务、审批抄送数据同步到审批中心。

用户可以在审批中心中浏览三方系统同步过来的实例、任务、抄送信息, 并且可以跳转回三方系统进行更详细的查看和操作, 其中实例信息在【已发起】列表, 任务信息在【待审批】和【已审批】列表, 抄送信息在【抄送我】列表。 :::html <img src="//sf3-cn.feishucdn.com/obj/open-platform-opendoc/9dff4434afbeb0ef69de7f36b9a6e995_z5iwmTzEgg.png" alt="" style="zoom:17%;" /> <img src="//sf3-cn.feishucdn.com/obj/open-platform-opendoc/ca6e0e984a7a6d64e1b16a0bac4bf868_tfqjCiaJQM.png" alt="" style="zoom:17%;" /> <img src="//sf3-cn.feishucdn.com/obj/open-platform-opendoc/529377e238df78d391bbd22e962ad195_T7eefLI1GA.png" alt="" style="zoom:17%;" /> 对于审批任务, 三方系统也可以配置审批任务的回调接口, 这样审批人可以在审批中心中直接进行审批操作, 审批中心会回调三方系统, 三方系统收到回调后更新任务信息, 并将新的任务信息同步回审批中心, 形成闭环。 :::html <img src="//sf3-cn.feishucdn.com/obj/open-platform-opendoc/721c35428bc1187db3318c572f9979ad_je75QpElcg.png" alt="" style="zoom:25%;" />

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create new doc: https://open.feishu.cn/document/server-docs/approval-v4/external_instance/create

func (*ApprovalService) CreateApprovalInstance added in v0.0.18

func (r *ApprovalService) CreateApprovalInstance(ctx context.Context, request *CreateApprovalInstanceReq, options ...MethodOptionFunc) (*CreateApprovalInstanceResp, *Response, error)

CreateApprovalInstance 创建一个审批实例, 调用方需对审批定义的表单有详细了解, 将按照定义的表单结构, 将表单 Value 通过接口传入。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance/create

func (*ApprovalService) DeleteApprovalComment added in v0.0.97

func (r *ApprovalService) DeleteApprovalComment(ctx context.Context, request *DeleteApprovalCommentReq, options ...MethodOptionFunc) (*DeleteApprovalCommentResp, *Response, error)

DeleteApprovalComment 逻辑删除某审批实例下的一条评论或评论回复(不包含审批同意、拒绝、转交等附加的理由或意见)。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance-comment/delete

func (*ApprovalService) GetApproval added in v0.0.18

func (r *ApprovalService) GetApproval(ctx context.Context, request *GetApprovalReq, options ...MethodOptionFunc) (*GetApprovalResp, *Response, error)

GetApproval 根据 Approval Code 获取某个审批定义的详情, 用于构造创建审批实例的请求。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval/get

func (*ApprovalService) GetApprovalComment added in v0.0.97

func (r *ApprovalService) GetApprovalComment(ctx context.Context, request *GetApprovalCommentReq, options ...MethodOptionFunc) (*GetApprovalCommentResp, *Response, error)

GetApprovalComment 根据 Instance Code 获取某个审批实例下的全部评论与评论回复(不包含审批同意、拒绝、转交等附加的理由或意见)。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance-comment/list

func (*ApprovalService) GetApprovalExternalApproval added in v0.0.112

func (r *ApprovalService) GetApprovalExternalApproval(ctx context.Context, request *GetApprovalExternalApprovalReq, options ...MethodOptionFunc) (*GetApprovalExternalApprovalResp, *Response, error)

GetApprovalExternalApproval 根据 Approval Code 获取之前同步的某个三方审批定义的详情数据

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/get

func (*ApprovalService) GetApprovalExternalList added in v0.0.96

func (r *ApprovalService) GetApprovalExternalList(ctx context.Context, request *GetApprovalExternalListReq, options ...MethodOptionFunc) (*GetApprovalExternalListResp, *Response, error)

GetApprovalExternalList 该接口用于获取三方审批的状态。用户传入查询条件, 接口返回满足条件的审批实例的状态。该接口支持多种参数的组合, 包括如下组合:

1.通过 instance_ids 获取指定实例的任务状态 2.通过 user_ids 获取指定用户的任务状态 3.通过 status 获取指定状态的所有任务 4.通过page_token获取下一批数据

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list new doc: https://open.feishu.cn/document/server-docs/approval-v4/external_task/list

func (*ApprovalService) GetApprovalInstance added in v0.0.18

func (r *ApprovalService) GetApprovalInstance(ctx context.Context, request *GetApprovalInstanceReq, options ...MethodOptionFunc) (*GetApprovalInstanceResp, *Response, error)

GetApprovalInstance 通过审批实例 Instance Code 获取审批实例详情。Instance Code 由 [批量获取审批实例](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list) 接口获取。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance/get

func (*ApprovalService) GetApprovalInstanceList added in v0.0.17

func (r *ApprovalService) GetApprovalInstanceList(ctx context.Context, request *GetApprovalInstanceListReq, options ...MethodOptionFunc) (*GetApprovalInstanceListResp, *Response, error)

GetApprovalInstanceList 根据 approval_code 批量获取审批实例的 instance_code, 用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间先后顺序排列。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance/list

func (*ApprovalService) GetApprovalList added in v0.0.98

func (r *ApprovalService) GetApprovalList(ctx context.Context, request *GetApprovalListReq, options ...MethodOptionFunc) (*GetApprovalListResp, *Response, error)

GetApprovalList 查询当前用户可发起的审批定义列表。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/list

Deprecated

func (*ApprovalService) GetApprovalUserTaskList added in v0.0.82

func (r *ApprovalService) GetApprovalUserTaskList(ctx context.Context, request *GetApprovalUserTaskListReq, options ...MethodOptionFunc) (*GetApprovalUserTaskListResp, *Response, error)

GetApprovalUserTaskList 根据用户和任务分组查询任务列表。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval-search/query

func (*ApprovalService) PreviewApprovalInstance added in v0.0.67

func (r *ApprovalService) PreviewApprovalInstance(ctx context.Context, request *PreviewApprovalInstanceReq, options ...MethodOptionFunc) (*PreviewApprovalInstanceResp, *Response, error)

PreviewApprovalInstance 提交审批前, 预览审批流程。或者发起审批后, 在某一审批节点预览后续流程。

doc: https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance/approval-preview

func (*ApprovalService) RejectApprovalInstance added in v0.0.18

func (r *ApprovalService) RejectApprovalInstance(ctx context.Context, request *RejectApprovalInstanceReq, options ...MethodOptionFunc) (*RejectApprovalInstanceResp, *Response, error)

RejectApprovalInstance 对于单个审批任务进行拒绝操作。拒绝后审批流程结束。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/reject

func (*ApprovalService) RemoveApprovalComment added in v0.0.97

func (r *ApprovalService) RemoveApprovalComment(ctx context.Context, request *RemoveApprovalCommentReq, options ...MethodOptionFunc) (*RemoveApprovalCommentResp, *Response, error)

RemoveApprovalComment 删除某审批实例下的全部评论与评论回复。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove new doc: https://open.feishu.cn/document/server-docs/approval-v4/instance-comment/remove

func (*ApprovalService) ResubmitApprovalInstanceTask added in v0.0.98

func (r *ApprovalService) ResubmitApprovalInstanceTask(ctx context.Context, request *ResubmitApprovalInstanceTaskReq, options ...MethodOptionFunc) (*ResubmitApprovalInstanceTaskResp, *Response, error)

ResubmitApprovalInstanceTask 对于单个退回到发起人的审批任务进行重新发起操作。发起后审批流程会流转到下一个审批人。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/resubmit new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/resubmit

func (*ApprovalService) RollbackApprovalInstance added in v0.0.86

func (r *ApprovalService) RollbackApprovalInstance(ctx context.Context, request *RollbackApprovalInstanceReq, options ...MethodOptionFunc) (*RollbackApprovalInstanceResp, *Response, error)

RollbackApprovalInstance 从当前审批任务, 退回到已审批的一个或多个任务节点。退回后, 已审批节点重新生成审批任务。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/specified_rollback

func (*ApprovalService) SearchApprovalCarbonCopy added in v0.0.66

func (r *ApprovalService) SearchApprovalCarbonCopy(ctx context.Context, request *SearchApprovalCarbonCopyReq, options ...MethodOptionFunc) (*SearchApprovalCarbonCopyResp, *Response, error)

SearchApprovalCarbonCopy 该接口通过不同条件查询审批系统中符合条件的审批抄送列表。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval-search/search_cc

func (*ApprovalService) SearchApprovalInstance added in v0.0.18

func (r *ApprovalService) SearchApprovalInstance(ctx context.Context, request *SearchApprovalInstanceReq, options ...MethodOptionFunc) (*SearchApprovalInstanceResp, *Response, error)

SearchApprovalInstance 该接口通过不同条件查询审批系统中符合条件的审批实例列表。

如需了解审批实例各状态的说明, 以及审批实例状态变更事件, 可参见[审批实例状态变更](https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/common-event/approval-instance-event)。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval-search/query-2

func (*ApprovalService) SearchApprovalTask added in v0.0.66

func (r *ApprovalService) SearchApprovalTask(ctx context.Context, request *SearchApprovalTaskReq, options ...MethodOptionFunc) (*SearchApprovalTaskResp, *Response, error)

SearchApprovalTask 该接口通过不同条件查询审批系统中符合条件的审批任务列表。

如需了解审批任务各状态的说明, 以及审批任务状态变更事件, 可参见[审批任务状态变更](https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/common-event/approval-task-event)。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval-search/search

func (*ApprovalService) SendApprovalMessage added in v0.0.96

func (r *ApprovalService) SendApprovalMessage(ctx context.Context, request *SendApprovalMessageReq, options ...MethodOptionFunc) (*SendApprovalMessageResp, *Response, error)

SendApprovalMessage 此接口可以用来通过飞书审批的Bot推送消息给用户, 当有新的审批待办, 或者审批待办的状态有更新时, 可以通过飞书审批的Bot告知用户。当然开发者也可以利用开放平台的能力自建一个全新的Bot, 用来推送审批相关信息。如果出现推送成功, 但是没有收到消息, 可能是因为开通了审批机器人的聚合推送。

doc: https://open.feishu.cn/document/ukTMukTMukTM/ugDNyYjL4QjM24CO0IjN new doc: https://open.feishu.cn/document/server-docs/approval-v4/message/send-bot-messages

func (*ApprovalService) SubscribeApprovalSubscription added in v0.0.84

func (r *ApprovalService) SubscribeApprovalSubscription(ctx context.Context, request *SubscribeApprovalSubscriptionReq, options ...MethodOptionFunc) (*SubscribeApprovalSubscriptionResp, *Response, error)

SubscribeApprovalSubscription 应用订阅 approval_code 后, 该应用就可以收到该审批定义对应实例的事件通知。同一应用只需要订阅一次, 无需重复订阅。

当应用不希望再收到审批事件时, 可以使用取消订阅接口进行取消, 取消后将不再给应用推送消息。 订阅和取消订阅都是应用维度的, 多个应用可以同时订阅同一个 approval_code, 每个应用都能收到审批事件。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe new doc: https://open.feishu.cn/document/server-docs/approval-v4/event/event-interface/subscribe

func (*ApprovalService) TransferApprovalInstance added in v0.0.18

func (r *ApprovalService) TransferApprovalInstance(ctx context.Context, request *TransferApprovalInstanceReq, options ...MethodOptionFunc) (*TransferApprovalInstanceResp, *Response, error)

TransferApprovalInstance 对于单个审批任务进行转交操作。转交后审批流程流转给被转交人。

doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/transfer

func (*ApprovalService) TransformApprovalUserID added in v0.0.102

func (r *ApprovalService) TransformApprovalUserID(ctx context.Context, request *TransformApprovalUserIDReq, options ...MethodOptionFunc) (*TransformApprovalUserIDResp, *Response, error)

TransformApprovalUserID 用于灰度租户内的 userID 相互转换。

doc: https://open.feishu.cn/document/ukTMukTMukTM/uEDN5UjLxQTO14SM0kTN new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval-search/search-approval-id-(dedicated)

func (*ApprovalService) UnsubscribeApprovalSubscription added in