larkim

package
v3.0.33-beta.1 Latest Latest
Warning

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

Go to latest
Published: Dec 4, 2023 License: MIT Imports: 12 Imported by: 49

Documentation

Index

Constants

View Source
const (
	MsgTypeText        string = "text"
	MsgTypePost        string = "post"
	MsgTypeImage       string = "image"
	MsgTypeFile        string = "file"
	MsgTypeAudio       string = "audio"
	MsgTypeMedia       string = "media"
	MsgTypeSticker     string = "sticker"
	MsgTypeInteractive string = "interactive"
	MsgTypeShareChat   string = "share_chat"
	MsgTypeShareUser   string = "share_user"
)

* 消息类型,枚举值

View Source
const (
	ChatTypePrivate string = "private"
	ChatTypePublic  string = "public"
)
View Source
const (
	UrgentSettingTypeOnlyOwner  = "only_owner"  // 仅群主和管理员
	UrgentSettingTypeAllMembers = "all_members" // 所有成员
)
View Source
const (
	VideoConferenceSettingTypeOnlyOwner  = "only_owner"  // 仅群主和管理员
	VideoConferenceSettingTypeAllMembers = "all_members" // 所有成员
)
View Source
const (
	EditPermissiontypeOnlyOwner  = "only_owner"  // 仅群主和管理员
	EditPermissiontypeAllMembers = "all_members" // 所有成员
)
View Source
const (
	UserIdTypeUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeGetChatUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeGetChatUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeGetChatOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	ValidityPeriodOneWeek     = "week"        // 有效期7天
	ValidityPeriodOneYear     = "year"        // 有效期1年
	ValidityPeriodPermanently = "permanently" // 永久有效
)
View Source
const (
	UserIdTypeListChatUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeListChatUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeListChatOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	SortTypeByCreateTimeAsc  = "ByCreateTimeAsc"  // 按群组创建时间升序排列
	SortTypeByActiveTimeDesc = "ByActiveTimeDesc" // 按群组活跃时间降序排列
)
View Source
const (
	UserIdTypeSearchChatUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeSearchChatUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeSearchChatOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UrgentSettingTypeUpdateChatOnlyOwner  = "only_owner"  // 仅群主和管理员
	UrgentSettingTypeUpdateChatAllMembers = "all_members" // 所有成员
)
View Source
const (
	VideoConferenceSettingTypeUpdateChatOnlyOwner  = "only_owner"  // 仅群主和管理员
	VideoConferenceSettingTypeUpdateChatAllMembers = "all_members" // 所有成员
)
View Source
const (
	UserIdTypeUpdateChatUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUpdateChatUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeUpdateChatOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeGetChatAnnouncementUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeGetChatAnnouncementUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeGetChatAnnouncementOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	MemberIdTypeUserId  = "user_id"  // 以user_id来识别成员
	MemberIdTypeUnionId = "union_id" // 以union_id来识别成员
	MemberIdTypeOpenId  = "open_id"  // 以open_id来识别成员
	MemberIdTypeAppId   = "app_id"   // 以app_id来识别成员
)
View Source
const (
	MemberIdTypeDeleteManagersChatManagersUserId  = "user_id"  // 以user_id来识别成员
	MemberIdTypeDeleteManagersChatManagersUnionId = "union_id" // 以union_id来识别成员
	MemberIdTypeDeleteManagersChatManagersOpenId  = "open_id"  // 以open_id来识别成员
	MemberIdTypeDeleteManagersChatManagersAppId   = "app_id"   // 以app_id来识别成员
)
View Source
const (
	MemberIdTypeCreateChatMembersUserId  = "user_id"  // 以user_id来识别成员
	MemberIdTypeCreateChatMembersUnionId = "union_id" // 以union_id来识别成员
	MemberIdTypeCreateChatMembersOpenId  = "open_id"  // 以open_id来识别成员
	MemberIdTypeCreateChatMembersAppId   = "app_id"   // 以app_id来识别成员
)
View Source
const (
	SucceedType0 = 0 // 保持以前的策略,存在不可用的 ID 会拉群失败,返回错误响应
	SucceedType1 = 1 // 将可用 ID 全部拉入群,返回拉群成功的响应,并展示不可用的
	SucceedType2 = 2 // 存在不可用的 ID 会拉群失败,返回错误响应,并展示出不可用的 ID

)
View Source
const (
	MemberIdTypeDeleteChatMembersUserId  = "user_id"  // 以user_id来识别成员
	MemberIdTypeDeleteChatMembersUnionId = "union_id" // 以union_id来识别成员
	MemberIdTypeDeleteChatMembersOpenId  = "open_id"  // 以open_id来识别成员
	MemberIdTypeDeleteChatMembersAppId   = "app_id"   // 以app_id来识别成员
)
View Source
const (
	MemberIdTypeGetChatMembersUserId  = "user_id"  // 以user_id来识别成员
	MemberIdTypeGetChatMembersUnionId = "union_id" // 以union_id来识别成员
	MemberIdTypeGetChatMembersOpenId  = "open_id"  // 以open_id来识别成员
)
View Source
const (
	UserIdTypeGetChatModerationUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeGetChatModerationUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeGetChatModerationOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeUpdateChatModerationUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUpdateChatModerationUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeUpdateChatModerationOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	FileTypeOpus   = "opus"   // 上传opus音频文件
	FileTypeMp4    = "mp4"    // 上传mp4视频文件
	FileTypePdf    = "pdf"    // 上传pdf格式文件
	FileTypeDoc    = "doc"    // 上传doc格式文件
	FileTypeXls    = "xls"    // 上传xls格式文件
	FileTypePpt    = "ppt"    // 上传ppt格式文件
	FileTypeStream = "stream" // 上传stream格式文件
)
View Source
const (
	ImageTypeMessage = "message" // 用于发送消息
	ImageTypeAvatar  = "avatar"  // 用于设置头像
)
View Source
const (
	ReceiveIdTypeOpenId  = "open_id"  // 以open_id来识别用户
	ReceiveIdTypeUserId  = "user_id"  // 以user_id来识别用户
	ReceiveIdTypeUnionId = "union_id" // 以union_id来识别用户
	ReceiveIdTypeEmail   = "email"    // 以email来识别用户
	ReceiveIdTypeChatId  = "chat_id"  // 以chat_id来识别群聊
)
View Source
const (
	ReceiveIdTypeForwardMessageOpenId  = "open_id"  // 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
	ReceiveIdTypeForwardMessageUserId  = "user_id"  // 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。
	ReceiveIdTypeForwardMessageUnionId = "union_id" // 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。
	ReceiveIdTypeForwardMessageEmail   = "email"    // 以用户的真实邮箱来标识用户。
	ReceiveIdTypeForwardMessageChatId  = "chat_id"  // 以群ID来标识群聊。
)
View Source
const (
	UserIdTypeGetMessageUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeGetMessageUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeGetMessageOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	SortTypeListMessageByCreateTimeAsc  = "ByCreateTimeAsc"  // 按消息创建时间升序排列
	SortTypeListMessageByCreateTimeDesc = "ByCreateTimeDesc" // 按消息创建时间降序排列
)
View Source
const (
	ReceiveIdTypeMergeForwardMessageOpenId  = "open_id"  // 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
	ReceiveIdTypeMergeForwardMessageUserId  = "user_id"  // 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。
	ReceiveIdTypeMergeForwardMessageUnionId = "union_id" // 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。
	ReceiveIdTypeMergeForwardMessageEmail   = "email"    // 以用户的真实邮箱来标识用户。
	ReceiveIdTypeMergeForwardMessageChatId  = "chat_id"  // 以群ID来标识群聊。
)
View Source
const (
	UserIdTypeReadUsersMessageUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeReadUsersMessageUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeReadUsersMessageOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeUrgentAppMessageUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUrgentAppMessageUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeUrgentAppMessageOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeUrgentPhoneMessageUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUrgentPhoneMessageUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeUrgentPhoneMessageOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeUrgentSmsMessageUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUrgentSmsMessageUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeUrgentSmsMessageOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeListMessageReactionOpenId  = "open_id"  // 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
	UserIdTypeListMessageReactionUnionId = "union_id" // 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。
	UserIdTypeListMessageReactionUserId  = "user_id"  // 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddManagersChatManagersPathReqBodyBuilder

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

func NewAddManagersChatManagersPathReqBodyBuilder

func NewAddManagersChatManagersPathReqBodyBuilder() *AddManagersChatManagersPathReqBodyBuilder

func (*AddManagersChatManagersPathReqBodyBuilder) Build

func (*AddManagersChatManagersPathReqBodyBuilder) ManagerIds

要增加的 manager_id;;**注意**:;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type AddManagersChatManagersReq

type AddManagersChatManagersReq struct {
	Body *AddManagersChatManagersReqBody `body:""`
	// contains filtered or unexported fields
}

type AddManagersChatManagersReqBody

type AddManagersChatManagersReqBody struct {
	ManagerIds []string `json:"manager_ids,omitempty"` // 要增加的 manager_id;;**注意**:;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人
}

type AddManagersChatManagersReqBodyBuilder

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

func NewAddManagersChatManagersReqBodyBuilder

func NewAddManagersChatManagersReqBodyBuilder() *AddManagersChatManagersReqBodyBuilder

func (*AddManagersChatManagersReqBodyBuilder) Build

func (*AddManagersChatManagersReqBodyBuilder) ManagerIds

要增加的 manager_id;;**注意**:;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type AddManagersChatManagersReqBuilder

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

func NewAddManagersChatManagersReqBuilder

func NewAddManagersChatManagersReqBuilder() *AddManagersChatManagersReqBuilder

func (*AddManagersChatManagersReqBuilder) Body

将用户或机器人指定为群管理员。

func (*AddManagersChatManagersReqBuilder) Build

func (*AddManagersChatManagersReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`、`topic`的群组ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*AddManagersChatManagersReqBuilder) MemberIdType

func (builder *AddManagersChatManagersReqBuilder) MemberIdType(memberIdType string) *AddManagersChatManagersReqBuilder

群成员 ID 类型 open_id/user_id/union_id/app_id;;**注意**: 指定机器人类型的管理员请使用 ==app_id==

示例值:open_id

type AddManagersChatManagersResp

type AddManagersChatManagersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *AddManagersChatManagersRespData `json:"data"` // 业务数据
}

func (*AddManagersChatManagersResp) Success

func (resp *AddManagersChatManagersResp) Success() bool

type AddManagersChatManagersRespData

type AddManagersChatManagersRespData struct {
	ChatManagers    []string `json:"chat_managers,omitempty"`     // 群目前用户类型的管理员 id
	ChatBotManagers []string `json:"chat_bot_managers,omitempty"` // 群目前机器人类型的管理员 id
}

type BatchMessage

type BatchMessage struct {
	BatchMessageId      *string              `json:"batch_message_id,omitempty"`      // 批量发消息的批次号,代表某次批量发送消息的唯一标识
	BatchSendProgress   *BatchSendProgress   `json:"batch_send_progress,omitempty"`   // 发送进度
	BatchRecallProgress *BatchRecallProgress `json:"batch_recall_progress,omitempty"` // 撤回进度
}

type BatchMessageBuilder

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

func NewBatchMessageBuilder

func NewBatchMessageBuilder() *BatchMessageBuilder

func (*BatchMessageBuilder) BatchMessageId

func (builder *BatchMessageBuilder) BatchMessageId(batchMessageId string) *BatchMessageBuilder

批量发消息的批次号,代表某次批量发送消息的唯一标识

示例值:bm_dc13264520392913993dd051dba21dcf

func (*BatchMessageBuilder) BatchRecallProgress

func (builder *BatchMessageBuilder) BatchRecallProgress(batchRecallProgress *BatchRecallProgress) *BatchMessageBuilder

撤回进度

示例值:json结构

func (*BatchMessageBuilder) BatchSendProgress

func (builder *BatchMessageBuilder) BatchSendProgress(batchSendProgress *BatchSendProgress) *BatchMessageBuilder

发送进度

示例值:json结构

func (*BatchMessageBuilder) Build

func (builder *BatchMessageBuilder) Build() *BatchMessage

type BatchMessageReadUser

type BatchMessageReadUser struct {
	ReadCount  *string `json:"read_count,omitempty"`  // 已读的人数
	TotalCount *string `json:"total_count,omitempty"` // 推送的总人数
}

type BatchMessageReadUserBuilder

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

func NewBatchMessageReadUserBuilder

func NewBatchMessageReadUserBuilder() *BatchMessageReadUserBuilder

func (*BatchMessageReadUserBuilder) Build

func (*BatchMessageReadUserBuilder) ReadCount

func (builder *BatchMessageReadUserBuilder) ReadCount(readCount string) *BatchMessageReadUserBuilder

已读的人数

示例值:

func (*BatchMessageReadUserBuilder) TotalCount

func (builder *BatchMessageReadUserBuilder) TotalCount(totalCount string) *BatchMessageReadUserBuilder

推送的总人数

示例值:

type BatchMessageRecallProgress

type BatchMessageRecallProgress struct {
	Recall      *bool `json:"recall,omitempty"`       // 该条批量消息是否被执行过撤回操作
	RecallCount *int  `json:"recall_count,omitempty"` // 已经成功撤回的消息数量
}

type BatchMessageRecallProgressBuilder

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

func NewBatchMessageRecallProgressBuilder

func NewBatchMessageRecallProgressBuilder() *BatchMessageRecallProgressBuilder

func (*BatchMessageRecallProgressBuilder) Build

func (*BatchMessageRecallProgressBuilder) Recall

该条批量消息是否被执行过撤回操作

示例值:true

func (*BatchMessageRecallProgressBuilder) RecallCount

func (builder *BatchMessageRecallProgressBuilder) RecallCount(recallCount int) *BatchMessageRecallProgressBuilder

已经成功撤回的消息数量

示例值:100

type BatchMessageSendProgress

type BatchMessageSendProgress struct {
	ValidUserIdsCount   *int `json:"valid_user_ids_count,omitempty"`   // 批量请求中有效的userid数量(包含机器人不可见用户);;;;**注意**: ;当valid_user_ids_count为0有两种情况:;* 批量任务还没有开始被调度(请等待一会再调用该接口);* 批量发送消息时传入的所有openIDs、employeID、departmentiIDs都不包含有效的用户
	SuccessUserIdsCount *int `json:"success_user_ids_count,omitempty"` // 已经成功给用户发送成功的消息数量;;;;**注意**:最终success_user_ids_count不一定等于valid_user_ids_count, 因为valid_user_ids_count包含了对机器人不可见的用户
	ReadUserIdsCount    *int `json:"read_user_ids_count,omitempty"`    // 已读信息用户数量
}

type BatchMessageSendProgressBuilder

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

func NewBatchMessageSendProgressBuilder

func NewBatchMessageSendProgressBuilder() *BatchMessageSendProgressBuilder

func (*BatchMessageSendProgressBuilder) Build

func (*BatchMessageSendProgressBuilder) ReadUserIdsCount

func (builder *BatchMessageSendProgressBuilder) ReadUserIdsCount(readUserIdsCount int) *BatchMessageSendProgressBuilder

已读信息用户数量

示例值:150

func (*BatchMessageSendProgressBuilder) SuccessUserIdsCount

func (builder *BatchMessageSendProgressBuilder) SuccessUserIdsCount(successUserIdsCount int) *BatchMessageSendProgressBuilder

已经成功给用户发送成功的消息数量;;;;**注意**:最终success_user_ids_count不一定等于valid_user_ids_count, 因为valid_user_ids_count包含了对机器人不可见的用户

示例值:200

func (*BatchMessageSendProgressBuilder) ValidUserIdsCount

func (builder *BatchMessageSendProgressBuilder) ValidUserIdsCount(validUserIdsCount int) *BatchMessageSendProgressBuilder

批量请求中有效的userid数量(包含机器人不可见用户);;;;**注意**: ;当valid_user_ids_count为0有两种情况:;* 批量任务还没有开始被调度(请等待一会再调用该接口);* 批量发送消息时传入的所有openIDs、employeID、departmentiIDs都不包含有效的用户

示例值:204

type BatchRecallProgress

type BatchRecallProgress struct {
	RecallCount      *string `json:"recall_count,omitempty"`       // 撤回成功的消息条数
	TotalRecallCount *string `json:"total_recall_count,omitempty"` // 计划撤回的消息条数
}

type BatchRecallProgressBuilder

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

func NewBatchRecallProgressBuilder

func NewBatchRecallProgressBuilder() *BatchRecallProgressBuilder

func (*BatchRecallProgressBuilder) Build

func (*BatchRecallProgressBuilder) RecallCount

func (builder *BatchRecallProgressBuilder) RecallCount(recallCount string) *BatchRecallProgressBuilder

撤回成功的消息条数

示例值:

func (*BatchRecallProgressBuilder) TotalRecallCount

func (builder *BatchRecallProgressBuilder) TotalRecallCount(totalRecallCount string) *BatchRecallProgressBuilder

计划撤回的消息条数

示例值:

type BatchSendProgress

type BatchSendProgress struct {
	SendCount      *string `json:"send_count,omitempty"`       // 发送成功的消息条数
	TotalSendCount *string `json:"total_send_count,omitempty"` // 总的计划发送的消息条数
}

type BatchSendProgressBuilder

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

func NewBatchSendProgressBuilder

func NewBatchSendProgressBuilder() *BatchSendProgressBuilder

func (*BatchSendProgressBuilder) Build

func (builder *BatchSendProgressBuilder) Build() *BatchSendProgress

func (*BatchSendProgressBuilder) SendCount

func (builder *BatchSendProgressBuilder) SendCount(sendCount string) *BatchSendProgressBuilder

发送成功的消息条数

示例值:

func (*BatchSendProgressBuilder) TotalSendCount

func (builder *BatchSendProgressBuilder) TotalSendCount(totalSendCount string) *BatchSendProgressBuilder

总的计划发送的消息条数

示例值:

type Chat

type Chat struct {
	ChatId         *string    `json:"chat_id,omitempty"`           // chat_id of the conversation
	Avatar         *string    `json:"avatar,omitempty"`            // avatar of the conversation
	Name           *string    `json:"name,omitempty"`              // name of the conversation
	Description    *string    `json:"description,omitempty"`       // description of the conversation
	I18nNames      *I18nNames `json:"i18n_names,omitempty"`        // i18_names of the conversation
	OnlyOwnerAdd   *bool      `json:"only_owner_add,omitempty"`    // whether only the owner of the converation can add others
	ShareAllowed   *bool      `json:"share_allowed,omitempty"`     // whether the converation can be shared
	OnlyOwnerAtAll *bool      `json:"only_owner_at_all,omitempty"` // whether only the owner of the converation can @all
	OnlyOwnerEdit  *bool      `json:"only_owner_edit,omitempty"`   // whether only the owner of the converation can edit the converation info
	OwnerUserId    *string    `json:"owner_user_id,omitempty"`     // owner_id
	Type           *string    `json:"type,omitempty"`              // type

}

type ChatAnnouncement

type ChatAnnouncement struct {
}

type ChatBuilder

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

func NewChatBuilder

func NewChatBuilder() *ChatBuilder

func (*ChatBuilder) Avatar

func (builder *ChatBuilder) Avatar(avatar string) *ChatBuilder

avatar of the conversation

示例值:

func (*ChatBuilder) Build

func (builder *ChatBuilder) Build() *Chat

func (*ChatBuilder) ChatId

func (builder *ChatBuilder) ChatId(chatId string) *ChatBuilder

chat_id of the conversation

示例值:

func (*ChatBuilder) Description

func (builder *ChatBuilder) Description(description string) *ChatBuilder

description of the conversation

示例值:

func (*ChatBuilder) I18nNames

func (builder *ChatBuilder) I18nNames(i18nNames *I18nNames) *ChatBuilder

i18_names of the conversation

示例值:

func (*ChatBuilder) Name

func (builder *ChatBuilder) Name(name string) *ChatBuilder

name of the conversation

示例值:

func (*ChatBuilder) OnlyOwnerAdd

func (builder *ChatBuilder) OnlyOwnerAdd(onlyOwnerAdd bool) *ChatBuilder

whether only the owner of the converation can add others

示例值:

func (*ChatBuilder) OnlyOwnerAtAll

func (builder *ChatBuilder) OnlyOwnerAtAll(onlyOwnerAtAll bool) *ChatBuilder

whether only the owner of the converation can @all

示例值:

func (*ChatBuilder) OnlyOwnerEdit

func (builder *ChatBuilder) OnlyOwnerEdit(onlyOwnerEdit bool) *ChatBuilder

whether only the owner of the converation can edit the converation info

示例值:

func (*ChatBuilder) OwnerUserId

func (builder *ChatBuilder) OwnerUserId(ownerUserId string) *ChatBuilder

owner_id

示例值:

func (*ChatBuilder) ShareAllowed

func (builder *ChatBuilder) ShareAllowed(shareAllowed bool) *ChatBuilder

whether the converation can be shared

示例值:

func (*ChatBuilder) Type

func (builder *ChatBuilder) Type(type_ string) *ChatBuilder

type

示例值:

type ChatChange

type ChatChange struct {
	Avatar                 *string    `json:"avatar,omitempty"`                   // 群头像
	Name                   *string    `json:"name,omitempty"`                     // 群名称
	Description            *string    `json:"description,omitempty"`              // 群描述
	I18nNames              *I18nNames `json:"i18n_names,omitempty"`               // 群国际化名称
	AddMemberPermission    *string    `json:"add_member_permission,omitempty"`    // 加人入群权限(all_members/only_owner/unknown)
	ShareCardPermission    *string    `json:"share_card_permission,omitempty"`    // 群分享权限(allowed/not_allowed/unknown)
	AtAllPermission        *string    `json:"at_all_permission,omitempty"`        // at 所有人权限(all_members/only_owner/unknown)
	EditPermission         *string    `json:"edit_permission,omitempty"`          // 群编辑权限(all_members/only_owner/unknown)
	MembershipApproval     *string    `json:"membership_approval,omitempty"`      // 加群审批(no_approval_required/approval_required)
	JoinMessageVisibility  *string    `json:"join_message_visibility,omitempty"`  // 入群消息可见性(only_owner/all_members/not_anyone)
	LeaveMessageVisibility *string    `json:"leave_message_visibility,omitempty"` // 出群消息可见性(only_owner/all_members/not_anyone)
	ModerationPermission   *string    `json:"moderation_permission,omitempty"`    // 发言权限(all_members/only_owner)
	OwnerId                *UserId    `json:"owner_id,omitempty"`                 // 用户 ID

	RestrictedModeSetting *RestrictedModeSetting `json:"restricted_mode_setting,omitempty"` // 防泄密模式设置
}

type ChatChangeBuilder

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

func NewChatChangeBuilder

func NewChatChangeBuilder() *ChatChangeBuilder

func (*ChatChangeBuilder) AddMemberPermission

func (builder *ChatChangeBuilder) AddMemberPermission(addMemberPermission string) *ChatChangeBuilder

加人入群权限(all_members/only_owner/unknown)

示例值:all_members

func (*ChatChangeBuilder) AtAllPermission

func (builder *ChatChangeBuilder) AtAllPermission(atAllPermission string) *ChatChangeBuilder

at 所有人权限(all_members/only_owner/unknown)

示例值:only_owner

func (*ChatChangeBuilder) Avatar

func (builder *ChatChangeBuilder) Avatar(avatar string) *ChatChangeBuilder

群头像

示例值:default-avatar_0cda3662-875a-4354-94d2-83e7393c7123

func (*ChatChangeBuilder) Build

func (builder *ChatChangeBuilder) Build() *ChatChange

func (*ChatChangeBuilder) Description

func (builder *ChatChangeBuilder) Description(description string) *ChatChangeBuilder

群描述

示例值:群描述测试

func (*ChatChangeBuilder) EditPermission

func (builder *ChatChangeBuilder) EditPermission(editPermission string) *ChatChangeBuilder

群编辑权限(all_members/only_owner/unknown)

示例值:all_members

func (*ChatChangeBuilder) I18nNames

func (builder *ChatChangeBuilder) I18nNames(i18nNames *I18nNames) *ChatChangeBuilder

群国际化名称

示例值:

func (*ChatChangeBuilder) JoinMessageVisibility

func (builder *ChatChangeBuilder) JoinMessageVisibility(joinMessageVisibility string) *ChatChangeBuilder

入群消息可见性(only_owner/all_members/not_anyone)

示例值:all_members

func (*ChatChangeBuilder) LeaveMessageVisibility

func (builder *ChatChangeBuilder) LeaveMessageVisibility(leaveMessageVisibility string) *ChatChangeBuilder

出群消息可见性(only_owner/all_members/not_anyone)

示例值:all_members

func (*ChatChangeBuilder) MembershipApproval

func (builder *ChatChangeBuilder) MembershipApproval(membershipApproval string) *ChatChangeBuilder

加群审批(no_approval_required/approval_required)

示例值:approval_required

func (*ChatChangeBuilder) ModerationPermission

func (builder *ChatChangeBuilder) ModerationPermission(moderationPermission string) *ChatChangeBuilder

发言权限(all_members/only_owner)

示例值:all_members

func (*ChatChangeBuilder) Name

func (builder *ChatChangeBuilder) Name(name string) *ChatChangeBuilder

群名称

示例值:群名称测试

func (*ChatChangeBuilder) OwnerId

func (builder *ChatChangeBuilder) OwnerId(ownerId *UserId) *ChatChangeBuilder

用户 ID

示例值:

func (*ChatChangeBuilder) RestrictedModeSetting added in v3.0.20

func (builder *ChatChangeBuilder) RestrictedModeSetting(restrictedModeSetting *RestrictedModeSetting) *ChatChangeBuilder

防泄密模式设置

示例值:

func (*ChatChangeBuilder) ShareCardPermission

func (builder *ChatChangeBuilder) ShareCardPermission(shareCardPermission string) *ChatChangeBuilder

群分享权限(allowed/not_allowed/unknown)

示例值:allowed

type ChatI18nNames

type ChatI18nNames struct {
	EnUs string `json:"en_us,omitempty"`
	ZhCn string `json:"zh_cn,omitempty"`
}

type ChatManagers

type ChatManagers struct {
	ManagerId *string `json:"manager_id,omitempty"` // 群管理员ID
}

type ChatManagersBuilder

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

func NewChatManagersBuilder

func NewChatManagersBuilder() *ChatManagersBuilder

func (*ChatManagersBuilder) Build

func (builder *ChatManagersBuilder) Build() *ChatManagers

func (*ChatManagersBuilder) ManagerId

func (builder *ChatManagersBuilder) ManagerId(managerId string) *ChatManagersBuilder

群管理员ID

示例值:

type ChatMember

type ChatMember struct {
	UserId *string `json:"user_id,omitempty"` // user_id
}

type ChatMemberBot

type ChatMemberBot struct {
	BotId *string `json:"bot_id,omitempty"` // bot_id
}

type ChatMemberBotBuilder

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

func NewChatMemberBotBuilder

func NewChatMemberBotBuilder() *ChatMemberBotBuilder

func (*ChatMemberBotBuilder) BotId

func (builder *ChatMemberBotBuilder) BotId(botId string) *ChatMemberBotBuilder

bot_id

示例值:

func (*ChatMemberBotBuilder) Build

func (builder *ChatMemberBotBuilder) Build() *ChatMemberBot

type ChatMemberBuilder

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

func NewChatMemberBuilder

func NewChatMemberBuilder() *ChatMemberBuilder

func (*ChatMemberBuilder) Build

func (builder *ChatMemberBuilder) Build() *ChatMember

func (*ChatMemberBuilder) UserId

func (builder *ChatMemberBuilder) UserId(userId string) *ChatMemberBuilder

user_id

示例值:

type ChatMemberUser

type ChatMemberUser struct {
	Name      *string `json:"name,omitempty"`       // 用户名字
	TenantKey *string `json:"tenant_key,omitempty"` // 租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
	UserId    *UserId `json:"user_id,omitempty"`    // 用户 ID
}

type ChatMemberUserBuilder

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

func NewChatMemberUserBuilder

func NewChatMemberUserBuilder() *ChatMemberUserBuilder

func (*ChatMemberUserBuilder) Build

func (builder *ChatMemberUserBuilder) Build() *ChatMemberUser

func (*ChatMemberUserBuilder) Name

func (builder *ChatMemberUserBuilder) Name(name string) *ChatMemberUserBuilder

用户名字

示例值:user name

func (*ChatMemberUserBuilder) TenantKey

func (builder *ChatMemberUserBuilder) TenantKey(tenantKey string) *ChatMemberUserBuilder

租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识

示例值:3774yuu3743

func (*ChatMemberUserBuilder) UserId

func (builder *ChatMemberUserBuilder) UserId(userId *UserId) *ChatMemberUserBuilder

用户 ID

示例值:

type ChatMembers

type ChatMembers struct {
	UserId *string `json:"user_id,omitempty"` // user_id
}

type ChatMembersBuilder

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

func NewChatMembersBuilder

func NewChatMembersBuilder() *ChatMembersBuilder

func (*ChatMembersBuilder) Build

func (builder *ChatMembersBuilder) Build() *ChatMembers

func (*ChatMembersBuilder) UserId

func (builder *ChatMembersBuilder) UserId(userId string) *ChatMembersBuilder

user_id

示例值:

type ChatMenuItem added in v3.0.5

type ChatMenuItem struct {
	ActionType   *string                   `json:"action_type,omitempty"`   // 菜单类型
	RedirectLink *ChatMenuItemRedirectLink `json:"redirect_link,omitempty"` // 跳转链接
	ImageKey     *string                   `json:"image_key,omitempty"`     // image_key,通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key
	Name         *string                   `json:"name,omitempty"`          // 名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内;;;**注意:** ;- 1中文=2英文=2其他语言字符=2字符
	I18nNames    *I18nNames                `json:"i18n_names,omitempty"`    // 国际化名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内;;**注意:**;- 1中文=2英文=2其他语言字符=2字符
}

type ChatMenuItemBuilder added in v3.0.5

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

func NewChatMenuItemBuilder added in v3.0.5

func NewChatMenuItemBuilder() *ChatMenuItemBuilder

func (*ChatMenuItemBuilder) ActionType added in v3.0.5

func (builder *ChatMenuItemBuilder) ActionType(actionType string) *ChatMenuItemBuilder

菜单类型

示例值:NONE

func (*ChatMenuItemBuilder) Build added in v3.0.5

func (builder *ChatMenuItemBuilder) Build() *ChatMenuItem

func (*ChatMenuItemBuilder) I18nNames added in v3.0.5

func (builder *ChatMenuItemBuilder) I18nNames(i18nNames *I18nNames) *ChatMenuItemBuilder

国际化名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内;;**注意:**;- 1中文=2英文=2其他语言字符=2字符

示例值:

func (*ChatMenuItemBuilder) ImageKey added in v3.0.5

func (builder *ChatMenuItemBuilder) ImageKey(imageKey string) *ChatMenuItemBuilder

image_key,通过 [上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create) 接口上传message类型图片获取image_key

示例值:img_v2_b0fbe905-7988-4282-b882-82edd010336j

func (*ChatMenuItemBuilder) Name added in v3.0.5

func (builder *ChatMenuItemBuilder) Name(name string) *ChatMenuItemBuilder

名称,一级菜单名称字符数要在1到8范围内,二级菜单名称字符数要在1到24范围内;;;**注意:** ;- 1中文=2英文=2其他语言字符=2字符

示例值:群聊

func (builder *ChatMenuItemBuilder) RedirectLink(redirectLink *ChatMenuItemRedirectLink) *ChatMenuItemBuilder

跳转链接

示例值:

type ChatMenuItemRedirectLink struct {
	CommonUrl  *string `json:"common_url,omitempty"`  // 公用跳转链接,必须以http开头。
	IosUrl     *string `json:"ios_url,omitempty"`     // IOS端跳转链接,当该字段不设置时,IOS端会使用common_url。必须以http开头。
	AndroidUrl *string `json:"android_url,omitempty"` // Android端跳转链接,当该字段不设置时,Android端会使用common_url。必须以http开头。
	PcUrl      *string `json:"pc_url,omitempty"`      // PC端跳转链接,当该字段不设置时,PC端会使用common_url。必须以http开头。
	WebUrl     *string `json:"web_url,omitempty"`     // Web端跳转链接,当该字段不设置时,Web端会使用common_url。必须以http开头。
}

type ChatMenuItemRedirectLinkBuilder added in v3.0.5

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

func NewChatMenuItemRedirectLinkBuilder added in v3.0.5

func NewChatMenuItemRedirectLinkBuilder() *ChatMenuItemRedirectLinkBuilder

func (*ChatMenuItemRedirectLinkBuilder) AndroidUrl added in v3.0.5

Android端跳转链接,当该字段不设置时,Android端会使用common_url。必须以http开头。

示例值:https://open.feishu.cn/

func (*ChatMenuItemRedirectLinkBuilder) Build added in v3.0.5

func (*ChatMenuItemRedirectLinkBuilder) CommonUrl added in v3.0.5

公用跳转链接,必须以http开头。

示例值:https://open.feishu.cn/

func (*ChatMenuItemRedirectLinkBuilder) IosUrl added in v3.0.5

IOS端跳转链接,当该字段不设置时,IOS端会使用common_url。必须以http开头。

示例值:https://open.feishu.cn/

func (*ChatMenuItemRedirectLinkBuilder) PcUrl added in v3.0.5

PC端跳转链接,当该字段不设置时,PC端会使用common_url。必须以http开头。

示例值:https://open.feishu.cn/

func (*ChatMenuItemRedirectLinkBuilder) WebUrl added in v3.0.5

Web端跳转链接,当该字段不设置时,Web端会使用common_url。必须以http开头。

示例值:https://open.feishu.cn/

type ChatMenuSecondLevel added in v3.0.5

type ChatMenuSecondLevel struct {
	ChatMenuSecondLevelId *string       `json:"chat_menu_second_level_id,omitempty"` // 二级菜单ID
	ChatMenuItem          *ChatMenuItem `json:"chat_menu_item,omitempty"`            // 二级菜单信息
}

type ChatMenuSecondLevelBuilder added in v3.0.5

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

func NewChatMenuSecondLevelBuilder added in v3.0.5

func NewChatMenuSecondLevelBuilder() *ChatMenuSecondLevelBuilder

func (*ChatMenuSecondLevelBuilder) Build added in v3.0.5

func (*ChatMenuSecondLevelBuilder) ChatMenuItem added in v3.0.5

func (builder *ChatMenuSecondLevelBuilder) ChatMenuItem(chatMenuItem *ChatMenuItem) *ChatMenuSecondLevelBuilder

二级菜单信息

示例值:

func (*ChatMenuSecondLevelBuilder) ChatMenuSecondLevelId added in v3.0.5

func (builder *ChatMenuSecondLevelBuilder) ChatMenuSecondLevelId(chatMenuSecondLevelId string) *ChatMenuSecondLevelBuilder

二级菜单ID

示例值:7039638308221468675

type ChatMenuTopLevel added in v3.0.5

type ChatMenuTopLevel struct {
	ChatMenuTopLevelId *string                `json:"chat_menu_top_level_id,omitempty"` // 一级菜单ID
	ChatMenuItem       *ChatMenuItem          `json:"chat_menu_item,omitempty"`         // 一级菜单信息
	Children           []*ChatMenuSecondLevel `json:"children,omitempty"`               // 二级菜单列表
}

type ChatMenuTopLevelBuilder added in v3.0.5

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

func NewChatMenuTopLevelBuilder added in v3.0.5

func NewChatMenuTopLevelBuilder() *ChatMenuTopLevelBuilder

func (*ChatMenuTopLevelBuilder) Build added in v3.0.5

func (builder *ChatMenuTopLevelBuilder) Build() *ChatMenuTopLevel

func (*ChatMenuTopLevelBuilder) ChatMenuItem added in v3.0.5

func (builder *ChatMenuTopLevelBuilder) ChatMenuItem(chatMenuItem *ChatMenuItem) *ChatMenuTopLevelBuilder

一级菜单信息

示例值:

func (*ChatMenuTopLevelBuilder) ChatMenuTopLevelId added in v3.0.5

func (builder *ChatMenuTopLevelBuilder) ChatMenuTopLevelId(chatMenuTopLevelId string) *ChatMenuTopLevelBuilder

一级菜单ID

示例值:7117116451961487361

func (*ChatMenuTopLevelBuilder) Children added in v3.0.5

二级菜单列表

示例值:

type ChatMenuTree added in v3.0.5

type ChatMenuTree struct {
	ChatMenuTopLevels []*ChatMenuTopLevel `json:"chat_menu_top_levels,omitempty"` // 一级菜单列表
}

type ChatMenuTreeBuilder added in v3.0.5

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

func NewChatMenuTreeBuilder added in v3.0.5

func NewChatMenuTreeBuilder() *ChatMenuTreeBuilder

func (*ChatMenuTreeBuilder) Build added in v3.0.5

func (builder *ChatMenuTreeBuilder) Build() *ChatMenuTree

func (*ChatMenuTreeBuilder) ChatMenuTopLevels added in v3.0.5

func (builder *ChatMenuTreeBuilder) ChatMenuTopLevels(chatMenuTopLevels []*ChatMenuTopLevel) *ChatMenuTreeBuilder

一级菜单列表

示例值:

type ChatTab

type ChatTab struct {
	TabId      *string         `json:"tab_id,omitempty"`      // Tab ID
	TabName    *string         `json:"tab_name,omitempty"`    // Tab名称;;**注意**:会话标签页的名称不能超过30个字符
	TabType    *string         `json:"tab_type,omitempty"`    // Tab类型
	TabContent *ChatTabContent `json:"tab_content,omitempty"` // Tab内容
	TabConfig  *ChatTabConfig  `json:"tab_config,omitempty"`  // Tab的配置
}

type ChatTabBuilder

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

func NewChatTabBuilder

func NewChatTabBuilder() *ChatTabBuilder

func (*ChatTabBuilder) Build

func (builder *ChatTabBuilder) Build() *ChatTab

func (*ChatTabBuilder) TabConfig added in v3.0.10

func (builder *ChatTabBuilder) TabConfig(tabConfig *ChatTabConfig) *ChatTabBuilder

Tab的配置

示例值:

func (*ChatTabBuilder) TabContent

func (builder *ChatTabBuilder) TabContent(tabContent *ChatTabContent) *ChatTabBuilder

Tab内容

示例值:

func (*ChatTabBuilder) TabId

func (builder *ChatTabBuilder) TabId(tabId string) *ChatTabBuilder

Tab ID

示例值:7101214603622940671

func (*ChatTabBuilder) TabName

func (builder *ChatTabBuilder) TabName(tabName string) *ChatTabBuilder

Tab名称;;**注意**:会话标签页的名称不能超过30个字符

示例值:文档

func (*ChatTabBuilder) TabType

func (builder *ChatTabBuilder) TabType(tabType string) *ChatTabBuilder

Tab类型

示例值:doc

type ChatTabConfig added in v3.0.3

type ChatTabConfig struct {
	IconKey   *string `json:"icon_key,omitempty"`    // 群Tab图标
	IsBuiltIn *bool   `json:"is_built_in,omitempty"` // 群tab是否App内嵌打开
}

type ChatTabConfigBuilder added in v3.0.3

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

func NewChatTabConfigBuilder added in v3.0.3

func NewChatTabConfigBuilder() *ChatTabConfigBuilder

func (*ChatTabConfigBuilder) Build added in v3.0.3

func (builder *ChatTabConfigBuilder) Build() *ChatTabConfig

func (*ChatTabConfigBuilder) IconKey added in v3.0.3

func (builder *ChatTabConfigBuilder) IconKey(iconKey string) *ChatTabConfigBuilder

群Tab图标

示例值:img_v2_b99741-7628-4abd-aad0-b881e4db83ig

func (*ChatTabConfigBuilder) IsBuiltIn added in v3.0.3

func (builder *ChatTabConfigBuilder) IsBuiltIn(isBuiltIn bool) *ChatTabConfigBuilder

群tab是否App内嵌打开

示例值:false

type ChatTabContent

type ChatTabContent struct {
	Url           *string `json:"url,omitempty"`            // URL类型
	Doc           *string `json:"doc,omitempty"`            // Doc链接
	MeetingMinute *string `json:"meeting_minute,omitempty"` // 会议纪要
}

type ChatTabContentBuilder

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

func NewChatTabContentBuilder

func NewChatTabContentBuilder() *ChatTabContentBuilder

func (*ChatTabContentBuilder) Build

func (builder *ChatTabContentBuilder) Build() *ChatTabContent

func (*ChatTabContentBuilder) Doc

Doc链接

示例值:https://bytedance.feishu.cn/wiki/wikcnPIcqWjJQwkwDzrB9t40123xz

func (*ChatTabContentBuilder) MeetingMinute

func (builder *ChatTabContentBuilder) MeetingMinute(meetingMinute string) *ChatTabContentBuilder

会议纪要

示例值:https://bytedance.feishu.cn/docs/doccnvIXbV22i6hSD3utar4123dx

func (*ChatTabContentBuilder) Url

URL类型

示例值:https://www.feishu.cn

type ChatTopNotice

type ChatTopNotice struct {
	ActionType *string `json:"action_type,omitempty"` // 置顶的类型;;**注意**:;- 选择 ==消息类型== 时必须填写`message_id`字段;- 选择 ==群公告类型== 时填写的`message_id`将被忽略
	MessageId  *string `json:"message_id,omitempty"`  // 消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
}

type ChatTopNoticeBuilder

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

func NewChatTopNoticeBuilder

func NewChatTopNoticeBuilder() *ChatTopNoticeBuilder

func (*ChatTopNoticeBuilder) ActionType

func (builder *ChatTopNoticeBuilder) ActionType(actionType string) *ChatTopNoticeBuilder

置顶的类型;;**注意**:;- 选择 ==消息类型== 时必须填写`message_id`字段;- 选择 ==群公告类型== 时填写的`message_id`将被忽略

示例值:2

func (*ChatTopNoticeBuilder) Build

func (builder *ChatTopNoticeBuilder) Build() *ChatTopNotice

func (*ChatTopNoticeBuilder) MessageId

func (builder *ChatTopNoticeBuilder) MessageId(messageId string) *ChatTopNoticeBuilder

消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

type Crc32Item added in v3.0.19

type Crc32Item struct {
	PartId *string `json:"part_id,omitempty"` // 分片编号(1开始)
	Crc32  *string `json:"crc32,omitempty"`   // crc32校验
}

type Crc32ItemBuilder added in v3.0.19

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

func NewCrc32ItemBuilder added in v3.0.19

func NewCrc32ItemBuilder() *Crc32ItemBuilder

func (*Crc32ItemBuilder) Build added in v3.0.19

func (builder *Crc32ItemBuilder) Build() *Crc32Item

func (*Crc32ItemBuilder) Crc32 added in v3.0.19

func (builder *Crc32ItemBuilder) Crc32(crc32 string) *Crc32ItemBuilder

crc32校验

示例值:12342388237783212356

func (*Crc32ItemBuilder) PartId added in v3.0.19

func (builder *Crc32ItemBuilder) PartId(partId string) *Crc32ItemBuilder

分片编号(1开始)

示例值:1

type CreateChatMembersPathReqBodyBuilder

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

func NewCreateChatMembersPathReqBodyBuilder

func NewCreateChatMembersPathReqBodyBuilder() *CreateChatMembersPathReqBodyBuilder

func (*CreateChatMembersPathReqBodyBuilder) Build

func (*CreateChatMembersPathReqBodyBuilder) IdList

成员ID列表,获取ID请参见[如何获得 User ID、Open ID 和 Union ID?](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get);;**注意**:;- 成员列表不可为空;- 每次请求最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人;- 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应;- 对于已认证企业的飞书的群人数默认上限:普通群5000人,会议群3000人,话题群5000人。若租户管理员配置了群人数上限,则群人数上限为该人数上限。

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type CreateChatMembersReq

type CreateChatMembersReq struct {
	Body *CreateChatMembersReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateChatMembersReqBody

type CreateChatMembersReqBody struct {
	IdList []string `json:"id_list,omitempty"` // 成员ID列表,获取ID请参见[如何获得 User ID、Open ID 和 Union ID?](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get);;**注意**:;- 成员列表不可为空;- 每次请求最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人;- 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应;- 对于已认证企业的飞书的群人数默认上限:普通群5000人,会议群3000人,话题群5000人。若租户管理员配置了群人数上限,则群人数上限为该人数上限。
}

type CreateChatMembersReqBodyBuilder

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

func NewCreateChatMembersReqBodyBuilder

func NewCreateChatMembersReqBodyBuilder() *CreateChatMembersReqBodyBuilder

func (*CreateChatMembersReqBodyBuilder) Build

func (*CreateChatMembersReqBodyBuilder) IdList

成员ID列表,获取ID请参见[如何获得 User ID、Open ID 和 Union ID?](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get);;**注意**:;- 成员列表不可为空;- 每次请求最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人;- 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应;- 对于已认证企业的飞书的群人数默认上限:普通群5000人,会议群3000人,话题群5000人。若租户管理员配置了群人数上限,则群人数上限为该人数上限。

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type CreateChatMembersReqBuilder

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

func NewCreateChatMembersReqBuilder

func NewCreateChatMembersReqBuilder() *CreateChatMembersReqBuilder

func (*CreateChatMembersReqBuilder) Body

将用户或机器人拉入群聊。

func (*CreateChatMembersReqBuilder) Build

func (*CreateChatMembersReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`、`topic`的群组ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*CreateChatMembersReqBuilder) MemberIdType

func (builder *CreateChatMembersReqBuilder) MemberIdType(memberIdType string) *CreateChatMembersReqBuilder

进群成员 ID 类型 open_id/user_id/union_id/app_id;;**注意**:拉机器人入群请使用 ==app_id==

示例值:open_id

func (*CreateChatMembersReqBuilder) SucceedType

func (builder *CreateChatMembersReqBuilder) SucceedType(succeedType int) *CreateChatMembersReqBuilder

出现不可用ID后的处理方式 0/1/2

示例值:0

type CreateChatMembersResp

type CreateChatMembersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateChatMembersRespData `json:"data"` // 业务数据
}

func (*CreateChatMembersResp) Success

func (resp *CreateChatMembersResp) Success() bool

type CreateChatMembersRespData

type CreateChatMembersRespData 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列表
}

type CreateChatMenuTreePathReqBodyBuilder added in v3.0.13

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

func NewCreateChatMenuTreePathReqBodyBuilder added in v3.0.13

func NewCreateChatMenuTreePathReqBodyBuilder() *CreateChatMenuTreePathReqBodyBuilder

func (*CreateChatMenuTreePathReqBodyBuilder) Build added in v3.0.13

func (*CreateChatMenuTreePathReqBodyBuilder) MenuTree added in v3.0.13

要向群内追加的菜单

示例值:

type CreateChatMenuTreeReq added in v3.0.13

type CreateChatMenuTreeReq struct {
	Body *CreateChatMenuTreeReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateChatMenuTreeReqBody added in v3.0.13

type CreateChatMenuTreeReqBody struct {
	MenuTree *ChatMenuTree `json:"menu_tree,omitempty"` // 要向群内追加的菜单
}

type CreateChatMenuTreeReqBodyBuilder added in v3.0.13

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

func NewCreateChatMenuTreeReqBodyBuilder added in v3.0.13

func NewCreateChatMenuTreeReqBodyBuilder() *CreateChatMenuTreeReqBodyBuilder

func (*CreateChatMenuTreeReqBodyBuilder) Build added in v3.0.13

func (*CreateChatMenuTreeReqBodyBuilder) MenuTree added in v3.0.13

要向群内追加的菜单

示例值:

type CreateChatMenuTreeReqBuilder added in v3.0.13

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

func NewCreateChatMenuTreeReqBuilder added in v3.0.13

func NewCreateChatMenuTreeReqBuilder() *CreateChatMenuTreeReqBuilder

func (*CreateChatMenuTreeReqBuilder) Body added in v3.0.13

向群内添加群菜单。

func (*CreateChatMenuTreeReqBuilder) Build added in v3.0.13

func (*CreateChatMenuTreeReqBuilder) ChatId added in v3.0.13

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type CreateChatMenuTreeResp added in v3.0.13

type CreateChatMenuTreeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateChatMenuTreeRespData `json:"data"` // 业务数据
}

func (*CreateChatMenuTreeResp) Success added in v3.0.13

func (resp *CreateChatMenuTreeResp) Success() bool

type CreateChatMenuTreeRespData added in v3.0.13

type CreateChatMenuTreeRespData struct {
	MenuTree *ChatMenuTree `json:"menu_tree,omitempty"` // 追加后群内现有菜单
}

type CreateChatPathReqBodyBuilder

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

func NewCreateChatPathReqBodyBuilder

func NewCreateChatPathReqBodyBuilder() *CreateChatPathReqBodyBuilder

func (*CreateChatPathReqBodyBuilder) Avatar

群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)

示例值:default-avatar_44ae0ca3-e140-494b-956f-78091e348435

func (*CreateChatPathReqBodyBuilder) BotIdList

func (builder *CreateChatPathReqBodyBuilder) BotIdList(botIdList []string) *CreateChatPathReqBodyBuilder

创建群时邀请的群机器人;可参考[如何获取应用的 App ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)来获取应用的App ID; ;**注意:** ;- 拉机器人入群请使用`app_id`;- 最多同时邀请5个机器人,并且群组最多容纳 15 个机器人

示例值:["cli_a10fbf7e94b8d01d"]

func (*CreateChatPathReqBodyBuilder) Build

func (*CreateChatPathReqBodyBuilder) ChatMode

群模式;;**可选值有**:;- `group`:群组

示例值:group

func (*CreateChatPathReqBodyBuilder) ChatType

群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群

示例值:private

func (*CreateChatPathReqBodyBuilder) Description

func (builder *CreateChatPathReqBodyBuilder) Description(description string) *CreateChatPathReqBodyBuilder

群描述

示例值:测试群描述

func (*CreateChatPathReqBodyBuilder) EditPermission added in v3.0.29

func (builder *CreateChatPathReqBodyBuilder) EditPermission(editPermission string) *CreateChatPathReqBodyBuilder

谁可以编辑群信息

示例值:all_members

func (*CreateChatPathReqBodyBuilder) I18nNames

群国际化名称

示例值:

func (*CreateChatPathReqBodyBuilder) JoinMessageVisibility

func (builder *CreateChatPathReqBodyBuilder) JoinMessageVisibility(joinMessageVisibility string) *CreateChatPathReqBodyBuilder

入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:all_members

func (*CreateChatPathReqBodyBuilder) LeaveMessageVisibility

func (builder *CreateChatPathReqBodyBuilder) LeaveMessageVisibility(leaveMessageVisibility string) *CreateChatPathReqBodyBuilder

退群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:all_members

func (*CreateChatPathReqBodyBuilder) MembershipApproval

func (builder *CreateChatPathReqBodyBuilder) MembershipApproval(membershipApproval string) *CreateChatPathReqBodyBuilder

加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

示例值:no_approval_required

func (*CreateChatPathReqBodyBuilder) Name

群名称;; **注意:** ;- 公开群名称的长度不得少于2个字符;- 私有群若未填写群名称,群名称默认设置为 ”`(无主题)`“

示例值:测试群名称

func (*CreateChatPathReqBodyBuilder) OwnerId

创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID值应与查询参数中的 ==user_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID

示例值:4d7a3c6g

func (*CreateChatPathReqBodyBuilder) RestrictedModeSetting added in v3.0.20

func (builder *CreateChatPathReqBodyBuilder) RestrictedModeSetting(restrictedModeSetting *RestrictedModeSetting) *CreateChatPathReqBodyBuilder

防泄密模式设置

示例值:

func (*CreateChatPathReqBodyBuilder) UrgentSetting added in v3.0.29

func (builder *CreateChatPathReqBodyBuilder) UrgentSetting(urgentSetting string) *CreateChatPathReqBodyBuilder

谁可以加急

示例值:all_members

func (*CreateChatPathReqBodyBuilder) UserIdList

func (builder *CreateChatPathReqBodyBuilder) UserIdList(userIdList []string) *CreateChatPathReqBodyBuilder

创建群时邀请的群成员,ID 类型在查询参数 ==user_id_type== 中指定;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID;;**注意**:;- 最多同时邀请 50 个用户;- 为便于在客户端查看效果,建议调试接口时加入开发者自身ID

示例值:["4d7a3c6g"]

func (*CreateChatPathReqBodyBuilder) VideoConferenceSetting added in v3.0.29

func (builder *CreateChatPathReqBodyBuilder) VideoConferenceSetting(videoConferenceSetting string) *CreateChatPathReqBodyBuilder

谁可以发起视频会议

示例值:all_members

type CreateChatReq

type CreateChatReq struct {
	Body *CreateChatReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateChatReqBody

type CreateChatReqBody struct {
	Avatar      *string    `json:"avatar,omitempty"`       // 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)
	Name        *string    `json:"name,omitempty"`         // 群名称;; **注意:** ;- 公开群名称的长度不得少于2个字符;- 私有群若未填写群名称,群名称默认设置为 ”`(无主题)`“
	Description *string    `json:"description,omitempty"`  // 群描述
	I18nNames   *I18nNames `json:"i18n_names,omitempty"`   // 群国际化名称
	OwnerId     *string    `json:"owner_id,omitempty"`     // 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID值应与查询参数中的 ==user_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID
	UserIdList  []string   `json:"user_id_list,omitempty"` // 创建群时邀请的群成员,ID 类型在查询参数 ==user_id_type== 中指定;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID;;**注意**:;- 最多同时邀请 50 个用户;- 为便于在客户端查看效果,建议调试接口时加入开发者自身ID
	BotIdList   []string   `json:"bot_id_list,omitempty"`  // 创建群时邀请的群机器人;可参考[如何获取应用的 App ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)来获取应用的App ID; ;**注意:** ;- 拉机器人入群请使用`app_id`;- 最多同时邀请5个机器人,并且群组最多容纳 15 个机器人
	ChatMode    *string    `json:"chat_mode,omitempty"`    // 群模式;;**可选值有**:;- `group`:群组
	ChatType    *string    `json:"chat_type,omitempty"`    // 群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群

	JoinMessageVisibility  *string `json:"join_message_visibility,omitempty"`  // 入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见
	LeaveMessageVisibility *string `json:"leave_message_visibility,omitempty"` // 退群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见
	MembershipApproval     *string `json:"membership_approval,omitempty"`      // 加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

	RestrictedModeSetting  *RestrictedModeSetting `json:"restricted_mode_setting,omitempty"`  // 防泄密模式设置
	UrgentSetting          *string                `json:"urgent_setting,omitempty"`           // 谁可以加急
	VideoConferenceSetting *string                `json:"video_conference_setting,omitempty"` // 谁可以发起视频会议
	EditPermission         *string                `json:"edit_permission,omitempty"`          // 谁可以编辑群信息

}

type CreateChatReqBodyBuilder

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

func NewCreateChatReqBodyBuilder

func NewCreateChatReqBodyBuilder() *CreateChatReqBodyBuilder

func (*CreateChatReqBodyBuilder) Avatar

func (builder *CreateChatReqBodyBuilder) Avatar(avatar string) *CreateChatReqBodyBuilder

群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)

示例值:default-avatar_44ae0ca3-e140-494b-956f-78091e348435

func (*CreateChatReqBodyBuilder) BotIdList

func (builder *CreateChatReqBodyBuilder) BotIdList(botIdList []string) *CreateChatReqBodyBuilder

创建群时邀请的群机器人;可参考[如何获取应用的 App ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)来获取应用的App ID; ;**注意:** ;- 拉机器人入群请使用`app_id`;- 最多同时邀请5个机器人,并且群组最多容纳 15 个机器人

示例值:["cli_a10fbf7e94b8d01d"]

func (*CreateChatReqBodyBuilder) Build

func (builder *CreateChatReqBodyBuilder) Build() *CreateChatReqBody

func (*CreateChatReqBodyBuilder) ChatMode

func (builder *CreateChatReqBodyBuilder) ChatMode(chatMode string) *CreateChatReqBodyBuilder

群模式;;**可选值有**:;- `group`:群组

示例值:group

func (*CreateChatReqBodyBuilder) ChatType

func (builder *CreateChatReqBodyBuilder) ChatType(chatType string) *CreateChatReqBodyBuilder

群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群

示例值:private

func (*CreateChatReqBodyBuilder) Description

func (builder *CreateChatReqBodyBuilder) Description(description string) *CreateChatReqBodyBuilder

群描述

示例值:测试群描述

func (*CreateChatReqBodyBuilder) EditPermission added in v3.0.29

func (builder *CreateChatReqBodyBuilder) EditPermission(editPermission string) *CreateChatReqBodyBuilder

谁可以编辑群信息

示例值:all_members

func (*CreateChatReqBodyBuilder) I18nNames

func (builder *CreateChatReqBodyBuilder) I18nNames(i18nNames *I18nNames) *CreateChatReqBodyBuilder

群国际化名称

示例值:

func (*CreateChatReqBodyBuilder) JoinMessageVisibility

func (builder *CreateChatReqBodyBuilder) JoinMessageVisibility(joinMessageVisibility string) *CreateChatReqBodyBuilder

入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:all_members

func (*CreateChatReqBodyBuilder) LeaveMessageVisibility

func (builder *CreateChatReqBodyBuilder) LeaveMessageVisibility(leaveMessageVisibility string) *CreateChatReqBodyBuilder

退群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:all_members

func (*CreateChatReqBodyBuilder) MembershipApproval

func (builder *CreateChatReqBodyBuilder) MembershipApproval(membershipApproval string) *CreateChatReqBodyBuilder

加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

示例值:no_approval_required

func (*CreateChatReqBodyBuilder) Name

群名称;; **注意:** ;- 公开群名称的长度不得少于2个字符;- 私有群若未填写群名称,群名称默认设置为 ”`(无主题)`“

示例值:测试群名称

func (*CreateChatReqBodyBuilder) OwnerId

func (builder *CreateChatReqBodyBuilder) OwnerId(ownerId string) *CreateChatReqBodyBuilder

创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID值应与查询参数中的 ==user_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID

示例值:4d7a3c6g

func (*CreateChatReqBodyBuilder) RestrictedModeSetting added in v3.0.20

func (builder *CreateChatReqBodyBuilder) RestrictedModeSetting(restrictedModeSetting *RestrictedModeSetting) *CreateChatReqBodyBuilder

防泄密模式设置

示例值:

func (*CreateChatReqBodyBuilder) UrgentSetting added in v3.0.29

func (builder *CreateChatReqBodyBuilder) UrgentSetting(urgentSetting string) *CreateChatReqBodyBuilder

谁可以加急

示例值:all_members

func (*CreateChatReqBodyBuilder) UserIdList

func (builder *CreateChatReqBodyBuilder) UserIdList(userIdList []string) *CreateChatReqBodyBuilder

创建群时邀请的群成员,ID 类型在查询参数 ==user_id_type== 中指定;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID;;**注意**:;- 最多同时邀请 50 个用户;- 为便于在客户端查看效果,建议调试接口时加入开发者自身ID

示例值:["4d7a3c6g"]

func (*CreateChatReqBodyBuilder) VideoConferenceSetting added in v3.0.29

func (builder *CreateChatReqBodyBuilder) VideoConferenceSetting(videoConferenceSetting string) *CreateChatReqBodyBuilder

谁可以发起视频会议

示例值:all_members

type CreateChatReqBuilder

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

func NewCreateChatReqBuilder

func NewCreateChatReqBuilder() *CreateChatReqBuilder

func (*CreateChatReqBuilder) Body

创建群并设置群头像、群名、群描述等。

func (*CreateChatReqBuilder) Build

func (builder *CreateChatReqBuilder) Build() *CreateChatReq

func (*CreateChatReqBuilder) SetBotManager

func (builder *CreateChatReqBuilder) SetBotManager(setBotManager bool) *CreateChatReqBuilder

如果在请求体的 ==owner_id== 字段指定了某个用户为群主,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员

示例值:false

func (*CreateChatReqBuilder) UserIdType

func (builder *CreateChatReqBuilder) UserIdType(userIdType string) *CreateChatReqBuilder

此次调用中使用的用户ID的类型

示例值:open_id

func (*CreateChatReqBuilder) Uuid added in v3.0.10

func (builder *CreateChatReqBuilder) Uuid(uuid string) *CreateChatReqBuilder

由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊

示例值:b13g2t38-1jd2-458b-8djf-dtbca5104204

type CreateChatResp

type CreateChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateChatRespData `json:"data"` // 业务数据
}

func (*CreateChatResp) Success

func (resp *CreateChatResp) Success() bool

type CreateChatRespData

type CreateChatRespData struct {
	ChatId                 *string    `json:"chat_id,omitempty"`                  // 群 ID,详情参见:[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	Avatar                 *string    `json:"avatar,omitempty"`                   // 群头像 URL
	Name                   *string    `json:"name,omitempty"`                     // 群名称
	Description            *string    `json:"description,omitempty"`              // 群描述
	I18nNames              *I18nNames `json:"i18n_names,omitempty"`               // 群国际化名称
	OwnerId                *string    `json:"owner_id,omitempty"`                 // 群主 ID,ID值与查询参数中的 ==user_id_type== 对应;不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction);;**注意**:当群主是机器人时,该字段不返回
	OwnerIdType            *string    `json:"owner_id_type,omitempty"`            // 群主 ID 对应的ID类型,与查询参数中的 ==user_id_type== 相同。取值为:`open_id`、`user_id`、`union_id`其中之一;;**注意**:当群主是机器人时,该字段不返回
	UrgentSetting          *string    `json:"urgent_setting,omitempty"`           // 谁可以加急
	VideoConferenceSetting *string    `json:"video_conference_setting,omitempty"` // 谁可以发起视频会议
	AddMemberPermission    *string    `json:"add_member_permission,omitempty"`    // 拉 用户或机器人 入群权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	ShareCardPermission    *string    `json:"share_card_permission,omitempty"`    // 群分享权限;;**可选值有**:;- `allowed`:允许;- `not_allowed`:不允许
	AtAllPermission        *string    `json:"at_all_permission,omitempty"`        // at 所有人权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	EditPermission         *string    `json:"edit_permission,omitempty"`          // 群编辑权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	ChatMode               *string    `json:"chat_mode,omitempty"`                // 群模式;;**可选值有**:;- `group`:群组
	ChatType               *string    `json:"chat_type,omitempty"`                // 群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群
	ChatTag                *string    `json:"chat_tag,omitempty"`                 // 群标签,如有多个,则按照下列顺序返回第一个;;**可选值有**:;- `inner`:内部群;- `tenant`:公司群;- `department`:部门群;- `edu`:教育群;- `meeting`:会议群;- `customer_service`:客服群
	External               *bool      `json:"external,omitempty"`                 // 是否是外部群
	TenantKey              *string    `json:"tenant_key,omitempty"`               // 租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
	JoinMessageVisibility  *string    `json:"join_message_visibility,omitempty"`  // 入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见
	LeaveMessageVisibility *string    `json:"leave_message_visibility,omitempty"` // 出群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见
	MembershipApproval     *string    `json:"membership_approval,omitempty"`      // 加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批
	ModerationPermission   *string    `json:"moderation_permission,omitempty"`    // 发言权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员;- `moderator_list`:指定群成员

	RestrictedModeSetting *RestrictedModeSetting `json:"restricted_mode_setting,omitempty"` // 防泄密模式设置
}

type CreateChatTabPathReqBodyBuilder

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

func NewCreateChatTabPathReqBodyBuilder

func NewCreateChatTabPathReqBodyBuilder() *CreateChatTabPathReqBodyBuilder

func (*CreateChatTabPathReqBodyBuilder) Build

func (*CreateChatTabPathReqBodyBuilder) ChatTabs

会话标签页;;**注意**:一个群内最多只允许添加20个自定义会话标签页

示例值:

type CreateChatTabReq

type CreateChatTabReq struct {
	Body *CreateChatTabReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateChatTabReqBody

type CreateChatTabReqBody struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 会话标签页;;**注意**:一个群内最多只允许添加20个自定义会话标签页
}

type CreateChatTabReqBodyBuilder

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

func NewCreateChatTabReqBodyBuilder

func NewCreateChatTabReqBodyBuilder() *CreateChatTabReqBodyBuilder

func (*CreateChatTabReqBodyBuilder) Build

func (*CreateChatTabReqBodyBuilder) ChatTabs

func (builder *CreateChatTabReqBodyBuilder) ChatTabs(chatTabs []*ChatTab) *CreateChatTabReqBodyBuilder

会话标签页;;**注意**:一个群内最多只允许添加20个自定义会话标签页

示例值:

type CreateChatTabReqBuilder

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

func NewCreateChatTabReqBuilder

func NewCreateChatTabReqBuilder() *CreateChatTabReqBuilder

func (*CreateChatTabReqBuilder) Body

添加自定义会话标签页。

func (*CreateChatTabReqBuilder) Build

func (builder *CreateChatTabReqBuilder) Build() *CreateChatTabReq

func (*CreateChatTabReqBuilder) ChatId

func (builder *CreateChatTabReqBuilder) ChatId(chatId string) *CreateChatTabReqBuilder

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:支持群模式为`p2p`与`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type CreateChatTabResp

type CreateChatTabResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateChatTabRespData `json:"data"` // 业务数据
}

func (*CreateChatTabResp) Success

func (resp *CreateChatTabResp) Success() bool

type CreateChatTabRespData

type CreateChatTabRespData struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 会话标签页
}

type CreateFilePathReqBodyBuilder

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

func NewCreateFilePathReqBodyBuilder

func NewCreateFilePathReqBodyBuilder() *CreateFilePathReqBodyBuilder

func (*CreateFilePathReqBodyBuilder) Build

func (*CreateFilePathReqBodyBuilder) Duration

func (builder *CreateFilePathReqBodyBuilder) Duration(duration int) *CreateFilePathReqBodyBuilder

文件的时长(视频、音频),单位:毫秒。不填充时无法显示具体时长。

示例值:3000

func (*CreateFilePathReqBodyBuilder) FileName

带后缀的文件名

示例值:测试视频.mp4

func (*CreateFilePathReqBodyBuilder) FilePath

文件内容

示例值:二进制文件

func (*CreateFilePathReqBodyBuilder) FileType

文件类型

示例值:mp4

type CreateFileReq

type CreateFileReq struct {
	Body *CreateFileReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateFileReqBody

type CreateFileReqBody struct {
	FileType *string   `json:"file_type,omitempty"` // 文件类型
	FileName *string   `json:"file_name,omitempty"` // 带后缀的文件名
	Duration *int      `json:"duration,omitempty"`  // 文件的时长(视频、音频),单位:毫秒。不填充时无法显示具体时长。
	File     io.Reader `json:"file,omitempty"`      // 文件内容
}

type CreateFileReqBodyBuilder

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

func NewCreateFileReqBodyBuilder

func NewCreateFileReqBodyBuilder() *CreateFileReqBodyBuilder

func (*CreateFileReqBodyBuilder) Build

func (builder *CreateFileReqBodyBuilder) Build() *CreateFileReqBody

func (*CreateFileReqBodyBuilder) Duration

func (builder *CreateFileReqBodyBuilder) Duration(duration int) *CreateFileReqBodyBuilder

文件的时长(视频、音频),单位:毫秒。不填充时无法显示具体时长。

示例值:3000

func (*CreateFileReqBodyBuilder) File

文件内容

示例值:二进制文件

func (*CreateFileReqBodyBuilder) FileName

func (builder *CreateFileReqBodyBuilder) FileName(fileName string) *CreateFileReqBodyBuilder

带后缀的文件名

示例值:测试视频.mp4

func (*CreateFileReqBodyBuilder) FileType

func (builder *CreateFileReqBodyBuilder) FileType(fileType string) *CreateFileReqBodyBuilder

文件类型

示例值:mp4

type CreateFileReqBuilder

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

func NewCreateFileReqBuilder

func NewCreateFileReqBuilder() *CreateFileReqBuilder

func (*CreateFileReqBuilder) Body

上传文件,可以上传视频,音频和常见的文件类型。

func (*CreateFileReqBuilder) Build

func (builder *CreateFileReqBuilder) Build() *CreateFileReq

type CreateFileResp

type CreateFileResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateFileRespData `json:"data"` // 业务数据
}

func (*CreateFileResp) Success

func (resp *CreateFileResp) Success() bool

type CreateFileRespData

type CreateFileRespData struct {
	FileKey *string `json:"file_key,omitempty"` // 文件的key
}

type CreateImagePathReqBodyBuilder

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

func NewCreateImagePathReqBodyBuilder

func NewCreateImagePathReqBodyBuilder() *CreateImagePathReqBodyBuilder

func (*CreateImagePathReqBodyBuilder) Build

func (*CreateImagePathReqBodyBuilder) ImagePath

图片内容;; **注意:** 上传的图片大小不能超过10MB

示例值:二进制文件

func (*CreateImagePathReqBodyBuilder) ImageType

图片类型

示例值:message

type CreateImageReq

type CreateImageReq struct {
	Body *CreateImageReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateImageReqBody

type CreateImageReqBody struct {
	ImageType *string   `json:"image_type,omitempty"` // 图片类型
	Image     io.Reader `json:"image,omitempty"`      // 图片内容;; **注意:** 上传的图片大小不能超过10MB
}

type CreateImageReqBodyBuilder

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

func NewCreateImageReqBodyBuilder

func NewCreateImageReqBodyBuilder() *CreateImageReqBodyBuilder

func (*CreateImageReqBodyBuilder) Build

func (*CreateImageReqBodyBuilder) Image

图片内容;; **注意:** 上传的图片大小不能超过10MB

示例值:二进制文件

func (*CreateImageReqBodyBuilder) ImageType

func (builder *CreateImageReqBodyBuilder) ImageType(imageType string) *CreateImageReqBodyBuilder

图片类型

示例值:message

type CreateImageReqBuilder

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

func NewCreateImageReqBuilder

func NewCreateImageReqBuilder() *CreateImageReqBuilder

func (*CreateImageReqBuilder) Body

上传图片接口,支持上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片。

func (*CreateImageReqBuilder) Build

func (builder *CreateImageReqBuilder) Build() *CreateImageReq

type CreateImageResp

type CreateImageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateImageRespData `json:"data"` // 业务数据
}

func (*CreateImageResp) Success

func (resp *CreateImageResp) Success() bool

type CreateImageRespData

type CreateImageRespData struct {
	ImageKey *string `json:"image_key,omitempty"` // 图片的key
}

type CreateMessagePathReqBodyBuilder

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

func NewCreateMessagePathReqBodyBuilder

func NewCreateMessagePathReqBodyBuilder() *CreateMessagePathReqBodyBuilder

func (*CreateMessagePathReqBodyBuilder) Build

func (*CreateMessagePathReqBodyBuilder) Content

消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,具体格式说明参考:[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json);;<b>请求体大小限制</b>:;- 文本消息请求体最大不能超过150KB;- 卡片及富文本消息请求体最大不能超过30KB

示例值:{\"text\":\"<at user_id=\\\"ou_155184d1e73cbfb8973e5a9e698e74f2\\\">Tom</at> test content\"}

func (*CreateMessagePathReqBodyBuilder) MsgType

消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)

示例值:text

func (*CreateMessagePathReqBodyBuilder) ReceiveId

消息接收者的ID,ID类型应与查询参数==receive_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取消息接收者的Open ID

示例值:ou_7d8a6e6df7621556ce0d21922b676706ccs

func (*CreateMessagePathReqBodyBuilder) Uuid added in v3.0.1

由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次

示例值:a0d69e20-1dd1-458b-k525-dfeca4015204

type CreateMessageReactionPathReqBodyBuilder

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

func NewCreateMessageReactionPathReqBodyBuilder

func NewCreateMessageReactionPathReqBodyBuilder() *CreateMessageReactionPathReqBodyBuilder

func (*CreateMessageReactionPathReqBodyBuilder) Build

func (*CreateMessageReactionPathReqBodyBuilder) ReactionType

reaction资源类型

示例值:

type CreateMessageReactionReq

type CreateMessageReactionReq struct {
	Body *CreateMessageReactionReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateMessageReactionReqBody

type CreateMessageReactionReqBody struct {
	ReactionType *Emoji `json:"reaction_type,omitempty"` // reaction资源类型
}

type CreateMessageReactionReqBodyBuilder

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

func NewCreateMessageReactionReqBodyBuilder

func NewCreateMessageReactionReqBodyBuilder() *CreateMessageReactionReqBodyBuilder

func (*CreateMessageReactionReqBodyBuilder) Build

func (*CreateMessageReactionReqBodyBuilder) ReactionType

reaction资源类型

示例值:

type CreateMessageReactionReqBuilder

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

func NewCreateMessageReactionReqBuilder

func NewCreateMessageReactionReqBuilder() *CreateMessageReactionReqBuilder

func (*CreateMessageReactionReqBuilder) Body

给指定消息添加指定类型的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。

func (*CreateMessageReactionReqBuilder) Build

func (*CreateMessageReactionReqBuilder) MessageId

待添加reaction的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_a8f2294b************a1a38afaac9d

type CreateMessageReactionResp

type CreateMessageReactionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateMessageReactionRespData `json:"data"` // 业务数据
}

func (*CreateMessageReactionResp) Success

func (resp *CreateMessageReactionResp) Success() bool

type CreateMessageReactionRespData

type CreateMessageReactionRespData struct {
	ReactionId   *string   `json:"reaction_id,omitempty"`   // reaction资源ID
	Operator     *Operator `json:"operator,omitempty"`      // 添加reaction的操作人
	ActionTime   *string   `json:"action_time,omitempty"`   // reaction动作的的unix timestamp(单位:ms)
	ReactionType *Emoji    `json:"reaction_type,omitempty"` // reaction资源类型
}

type CreateMessageReq

type CreateMessageReq struct {
	Body *CreateMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateMessageReqBody

type CreateMessageReqBody struct {
	ReceiveId *string `json:"receive_id,omitempty"` // 消息接收者的ID,ID类型应与查询参数==receive_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取消息接收者的Open ID
	MsgType   *string `json:"msg_type,omitempty"`   // 消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)
	Content   *string `json:"content,omitempty"`    // 消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,具体格式说明参考:[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json);;<b>请求体大小限制</b>:;- 文本消息请求体最大不能超过150KB;- 卡片及富文本消息请求体最大不能超过30KB
	Uuid      *string `json:"uuid,omitempty"`       // 由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次
}

type CreateMessageReqBodyBuilder

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

func NewCreateMessageReqBodyBuilder

func NewCreateMessageReqBodyBuilder() *CreateMessageReqBodyBuilder

func (*CreateMessageReqBodyBuilder) Build

func (*CreateMessageReqBodyBuilder) Content

消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,具体格式说明参考:[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json);;<b>请求体大小限制</b>:;- 文本消息请求体最大不能超过150KB;- 卡片及富文本消息请求体最大不能超过30KB

示例值:{\"text\":\"<at user_id=\\\"ou_155184d1e73cbfb8973e5a9e698e74f2\\\">Tom</at> test content\"}

func (*CreateMessageReqBodyBuilder) MsgType

消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)

示例值:text

func (*CreateMessageReqBodyBuilder) ReceiveId

func (builder *CreateMessageReqBodyBuilder) ReceiveId(receiveId string) *CreateMessageReqBodyBuilder

消息接收者的ID,ID类型应与查询参数==receive_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取消息接收者的Open ID

示例值:ou_7d8a6e6df7621556ce0d21922b676706ccs

func (*CreateMessageReqBodyBuilder) Uuid added in v3.0.1

由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次

示例值:a0d69e20-1dd1-458b-k525-dfeca4015204

type CreateMessageReqBuilder

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

func NewCreateMessageReqBuilder

func NewCreateMessageReqBuilder() *CreateMessageReqBuilder

func (*CreateMessageReqBuilder) Body

给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。

func (*CreateMessageReqBuilder) Build

func (builder *CreateMessageReqBuilder) Build() *CreateMessageReq

func (*CreateMessageReqBuilder) ReceiveIdType

func (builder *CreateMessageReqBuilder) ReceiveIdType(receiveIdType string) *CreateMessageReqBuilder

消息接收者id类型 open_id/user_id/union_id/email/chat_id

示例值:open_id

type CreateMessageResp

type CreateMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateMessageRespData `json:"data"` // 业务数据
}

func (*CreateMessageResp) Success

func (resp *CreateMessageResp) Success() bool

type CreateMessageRespData

type CreateMessageRespData struct {
	MessageId      *string      `json:"message_id,omitempty"`       // 消息id open_message_id
	RootId         *string      `json:"root_id,omitempty"`          // 根消息id open_message_id
	ParentId       *string      `json:"parent_id,omitempty"`        // 父消息的id open_message_id
	MsgType        *string      `json:"msg_type,omitempty"`         // 消息类型 text post card image等等
	CreateTime     *string      `json:"create_time,omitempty"`      // 消息生成的时间戳(毫秒)
	UpdateTime     *string      `json:"update_time,omitempty"`      // 消息更新的时间戳
	Deleted        *bool        `json:"deleted,omitempty"`          // 消息是否被撤回
	Updated        *bool        `json:"updated,omitempty"`          // 消息是否被更新
	ChatId         *string      `json:"chat_id,omitempty"`          // 所属的群
	Sender         *Sender      `json:"sender,omitempty"`           // 发送者,可以是用户或应用
	Body           *MessageBody `json:"body,omitempty"`             // 消息内容,json结构
	Mentions       []*Mention   `json:"mentions,omitempty"`         // 被艾特的人或应用的id
	UpperMessageId *string      `json:"upper_message_id,omitempty"` // 合并消息的上一层级消息id open_message_id
}

type CreatePinPathReqBodyBuilder added in v3.0.3

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

func NewCreatePinPathReqBodyBuilder added in v3.0.3

func NewCreatePinPathReqBodyBuilder() *CreatePinPathReqBodyBuilder

func (*CreatePinPathReqBodyBuilder) Build added in v3.0.3

func (builder *CreatePinPathReqBodyBuilder) Build() (*CreatePinReqBody, error)

func (*CreatePinPathReqBodyBuilder) MessageId added in v3.0.3

func (builder *CreatePinPathReqBodyBuilder) MessageId(messageId string) *CreatePinPathReqBodyBuilder

待Pin的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

type CreatePinReq added in v3.0.3

type CreatePinReq struct {
	Body *CreatePinReqBody `body:""`
	// contains filtered or unexported fields
}

type CreatePinReqBody added in v3.0.3

type CreatePinReqBody struct {
	MessageId *string `json:"message_id,omitempty"` // 待Pin的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
}

type CreatePinReqBodyBuilder added in v3.0.3

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

func NewCreatePinReqBodyBuilder added in v3.0.3

func NewCreatePinReqBodyBuilder() *CreatePinReqBodyBuilder

func (*CreatePinReqBodyBuilder) Build added in v3.0.3

func (builder *CreatePinReqBodyBuilder) Build() *CreatePinReqBody

func (*CreatePinReqBodyBuilder) MessageId added in v3.0.3

func (builder *CreatePinReqBodyBuilder) MessageId(messageId string) *CreatePinReqBodyBuilder

待Pin的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

type CreatePinReqBuilder added in v3.0.3

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

func NewCreatePinReqBuilder added in v3.0.3

func NewCreatePinReqBuilder() *CreatePinReqBuilder

func (*CreatePinReqBuilder) Body added in v3.0.3

Pin一条指定的消息。

func (*CreatePinReqBuilder) Build added in v3.0.3

func (builder *CreatePinReqBuilder) Build() *CreatePinReq

type CreatePinResp added in v3.0.3

type CreatePinResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreatePinRespData `json:"data"` // 业务数据
}

func (*CreatePinResp) Success added in v3.0.3

func (resp *CreatePinResp) Success() bool

type CreatePinRespData added in v3.0.3

type CreatePinRespData struct {
	Pin *Pin `json:"pin,omitempty"` // Pin的操作信息
}

type DeleteBatchMessageReq

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

type DeleteBatchMessageReqBuilder

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

func NewDeleteBatchMessageReqBuilder

func NewDeleteBatchMessageReqBuilder() *DeleteBatchMessageReqBuilder

func (*DeleteBatchMessageReqBuilder) BatchMessageId

func (builder *DeleteBatchMessageReqBuilder) BatchMessageId(batchMessageId string) *DeleteBatchMessageReqBuilder

待撤回的批量消息的ID,为[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口返回值中的`message_id`字段,用于标识一次批量发送消息请求。

示例值:bm-dc13264520392913993dd051dba21dcf

func (*DeleteBatchMessageReqBuilder) Build

type DeleteBatchMessageResp

type DeleteBatchMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*DeleteBatchMessageResp) Success

func (resp *DeleteBatchMessageResp) Success() bool

type DeleteChatMembersPathReqBodyBuilder

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

func NewDeleteChatMembersPathReqBodyBuilder

func NewDeleteChatMembersPathReqBodyBuilder() *DeleteChatMembersPathReqBodyBuilder

func (*DeleteChatMembersPathReqBodyBuilder) Build

func (*DeleteChatMembersPathReqBodyBuilder) IdList

成员列表;;**注意**:;- 成员列表不可为空;- 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type DeleteChatMembersReq

type DeleteChatMembersReq struct {
	Body *DeleteChatMembersReqBody `body:""`
	// contains filtered or unexported fields
}

type DeleteChatMembersReqBody

type DeleteChatMembersReqBody struct {
	IdList []string `json:"id_list,omitempty"` // 成员列表;;**注意**:;- 成员列表不可为空;- 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应
}

type DeleteChatMembersReqBodyBuilder

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

func NewDeleteChatMembersReqBodyBuilder

func NewDeleteChatMembersReqBodyBuilder() *DeleteChatMembersReqBodyBuilder

func (*DeleteChatMembersReqBodyBuilder) Build

func (*DeleteChatMembersReqBodyBuilder) IdList

成员列表;;**注意**:;- 成员列表不可为空;- 列表中填写的成员ID类型应与 ==member_id_type== 参数中选择的类型相对应

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type DeleteChatMembersReqBuilder

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

func NewDeleteChatMembersReqBuilder

func NewDeleteChatMembersReqBuilder() *DeleteChatMembersReqBuilder

func (*DeleteChatMembersReqBuilder) Body

将用户或机器人移出群聊。

func (*DeleteChatMembersReqBuilder) Build

func (*DeleteChatMembersReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`、`topic`的群组ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*DeleteChatMembersReqBuilder) MemberIdType

func (builder *DeleteChatMembersReqBuilder) MemberIdType(memberIdType string) *DeleteChatMembersReqBuilder

出群成员ID类型;;**注意**:移除机器人请使用 ==app_id==

示例值:open_id

type DeleteChatMembersResp

type DeleteChatMembersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *DeleteChatMembersRespData `json:"data"` // 业务数据
}

func (*DeleteChatMembersResp) Success

func (resp *DeleteChatMembersResp) Success() bool

type DeleteChatMembersRespData

type DeleteChatMembersRespData struct {
	InvalidIdList []string `json:"invalid_id_list,omitempty"` // 无效成员列表
}

type DeleteChatMenuTreePathReqBodyBuilder added in v3.0.13

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

func NewDeleteChatMenuTreePathReqBodyBuilder added in v3.0.13

func NewDeleteChatMenuTreePathReqBodyBuilder() *DeleteChatMenuTreePathReqBodyBuilder

func (*DeleteChatMenuTreePathReqBodyBuilder) Build added in v3.0.13

func (*DeleteChatMenuTreePathReqBodyBuilder) ChatMenuTopLevelIds added in v3.0.13

func (builder *DeleteChatMenuTreePathReqBodyBuilder) ChatMenuTopLevelIds(chatMenuTopLevelIds []string) *DeleteChatMenuTreePathReqBodyBuilder

群内要删除的一级菜单ID。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。

示例值:7156553273518882844

type DeleteChatMenuTreeReq added in v3.0.13

type DeleteChatMenuTreeReq struct {
	Body *DeleteChatMenuTreeReqBody `body:""`
	// contains filtered or unexported fields
}

type DeleteChatMenuTreeReqBody added in v3.0.13

type DeleteChatMenuTreeReqBody struct {
	ChatMenuTopLevelIds []string `json:"chat_menu_top_level_ids,omitempty"` // 群内要删除的一级菜单ID。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。
}

type DeleteChatMenuTreeReqBodyBuilder added in v3.0.13

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

func NewDeleteChatMenuTreeReqBodyBuilder added in v3.0.13

func NewDeleteChatMenuTreeReqBodyBuilder() *DeleteChatMenuTreeReqBodyBuilder

func (*DeleteChatMenuTreeReqBodyBuilder) Build added in v3.0.13

func (*DeleteChatMenuTreeReqBodyBuilder) ChatMenuTopLevelIds added in v3.0.13

func (builder *DeleteChatMenuTreeReqBodyBuilder) ChatMenuTopLevelIds(chatMenuTopLevelIds []string) *DeleteChatMenuTreeReqBodyBuilder

群内要删除的一级菜单ID。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。

示例值:7156553273518882844

type DeleteChatMenuTreeReqBuilder added in v3.0.13

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

func NewDeleteChatMenuTreeReqBuilder added in v3.0.13

func NewDeleteChatMenuTreeReqBuilder() *DeleteChatMenuTreeReqBuilder

func (*DeleteChatMenuTreeReqBuilder) Body added in v3.0.13

删除群内菜单。

func (*DeleteChatMenuTreeReqBuilder) Build added in v3.0.13

func (*DeleteChatMenuTreeReqBuilder) ChatId added in v3.0.13

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type DeleteChatMenuTreeResp added in v3.0.13

type DeleteChatMenuTreeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *DeleteChatMenuTreeRespData `json:"data"` // 业务数据
}

func (*DeleteChatMenuTreeResp) Success added in v3.0.13

func (resp *DeleteChatMenuTreeResp) Success() bool

type DeleteChatMenuTreeRespData added in v3.0.13

type DeleteChatMenuTreeRespData struct {
	MenuTree *ChatMenuTree `json:"menu_tree,omitempty"` // 群内现有菜单
}

type DeleteChatReq

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

type DeleteChatReqBuilder

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

func NewDeleteChatReqBuilder

func NewDeleteChatReqBuilder() *DeleteChatReqBuilder

func (*DeleteChatReqBuilder) Build

func (builder *DeleteChatReqBuilder) Build() *DeleteChatReq

func (*DeleteChatReqBuilder) ChatId

func (builder *DeleteChatReqBuilder) ChatId(chatId string) *DeleteChatReqBuilder

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群组ID

示例值:oc_a0553eda9014c201e6969b478895c230

type DeleteChatResp

type DeleteChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*DeleteChatResp) Success

func (resp *DeleteChatResp) Success() bool

type DeleteManagersChatManagersPathReqBodyBuilder

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

func NewDeleteManagersChatManagersPathReqBodyBuilder

func NewDeleteManagersChatManagersPathReqBodyBuilder() *DeleteManagersChatManagersPathReqBodyBuilder

func (*DeleteManagersChatManagersPathReqBodyBuilder) Build

func (*DeleteManagersChatManagersPathReqBodyBuilder) ManagerIds

要删除的 manager_id;;**注意**:每次请求最多指定 50 个用户或者 5 个机器人

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type DeleteManagersChatManagersReq

type DeleteManagersChatManagersReq struct {
	Body *DeleteManagersChatManagersReqBody `body:""`
	// contains filtered or unexported fields
}

type DeleteManagersChatManagersReqBody

type DeleteManagersChatManagersReqBody struct {
	ManagerIds []string `json:"manager_ids,omitempty"` // 要删除的 manager_id;;**注意**:每次请求最多指定 50 个用户或者 5 个机器人
}

type DeleteManagersChatManagersReqBodyBuilder

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

func NewDeleteManagersChatManagersReqBodyBuilder

func NewDeleteManagersChatManagersReqBodyBuilder() *DeleteManagersChatManagersReqBodyBuilder

func (*DeleteManagersChatManagersReqBodyBuilder) Build

func (*DeleteManagersChatManagersReqBodyBuilder) ManagerIds

要删除的 manager_id;;**注意**:每次请求最多指定 50 个用户或者 5 个机器人

示例值:["ou_9204a37300b3700d61effaa439f34295"]

type DeleteManagersChatManagersReqBuilder

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

func NewDeleteManagersChatManagersReqBuilder

func NewDeleteManagersChatManagersReqBuilder() *DeleteManagersChatManagersReqBuilder

func (*DeleteManagersChatManagersReqBuilder) Body

删除指定的群管理员(用户或机器人)。

func (*DeleteManagersChatManagersReqBuilder) Build

func (*DeleteManagersChatManagersReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`、`topic`的群组ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*DeleteManagersChatManagersReqBuilder) MemberIdType

群成员 id 类型 open_id/user_id/union_id/app_id;;**注意**:删除机器人类型的管理员请使用 ==app_id==

示例值:open_id

type DeleteManagersChatManagersResp

type DeleteManagersChatManagersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *DeleteManagersChatManagersRespData `json:"data"` // 业务数据
}

func (*DeleteManagersChatManagersResp) Success

func (resp *DeleteManagersChatManagersResp) Success() bool

type DeleteManagersChatManagersRespData

type DeleteManagersChatManagersRespData struct {
	ChatManagers    []string `json:"chat_managers,omitempty"`     // 群目前用户类型的管理员 id
	ChatBotManagers []string `json:"chat_bot_managers,omitempty"` // 群目前机器人类型的管理员 id
}

type DeleteMessageReactionReq

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

type DeleteMessageReactionReqBuilder

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

func NewDeleteMessageReactionReqBuilder

func NewDeleteMessageReactionReqBuilder() *DeleteMessageReactionReqBuilder

func (*DeleteMessageReactionReqBuilder) Build

func (*DeleteMessageReactionReqBuilder) MessageId

待删除reaction的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_8964d1b4*********2b31383276113

func (*DeleteMessageReactionReqBuilder) ReactionId

待删除reaction的资源id,可通过调用[添加消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create)接口或[获取消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list)获得

示例值:ZCaCIjUBVVWSrm5L-3ZTw*************sNa8dHVplEzzSfJVUVLMLcS_

type DeleteMessageReactionResp

type DeleteMessageReactionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *DeleteMessageReactionRespData `json:"data"` // 业务数据
}

func (*DeleteMessageReactionResp) Success

func (resp *DeleteMessageReactionResp) Success() bool

type DeleteMessageReactionRespData

type DeleteMessageReactionRespData struct {
	ReactionId   *string   `json:"reaction_id,omitempty"`   // reaction资源ID
	Operator     *Operator `json:"operator,omitempty"`      // 添加reaction的操作人
	ActionTime   *string   `json:"action_time,omitempty"`   // reaction动作的的unix timestamp(单位:ms)
	ReactionType *Emoji    `json:"reaction_type,omitempty"` // reaction资源类型
}

type DeleteMessageReq

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

type DeleteMessageReqBuilder

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

func NewDeleteMessageReqBuilder

func NewDeleteMessageReqBuilder() *DeleteMessageReqBuilder

func (*DeleteMessageReqBuilder) Build

func (builder *DeleteMessageReqBuilder) Build() *DeleteMessageReq

func (*DeleteMessageReqBuilder) MessageId

func (builder *DeleteMessageReqBuilder) MessageId(messageId string) *DeleteMessageReqBuilder

待撤回的消息的ID

示例值:om_dc13264520392913993dd051dba21dcf

type DeleteMessageResp

type DeleteMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*DeleteMessageResp) Success

func (resp *DeleteMessageResp) Success() bool

type DeletePinReq added in v3.0.3

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

type DeletePinReqBuilder added in v3.0.3

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

func NewDeletePinReqBuilder added in v3.0.3

func NewDeletePinReqBuilder() *DeletePinReqBuilder

func (*DeletePinReqBuilder) Build added in v3.0.3

func (builder *DeletePinReqBuilder) Build() *DeletePinReq

func (*DeletePinReqBuilder) MessageId added in v3.0.3

func (builder *DeletePinReqBuilder) MessageId(messageId string) *DeletePinReqBuilder

待移除Pin的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

type DeletePinResp added in v3.0.3

type DeletePinResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*DeletePinResp) Success added in v3.0.3

func (resp *DeletePinResp) Success() bool

type DeleteTabsChatTabPathReqBodyBuilder

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

func NewDeleteTabsChatTabPathReqBodyBuilder

func NewDeleteTabsChatTabPathReqBodyBuilder() *DeleteTabsChatTabPathReqBodyBuilder

func (*DeleteTabsChatTabPathReqBodyBuilder) Build

func (*DeleteTabsChatTabPathReqBodyBuilder) TabIds

会话标签页ID列表,Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取

示例值:["7101214603622940671", "7101214603622940672"]

type DeleteTabsChatTabReq

type DeleteTabsChatTabReq struct {
	Body *DeleteTabsChatTabReqBody `body:""`
	// contains filtered or unexported fields
}

type DeleteTabsChatTabReqBody

type DeleteTabsChatTabReqBody struct {
	TabIds []string `json:"tab_ids,omitempty"` // 会话标签页ID列表,Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取
}

type DeleteTabsChatTabReqBodyBuilder

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

func NewDeleteTabsChatTabReqBodyBuilder

func NewDeleteTabsChatTabReqBodyBuilder() *DeleteTabsChatTabReqBodyBuilder

func (*DeleteTabsChatTabReqBodyBuilder) Build

func (*DeleteTabsChatTabReqBodyBuilder) TabIds

会话标签页ID列表,Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取

示例值:["7101214603622940671", "7101214603622940672"]

type DeleteTabsChatTabReqBuilder

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

func NewDeleteTabsChatTabReqBuilder

func NewDeleteTabsChatTabReqBuilder() *DeleteTabsChatTabReqBuilder

func (*DeleteTabsChatTabReqBuilder) Body

删除会话标签页。

func (*DeleteTabsChatTabReqBuilder) Build

func (*DeleteTabsChatTabReqBuilder) ChatId

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:支持群模式为`p2p`与`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type DeleteTabsChatTabResp

type DeleteTabsChatTabResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *DeleteTabsChatTabRespData `json:"data"` // 业务数据
}

func (*DeleteTabsChatTabResp) Success

func (resp *DeleteTabsChatTabResp) Success() bool

type DeleteTabsChatTabRespData

type DeleteTabsChatTabRespData struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 会话标签页
}

type DeleteTopNoticeChatTopNoticeReq

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

type DeleteTopNoticeChatTopNoticeReqBuilder

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

func NewDeleteTopNoticeChatTopNoticeReqBuilder

func NewDeleteTopNoticeChatTopNoticeReqBuilder() *DeleteTopNoticeChatTopNoticeReqBuilder

func (*DeleteTopNoticeChatTopNoticeReqBuilder) Build

func (*DeleteTopNoticeChatTopNoticeReqBuilder) ChatId

待撤销置顶的群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_5ad11d72b830411d72b836c20

type DeleteTopNoticeChatTopNoticeResp

type DeleteTopNoticeChatTopNoticeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*DeleteTopNoticeChatTopNoticeResp) Success

func (resp *DeleteTopNoticeChatTopNoticeResp) Success() bool

type DepartmentId added in v3.0.29

type DepartmentId struct {
	DepartmentId     *string `json:"department_id,omitempty"`      //
	OpenDepartmentId *string `json:"open_department_id,omitempty"` //
}

type DepartmentIdBuilder added in v3.0.29

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

func NewDepartmentIdBuilder added in v3.0.29

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build added in v3.0.29

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId added in v3.0.29

func (builder *DepartmentIdBuilder) DepartmentId(departmentId string) *DepartmentIdBuilder

示例值:

func (*DepartmentIdBuilder) OpenDepartmentId added in v3.0.29

func (builder *DepartmentIdBuilder) OpenDepartmentId(openDepartmentId string) *DepartmentIdBuilder

示例值:

type Emoji

type Emoji struct {
	EmojiType *string `json:"emoji_type,omitempty"` // emoji类型 [emoji类型列举](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)
}

type EmojiBuilder

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

func NewEmojiBuilder

func NewEmojiBuilder() *EmojiBuilder

func (*EmojiBuilder) Build

func (builder *EmojiBuilder) Build() *Emoji

func (*EmojiBuilder) EmojiType

func (builder *EmojiBuilder) EmojiType(emojiType string) *EmojiBuilder

emoji类型 [emoji类型列举](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)

示例值:SMILE

type EventMessage

type EventMessage struct {
	MessageId   *string         `json:"message_id,omitempty"`   // 消息的open_message_id,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
	RootId      *string         `json:"root_id,omitempty"`      // 根消息id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
	ParentId    *string         `json:"parent_id,omitempty"`    // 父消息的id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
	CreateTime  *string         `json:"create_time,omitempty"`  // 消息发送时间(毫秒)
	UpdateTime  *string         `json:"update_time,omitempty"`  // 消息更新时间(毫秒)
	ChatId      *string         `json:"chat_id,omitempty"`      // 消息所在的群组 ID
	ChatType    *string         `json:"chat_type,omitempty"`    // 消息所在的群组类型;;**可选值有**:;- `p2p`:单聊;- `group`: 群组;- `topic_group`:话题群
	MessageType *string         `json:"message_type,omitempty"` // 消息类型
	Content     *string         `json:"content,omitempty"`      // 消息内容, json 格式 ;[各类型消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/events/message_content)
	Mentions    []*MentionEvent `json:"mentions,omitempty"`     // 被提及用户的信息
	UserAgent   *string         `json:"user_agent,omitempty"`   // 用户代理
}

type EventMessageBuilder

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

func NewEventMessageBuilder

func NewEventMessageBuilder() *EventMessageBuilder

func (*EventMessageBuilder) Build

func (builder *EventMessageBuilder) Build() *EventMessage

func (*EventMessageBuilder) ChatId

func (builder *EventMessageBuilder) ChatId(chatId string) *EventMessageBuilder

消息所在的群组 ID

示例值:oc_5ce6d572455d361153b7xx51da133945

func (*EventMessageBuilder) ChatType

func (builder *EventMessageBuilder) ChatType(chatType string) *EventMessageBuilder

消息所在的群组类型;;**可选值有**:;- `p2p`:单聊;- `group`: 群组;- `topic_group`:话题群

示例值:group

func (*EventMessageBuilder) Content

func (builder *EventMessageBuilder) Content(content string) *EventMessageBuilder

消息内容, json 格式 ;[各类型消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/events/message_content)

示例值:{\"text\":\"@_user_1 hello\"}

func (*EventMessageBuilder) CreateTime

func (builder *EventMessageBuilder) CreateTime(createTime string) *EventMessageBuilder

消息发送时间(毫秒)

示例值:1609073151345

func (*EventMessageBuilder) Mentions

func (builder *EventMessageBuilder) Mentions(mentions []*MentionEvent) *EventMessageBuilder

被提及用户的信息

示例值:

func (*EventMessageBuilder) MessageId

func (builder *EventMessageBuilder) MessageId(messageId string) *EventMessageBuilder

消息的open_message_id,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_5ce6d572455d361153b7cb51da133945

func (*EventMessageBuilder) MessageType

func (builder *EventMessageBuilder) MessageType(messageType string) *EventMessageBuilder

消息类型

示例值:text

func (*EventMessageBuilder) ParentId

func (builder *EventMessageBuilder) ParentId(parentId string) *EventMessageBuilder

父消息的id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_5ce6d572455d361153b7cb5xxfsdfsdfdsf

func (*EventMessageBuilder) RootId

func (builder *EventMessageBuilder) RootId(rootId string) *EventMessageBuilder

根消息id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_5ce6d572455d361153b7cb5xxfsdfsdfdsf

func (*EventMessageBuilder) UpdateTime added in v3.0.29

func (builder *EventMessageBuilder) UpdateTime(updateTime string) *EventMessageBuilder

消息更新时间(毫秒)

示例值:1687343654666

func (*EventMessageBuilder) UserAgent added in v3.0.29

func (builder *EventMessageBuilder) UserAgent(userAgent string) *EventMessageBuilder

用户代理

示例值:Mozilla/5.0 (Macintosh; Intel Mac OS X 13_2_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.53 Safari/537.36 Lark/6.7.5 LarkLocale/en_US ttnet SDK-Version/6.7.8

type EventMessageReader

type EventMessageReader struct {
	ReaderId  *UserId `json:"reader_id,omitempty"`  // 用户 ID
	ReadTime  *string `json:"read_time,omitempty"`  // 阅读时间
	TenantKey *string `json:"tenant_key,omitempty"` // 租户key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
}

type EventMessageReaderBuilder

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

func NewEventMessageReaderBuilder

func NewEventMessageReaderBuilder() *EventMessageReaderBuilder

func (*EventMessageReaderBuilder) Build

func (*EventMessageReaderBuilder) ReadTime

func (builder *EventMessageReaderBuilder) ReadTime(readTime string) *EventMessageReaderBuilder

阅读时间

示例值:1609484183000

func (*EventMessageReaderBuilder) ReaderId

func (builder *EventMessageReaderBuilder) ReaderId(readerId *UserId) *EventMessageReaderBuilder

用户 ID

示例值:ou_5ad573a6411d72b8305fda3a9c15c70e

func (*EventMessageReaderBuilder) TenantKey

func (builder *EventMessageReaderBuilder) TenantKey(tenantKey string) *EventMessageReaderBuilder

租户key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识

示例值:736588c9260f175e

type EventSender

type EventSender struct {
	SenderId   *UserId `json:"sender_id,omitempty"`   // 用户 ID
	SenderType *string `json:"sender_type,omitempty"` // 消息发送者类型。目前只支持用户(user)发送的消息。
	TenantKey  *string `json:"tenant_key,omitempty"`  // tenant key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
}

type EventSenderBuilder

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

func NewEventSenderBuilder

func NewEventSenderBuilder() *EventSenderBuilder

func (*EventSenderBuilder) Build

func (builder *EventSenderBuilder) Build() *EventSender

func (*EventSenderBuilder) SenderId

func (builder *EventSenderBuilder) SenderId(senderId *UserId) *EventSenderBuilder

用户 ID

示例值:ou_5ad573a6411d72b8305fda3a9c15c70e

func (*EventSenderBuilder) SenderType

func (builder *EventSenderBuilder) SenderType(senderType string) *EventSenderBuilder

消息发送者类型。目前只支持用户(user)发送的消息。

示例值:user

func (*EventSenderBuilder) TenantKey

func (builder *EventSenderBuilder) TenantKey(tenantKey string) *EventSenderBuilder

tenant key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识

示例值:736588c9260f175e

type File

type File struct {
}

type ForwardMessagePathReqBodyBuilder added in v3.0.21

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

func NewForwardMessagePathReqBodyBuilder added in v3.0.21

func NewForwardMessagePathReqBodyBuilder() *ForwardMessagePathReqBodyBuilder

func (*ForwardMessagePathReqBodyBuilder) Build added in v3.0.21

func (*ForwardMessagePathReqBodyBuilder) ReceiveId added in v3.0.21

依据receive_id_type的值,填写对应的转发目标的ID

示例值:oc_a0553eda9014c201e6969b478895c230

type ForwardMessageReq added in v3.0.21

type ForwardMessageReq struct {
	Body *ForwardMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type ForwardMessageReqBody added in v3.0.21

type ForwardMessageReqBody struct {
	ReceiveId *string `json:"receive_id,omitempty"` // 依据receive_id_type的值,填写对应的转发目标的ID
}

type ForwardMessageReqBodyBuilder added in v3.0.21

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

func NewForwardMessageReqBodyBuilder added in v3.0.21

func NewForwardMessageReqBodyBuilder() *ForwardMessageReqBodyBuilder

func (*ForwardMessageReqBodyBuilder) Build added in v3.0.21

func (*ForwardMessageReqBodyBuilder) ReceiveId added in v3.0.21

func (builder *ForwardMessageReqBodyBuilder) ReceiveId(receiveId string) *ForwardMessageReqBodyBuilder

依据receive_id_type的值,填写对应的转发目标的ID

示例值:oc_a0553eda9014c201e6969b478895c230

type ForwardMessageReqBuilder added in v3.0.21

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

func NewForwardMessageReqBuilder added in v3.0.21

func NewForwardMessageReqBuilder() *ForwardMessageReqBuilder

func (*ForwardMessageReqBuilder) Body added in v3.0.21

转发一条消息

func (*ForwardMessageReqBuilder) Build added in v3.0.21

func (builder *ForwardMessageReqBuilder) Build() *ForwardMessageReq

func (*ForwardMessageReqBuilder) MessageId added in v3.0.21

func (builder *ForwardMessageReqBuilder) MessageId(messageId string) *ForwardMessageReqBuilder

要转发的消息ID

示例值:om_dc13264520392913993dd051dba21dcf

func (*ForwardMessageReqBuilder) ReceiveIdType added in v3.0.21

func (builder *ForwardMessageReqBuilder) ReceiveIdType(receiveIdType string) *ForwardMessageReqBuilder

消息接收者id类型 open_id/user_id/union_id/email/chat_id

示例值:

func (*ForwardMessageReqBuilder) Uuid added in v3.0.21

由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。

示例值:b13g2t38-1jd2-458b-8djf-dtbca5104204

type ForwardMessageResp added in v3.0.21

type ForwardMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ForwardMessageRespData `json:"data"` // 业务数据
}

func (*ForwardMessageResp) Success added in v3.0.21

func (resp *ForwardMessageResp) Success() bool

type ForwardMessageRespData added in v3.0.21

type ForwardMessageRespData struct {
	MessageId      *string      `json:"message_id,omitempty"`       // 消息id open_message_id
	RootId         *string      `json:"root_id,omitempty"`          // 根消息id open_message_id
	ParentId       *string      `json:"parent_id,omitempty"`        // 父消息的id open_message_id
	MsgType        *string      `json:"msg_type,omitempty"`         // 消息类型 text post card image等等
	CreateTime     *string      `json:"create_time,omitempty"`      // 消息生成的时间戳(毫秒)
	UpdateTime     *string      `json:"update_time,omitempty"`      // 消息更新的时间戳
	Deleted        *bool        `json:"deleted,omitempty"`          // 消息是否被撤回
	Updated        *bool        `json:"updated,omitempty"`          // 消息是否被更新
	ChatId         *string      `json:"chat_id,omitempty"`          // 所属的群
	Sender         *Sender      `json:"sender,omitempty"`           // 发送者,可以是用户或应用
	Body           *MessageBody `json:"body,omitempty"`             // 消息内容,json结构
	Mentions       []*Mention   `json:"mentions,omitempty"`         // 被艾特的人或应用的id
	UpperMessageId *string      `json:"upper_message_id,omitempty"` // 合并消息的上一层级消息id open_message_id
}

type GetChatAnnouncementReq

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

type GetChatAnnouncementReqBuilder

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

func NewGetChatAnnouncementReqBuilder

func NewGetChatAnnouncementReqBuilder() *GetChatAnnouncementReqBuilder

func (*GetChatAnnouncementReqBuilder) Build

func (*GetChatAnnouncementReqBuilder) ChatId

待获取公告的群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:不支持P2P单聊

示例值:oc_5ad11d72b830411d72b836c20

func (*GetChatAnnouncementReqBuilder) UserIdType

func (builder *GetChatAnnouncementReqBuilder) UserIdType(userIdType string) *GetChatAnnouncementReqBuilder

此次调用中使用的用户ID的类型

示例值:open_id

type GetChatAnnouncementResp

type GetChatAnnouncementResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetChatAnnouncementRespData `json:"data"` // 业务数据
}

func (*GetChatAnnouncementResp) Success

func (resp *GetChatAnnouncementResp) Success() bool

type GetChatAnnouncementRespData

type GetChatAnnouncementRespData struct {
	Content        *string `json:"content,omitempty"`          // 云文档序列化信息
	Revision       *string `json:"revision,omitempty"`         // 文档当前版本号 纯数字
	CreateTime     *string `json:"create_time,omitempty"`      // 文档生成的时间戳(秒)
	UpdateTime     *string `json:"update_time,omitempty"`      // 文档更新的时间戳(秒)
	OwnerIdType    *string `json:"owner_id_type,omitempty"`    // 文档所有者的 ID 类型;;- 如果所有者是用户,则与查询参数中的user_id_type 相同;取值为`open_id` `user_id` `union_id` 其中之一,不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction);- 如果所有者是机器人,为机器人应用的 `app_id`,详情参见  [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g)
	OwnerId        *string `json:"owner_id,omitempty"`         // 文档所有者 ID,ID 值与owner_id_type 中的ID类型对应
	ModifierIdType *string `json:"modifier_id_type,omitempty"` // 文档最新修改者 id 类型;; - 如果修改者是用户,则与查询参数中的user_id_type 相同;取值为`open_id` `user_id` `union_id` 其中之一,不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction);- 如果修改者是机器人,为机器人应用的 `app_id`,详情参见  [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g)
	ModifierId     *string `json:"modifier_id,omitempty"`      // 文档最新修改者 ID,ID 值与modifier_id_type 中的ID类型对应
}

type GetChatMembersIterator

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

func (*GetChatMembersIterator) Next

func (iterator *GetChatMembersIterator) Next() (bool, *ListMember, error)

func (*GetChatMembersIterator) NextPageToken

func (iterator *GetChatMembersIterator) NextPageToken() *string

type GetChatMembersReq

type GetChatMembersReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type GetChatMembersReqBuilder

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

func NewGetChatMembersReqBuilder

func NewGetChatMembersReqBuilder() *GetChatMembersReqBuilder

func (*GetChatMembersReqBuilder) Build

func (builder *GetChatMembersReqBuilder) Build() *GetChatMembersReq

func (*GetChatMembersReqBuilder) ChatId

func (builder *GetChatMembersReqBuilder) ChatId(chatId string) *GetChatMembersReqBuilder

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_a0553eda9014c201e6969b478895c230

func (*GetChatMembersReqBuilder) Limit

func (builder *GetChatMembersReqBuilder) Limit(limit int) *GetChatMembersReqBuilder

最大返回多少记录,当使用迭代器访问时才有效

func (*GetChatMembersReqBuilder) MemberIdType

func (builder *GetChatMembersReqBuilder) MemberIdType(memberIdType string) *GetChatMembersReqBuilder

群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)

示例值:open_id

func (*GetChatMembersReqBuilder) PageSize

func (builder *GetChatMembersReqBuilder) PageSize(pageSize int) *GetChatMembersReqBuilder

分页大小

示例值:10

func (*GetChatMembersReqBuilder) PageToken

func (builder *GetChatMembersReqBuilder) PageToken(pageToken string) *GetChatMembersReqBuilder

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果

示例值:dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==

type GetChatMembersResp

type GetChatMembersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetChatMembersRespData `json:"data"` // 业务数据
}

func (*GetChatMembersResp) Success

func (resp *GetChatMembersResp) Success() bool

type GetChatMembersRespData

type GetChatMembersRespData struct {
	Items       []*ListMember `json:"items,omitempty"`        // 成员列表
	PageToken   *string       `json:"page_token,omitempty"`   // 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
	HasMore     *bool         `json:"has_more,omitempty"`     // 是否还有更多项
	MemberTotal *int          `json:"member_total,omitempty"` // 成员总数
}

type GetChatMenuTreeReq added in v3.0.13

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

type GetChatMenuTreeReqBuilder added in v3.0.13

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

func NewGetChatMenuTreeReqBuilder added in v3.0.13

func NewGetChatMenuTreeReqBuilder() *GetChatMenuTreeReqBuilder

func (*GetChatMenuTreeReqBuilder) Build added in v3.0.13

func (*GetChatMenuTreeReqBuilder) ChatId added in v3.0.13

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type GetChatMenuTreeResp added in v3.0.13

type GetChatMenuTreeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetChatMenuTreeRespData `json:"data"` // 业务数据
}

func (*GetChatMenuTreeResp) Success added in v3.0.13

func (resp *GetChatMenuTreeResp) Success() bool

type GetChatMenuTreeRespData added in v3.0.13

type GetChatMenuTreeRespData struct {
	MenuTree *ChatMenuTree `json:"menu_tree,omitempty"` // 群内所有菜单
}

type GetChatModerationIterator

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

func (*GetChatModerationIterator) Next

func (iterator *GetChatModerationIterator) Next() (bool, *ListModerator, error)

func (*GetChatModerationIterator) NextPageToken

func (iterator *GetChatModerationIterator) NextPageToken() *string

type GetChatModerationReq

type GetChatModerationReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type GetChatModerationReqBuilder

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

func NewGetChatModerationReqBuilder

func NewGetChatModerationReqBuilder() *GetChatModerationReqBuilder

func (*GetChatModerationReqBuilder) Build

func (*GetChatModerationReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_a0553eda9014c201e6969b478895c230

func (*GetChatModerationReqBuilder) Limit

最大返回多少记录,当使用迭代器访问时才有效

func (*GetChatModerationReqBuilder) PageSize

func (builder *GetChatModerationReqBuilder) PageSize(pageSize int) *GetChatModerationReqBuilder

分页大小

示例值:10

func (*GetChatModerationReqBuilder) PageToken

func (builder *GetChatModerationReqBuilder) PageToken(pageToken string) *GetChatModerationReqBuilder

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果

示例值:dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==

func (*GetChatModerationReqBuilder) UserIdType

func (builder *GetChatModerationReqBuilder) UserIdType(userIdType string) *GetChatModerationReqBuilder

此次调用中使用的用户ID的类型

示例值:

type GetChatModerationResp

type GetChatModerationResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetChatModerationRespData `json:"data"` // 业务数据
}

func (*GetChatModerationResp) Success

func (resp *GetChatModerationResp) Success() bool

type GetChatModerationRespData

type GetChatModerationRespData struct {
	ModerationSetting *string          `json:"moderation_setting,omitempty"` // 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式)
	PageToken         *string          `json:"page_token,omitempty"`         // 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
	HasMore           *bool            `json:"has_more,omitempty"`           // 是否还有更多项
	Items             []*ListModerator `json:"items,omitempty"`              // 可发言用户列表
}

type GetChatReq

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

type GetChatReqBuilder

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

func NewGetChatReqBuilder

func NewGetChatReqBuilder() *GetChatReqBuilder

func (*GetChatReqBuilder) Build

func (builder *GetChatReqBuilder) Build() *GetChatReq

func (*GetChatReqBuilder) ChatId

func (builder *GetChatReqBuilder) ChatId(chatId string) *GetChatReqBuilder

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_a0553eda9014c201e6969b478895c230

func (*GetChatReqBuilder) UserIdType

func (builder *GetChatReqBuilder) UserIdType(userIdType string) *GetChatReqBuilder

此次调用中使用的用户ID的类型

示例值:

type GetChatResp

type GetChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetChatRespData `json:"data"` // 业务数据
}

func (*GetChatResp) Success

func (resp *GetChatResp) Success() bool

type GetChatRespData

type GetChatRespData struct {
	Avatar                 *string    `json:"avatar,omitempty"`                   // 群头像 URL
	Name                   *string    `json:"name,omitempty"`                     // 群名称
	Description            *string    `json:"description,omitempty"`              // 群描述
	I18nNames              *I18nNames `json:"i18n_names,omitempty"`               // 群国际化名称
	AddMemberPermission    *string    `json:"add_member_permission,omitempty"`    // 群成员添加权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员;;**注意**:单聊不返回该字段
	ShareCardPermission    *string    `json:"share_card_permission,omitempty"`    // 群分享权限;;**可选值有**:;- `allowed`:允许;- `not_allowed`:不允许;;**注意**:单聊不返回该字段
	AtAllPermission        *string    `json:"at_all_permission,omitempty"`        // at 所有人权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员;;**注意**:单聊不返回该字段
	EditPermission         *string    `json:"edit_permission,omitempty"`          // 群编辑权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	OwnerIdType            *string    `json:"owner_id_type,omitempty"`            // 群主 ID 对应的ID类型,与查询参数中的 ==user_id_type== 相同。取值为:`open_id`、`user_id`、`union_id`其中之一;;**注意**:;- 当群主是机器人时不返回该字段;- 单聊不返回该字段
	OwnerId                *string    `json:"owner_id,omitempty"`                 // 群主 ID,ID值与查询参数中的 ==user_id_type== 对应;不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction);;**注意**:;- 当群主是机器人时不返回该字段;- 单聊不返回该字段
	UserManagerIdList      []string   `json:"user_manager_id_list,omitempty"`     // 用户管理员列表
	BotManagerIdList       []string   `json:"bot_manager_id_list,omitempty"`      // 机器人管理员列表
	ChatMode               *string    `json:"chat_mode,omitempty"`                // 群模式;;**可选值有**:;- `group`:群组;- `topic`: 话题;- `p2p`: 单聊
	ChatType               *string    `json:"chat_type,omitempty"`                // 群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群;;**注意**:单聊不返回该字段
	ChatTag                *string    `json:"chat_tag,omitempty"`                 // 群标签,如有多个,则按照下列顺序返回第一个;;**可选值有**:;- `inner`:内部群;- `tenant`:公司群;- `department`:部门群;- `edu`:教育群;- `meeting`:会议群;- `customer_service`:客服群;;**注意**:单聊不返回该字段
	JoinMessageVisibility  *string    `json:"join_message_visibility,omitempty"`  // 入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见;;**注意**:单聊不返回该字段
	LeaveMessageVisibility *string    `json:"leave_message_visibility,omitempty"` // 出群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见;;**注意**:单聊不返回该字段
	MembershipApproval     *string    `json:"membership_approval,omitempty"`      // 加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批;;**注意**:单聊不返回该字段
	ModerationPermission   *string    `json:"moderation_permission,omitempty"`    // 发言权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员;- `moderator_list`:指定群成员
	External               *bool      `json:"external,omitempty"`                 // 是否是外部群
	TenantKey              *string    `json:"tenant_key,omitempty"`               // 租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
	UserCount              *string    `json:"user_count,omitempty"`               // 群成员人数
	BotCount               *string    `json:"bot_count,omitempty"`                // 群机器人数

	RestrictedModeSetting  *RestrictedModeSetting `json:"restricted_mode_setting,omitempty"`  // 防泄密模式设置
	UrgentSetting          *string                `json:"urgent_setting,omitempty"`           // 谁可以加急
	VideoConferenceSetting *string                `json:"video_conference_setting,omitempty"` // 谁可以发起视频会议
}

type GetFileReq

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

type GetFileReqBuilder

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

func NewGetFileReqBuilder

func NewGetFileReqBuilder() *GetFileReqBuilder

func (*GetFileReqBuilder) Build

func (builder *GetFileReqBuilder) Build() *GetFileReq

func (*GetFileReqBuilder) FileKey

func (builder *GetFileReqBuilder) FileKey(fileKey string) *GetFileReqBuilder

文件的key,通过[上传文件]( https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create)接口上传图片后获得

示例值:file_456a92d6-c6ea-4de4-ac3f-7afcf44ac78g

type GetFileResp

type GetFileResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	File     io.Reader `json:"-"`
	FileName string    `json:"-"`
}

func (*GetFileResp) Success

func (resp *GetFileResp) Success() bool

func (*GetFileResp) WriteFile

func (resp *GetFileResp) WriteFile(fileName string) error

type GetImageReq

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

type GetImageReqBuilder

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

func NewGetImageReqBuilder

func NewGetImageReqBuilder() *GetImageReqBuilder

func (*GetImageReqBuilder) Build

func (builder *GetImageReqBuilder) Build() *GetImageReq

func (*GetImageReqBuilder) ImageKey

func (builder *GetImageReqBuilder) ImageKey(imageKey string) *GetImageReqBuilder

图片的key,通过[上传图片]( https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)接口上传图片后获得

示例值:img_8d5181ca-0aed-40f0-b0d1-b1452132afbg

type GetImageResp

type GetImageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	File     io.Reader `json:"-"`
	FileName string    `json:"-"`
}

func (*GetImageResp) Success

func (resp *GetImageResp) Success() bool

func (*GetImageResp) WriteFile

func (resp *GetImageResp) WriteFile(fileName string) error

type GetMessageReq

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

type GetMessageReqBuilder

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

func NewGetMessageReqBuilder

func NewGetMessageReqBuilder() *GetMessageReqBuilder

func (*GetMessageReqBuilder) Build

func (builder *GetMessageReqBuilder) Build() *GetMessageReq

func (*GetMessageReqBuilder) MessageId

func (builder *GetMessageReqBuilder) MessageId(messageId string) *GetMessageReqBuilder

待获取消息内容的消息的ID

示例值:om_dc13264520392913993dd051dba21dcf

func (*GetMessageReqBuilder) UserIdType added in v3.0.32

func (builder *GetMessageReqBuilder) UserIdType(userIdType string) *GetMessageReqBuilder

此次调用中使用的用户ID的类型

示例值:open_id

type GetMessageResourceReq

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

type GetMessageResourceReqBuilder

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

func NewGetMessageResourceReqBuilder

func NewGetMessageResourceReqBuilder() *GetMessageResourceReqBuilder

func (*GetMessageResourceReqBuilder) Build

func (*GetMessageResourceReqBuilder) FileKey

待查询资源的key;;**注意**:请求的 file_key 和 message_id 需要匹配

示例值:file_456a92d6-c6ea-4de4-ac3f-7afcf44ac78g

func (*GetMessageResourceReqBuilder) MessageId

func (builder *GetMessageResourceReqBuilder) MessageId(messageId string) *GetMessageResourceReqBuilder

待查询资源对应的消息ID

示例值:om_dc13264520392913993dd051dba21dcf

func (*GetMessageResourceReqBuilder) Type

资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外)

示例值:image

type GetMessageResourceResp

type GetMessageResourceResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	File     io.Reader `json:"-"`
	FileName string    `json:"-"`
}

func (*GetMessageResourceResp) Success

func (resp *GetMessageResourceResp) Success() bool

func (*GetMessageResourceResp) WriteFile

func (resp *GetMessageResourceResp) WriteFile(fileName string) error

type GetMessageResp

type GetMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetMessageRespData `json:"data"` // 业务数据
}

func (*GetMessageResp) Success

func (resp *GetMessageResp) Success() bool

type GetMessageRespData

type GetMessageRespData struct {
	Items []*Message `json:"items,omitempty"` // -
}

type GetProgressBatchMessageReq

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

type GetProgressBatchMessageReqBuilder

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

func NewGetProgressBatchMessageReqBuilder

func NewGetProgressBatchMessageReqBuilder() *GetProgressBatchMessageReqBuilder

func (*GetProgressBatchMessageReqBuilder) BatchMessageId

func (builder *GetProgressBatchMessageReqBuilder) BatchMessageId(batchMessageId string) *GetProgressBatchMessageReqBuilder

待查询的批量消息的ID,通过调用[批量发送消息接口]( https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)的返回值中得到

示例值:bm-0b3d5d1b2df7c6d5dbd1abe2c91e2217

func (*GetProgressBatchMessageReqBuilder) Build

type GetProgressBatchMessageResp

type GetProgressBatchMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetProgressBatchMessageRespData `json:"data"` // 业务数据
}

func (*GetProgressBatchMessageResp) Success

func (resp *GetProgressBatchMessageResp) Success() bool

type GetProgressBatchMessageRespData

type GetProgressBatchMessageRespData struct {
	BatchMessageSendProgress   *BatchMessageSendProgress   `json:"batch_message_send_progress,omitempty"`   // 消息发送进度
	BatchMessageRecallProgress *BatchMessageRecallProgress `json:"batch_message_recall_progress,omitempty"` // 消息撤回进度
}

type I18nNames

type I18nNames struct {
	ZhCn *string `json:"zh_cn,omitempty"` // 中文名
	EnUs *string `json:"en_us,omitempty"` // 英文名
	JaJp *string `json:"ja_jp,omitempty"` // 日文名
}

type I18nNamesBuilder

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

func NewI18nNamesBuilder

func NewI18nNamesBuilder() *I18nNamesBuilder

func (*I18nNamesBuilder) Build

func (builder *I18nNamesBuilder) Build() *I18nNames

func (*I18nNamesBuilder) EnUs

func (builder *I18nNamesBuilder) EnUs(enUs string) *I18nNamesBuilder

英文名

示例值:Sign up

func (*I18nNamesBuilder) JaJp

func (builder *I18nNamesBuilder) JaJp(jaJp string) *I18nNamesBuilder

日文名

示例值:サインアップ

func (*I18nNamesBuilder) ZhCn

func (builder *I18nNamesBuilder) ZhCn(zhCn string) *I18nNamesBuilder

中文名

示例值:评审报名

type ImDepthData

type ImDepthData struct {
	PDate                   *string  `json:"p_date,omitempty"`                      // 分区日期
	DepartmentId            *string  `json:"department_id,omitempty"`               // 部门id
	DepartmentPath          *string  `json:"department_path,omitempty"`             // 部门路径
	SendMsgRate             *float64 `json:"send_msg_rate,omitempty"`               // 发消息用户渗透率
	AvgSendMsgCnt           *float64 `json:"avg_send_msg_cnt,omitempty"`            // 人均发消息数量
	PcSendMsgRate           *float64 `json:"pc_send_msg_rate,omitempty"`            // 仅 PC 端的发消息用户渗透率
	PcAvgSendMsgCnt         *float64 `json:"pc_avg_send_msg_cnt,omitempty"`         // 仅 PC 端的人均发消息数量
	MobileSendMsgRate       *float64 `json:"mobile_send_msg_rate,omitempty"`        // 仅移动端的发消息用户渗透率
	MobileAvgSendMsgCnt     *float64 `json:"mobile_avg_send_msg_cnt,omitempty"`     // 仅移动端的人均发消息数量
	MeetingGroupSendMsgRate *float64 `json:"meeting_group_send_msg_rate,omitempty"` // 会议群发消息用户渗透率
	TenantGroupSendMsgRate  *float64 `json:"tenant_group_send_msg_rate,omitempty"`  // 全员群发消息用户渗透率
	DeptGroupSendMsgRate    *float64 `json:"dept_group_send_msg_rate,omitempty"`    // 部门群发消息用户渗透率
	TopicGroupSendMsgRate   *float64 `json:"topic_group_send_msg_rate,omitempty"`   // 话题群发消息用户渗透率
	GroupAtMsgRate          *float64 `json:"group_at_msg_rate,omitempty"`           // 群聊中 @ 消息占比
	GroupReplyMsgRate       *float64 `json:"group_reply_msg_rate,omitempty"`        // 群聊中回复消息占比
	ReactionRate            *float64 `json:"reaction_rate,omitempty"`               // 发送 reaction 用户渗透率
	P2pSendMsgRate          *float64 `json:"p2p_send_msg_rate,omitempty"`           // 发送单聊消息占比
	ImgSendMsgRate          *float64 `json:"img_send_msg_rate,omitempty"`           // 图片消息用户渗透率
	FileSendMsgRate         *float64 `json:"file_send_msg_rate,omitempty"`          // 文件消息用户渗透率
	StickerSendMsgRate      *float64 `json:"sticker_send_msg_rate,omitempty"`       // 表情包消息用户渗透率
	PostSendMsgRate         *float64 `json:"post_send_msg_rate,omitempty"`          // 富文本消息用户渗透率
}

type ImDepthDataBuilder

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

func NewImDepthDataBuilder

func NewImDepthDataBuilder() *ImDepthDataBuilder

func (*ImDepthDataBuilder) AvgSendMsgCnt

func (builder *ImDepthDataBuilder) AvgSendMsgCnt(avgSendMsgCnt float64) *ImDepthDataBuilder

人均发消息数量

示例值:50

func (*ImDepthDataBuilder) Build

func (builder *ImDepthDataBuilder) Build() *ImDepthData

func (*ImDepthDataBuilder) DepartmentId

func (builder *ImDepthDataBuilder) DepartmentId(departmentId string) *ImDepthDataBuilder

部门id

示例值:123456

func (*ImDepthDataBuilder) DepartmentPath

func (builder *ImDepthDataBuilder) DepartmentPath(departmentPath string) *ImDepthDataBuilder

部门路径

示例值:test/subtest

func (*ImDepthDataBuilder) DeptGroupSendMsgRate

func (builder *ImDepthDataBuilder) DeptGroupSendMsgRate(deptGroupSendMsgRate float64) *ImDepthDataBuilder

部门群发消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) FileSendMsgRate

func (builder *ImDepthDataBuilder) FileSendMsgRate(fileSendMsgRate float64) *ImDepthDataBuilder

文件消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) GroupAtMsgRate

func (builder *ImDepthDataBuilder) GroupAtMsgRate(groupAtMsgRate float64) *ImDepthDataBuilder

群聊中 @ 消息占比

示例值:0.50

func (*ImDepthDataBuilder) GroupReplyMsgRate

func (builder *ImDepthDataBuilder) GroupReplyMsgRate(groupReplyMsgRate float64) *ImDepthDataBuilder

群聊中回复消息占比

示例值:0.50

func (*ImDepthDataBuilder) ImgSendMsgRate

func (builder *ImDepthDataBuilder) ImgSendMsgRate(imgSendMsgRate float64) *ImDepthDataBuilder

图片消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) MeetingGroupSendMsgRate

func (builder *ImDepthDataBuilder) MeetingGroupSendMsgRate(meetingGroupSendMsgRate float64) *ImDepthDataBuilder

会议群发消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) MobileAvgSendMsgCnt

func (builder *ImDepthDataBuilder) MobileAvgSendMsgCnt(mobileAvgSendMsgCnt float64) *ImDepthDataBuilder

仅移动端的人均发消息数量

示例值:50

func (*ImDepthDataBuilder) MobileSendMsgRate

func (builder *ImDepthDataBuilder) MobileSendMsgRate(mobileSendMsgRate float64) *ImDepthDataBuilder

仅移动端的发消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) P2pSendMsgRate

func (builder *ImDepthDataBuilder) P2pSendMsgRate(p2pSendMsgRate float64) *ImDepthDataBuilder

发送单聊消息占比

示例值:0.50

func (*ImDepthDataBuilder) PDate

func (builder *ImDepthDataBuilder) PDate(pDate string) *ImDepthDataBuilder

分区日期

示例值:2022-02-02

func (*ImDepthDataBuilder) PcAvgSendMsgCnt

func (builder *ImDepthDataBuilder) PcAvgSendMsgCnt(pcAvgSendMsgCnt float64) *ImDepthDataBuilder

仅 PC 端的人均发消息数量

示例值:50

func (*ImDepthDataBuilder) PcSendMsgRate

func (builder *ImDepthDataBuilder) PcSendMsgRate(pcSendMsgRate float64) *ImDepthDataBuilder

仅 PC 端的发消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) PostSendMsgRate

func (builder *ImDepthDataBuilder) PostSendMsgRate(postSendMsgRate float64) *ImDepthDataBuilder

富文本消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) ReactionRate

func (builder *ImDepthDataBuilder) ReactionRate(reactionRate float64) *ImDepthDataBuilder

发送 reaction 用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) SendMsgRate

func (builder *ImDepthDataBuilder) SendMsgRate(sendMsgRate float64) *ImDepthDataBuilder

发消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) StickerSendMsgRate

func (builder *ImDepthDataBuilder) StickerSendMsgRate(stickerSendMsgRate float64) *ImDepthDataBuilder

表情包消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) TenantGroupSendMsgRate

func (builder *ImDepthDataBuilder) TenantGroupSendMsgRate(tenantGroupSendMsgRate float64) *ImDepthDataBuilder

全员群发消息用户渗透率

示例值:0.50

func (*ImDepthDataBuilder) TopicGroupSendMsgRate

func (builder *ImDepthDataBuilder) TopicGroupSendMsgRate(topicGroupSendMsgRate float64) *ImDepthDataBuilder

话题群发消息用户渗透率

示例值:0.50

type Image

type Image struct {
}

type IsInChatChatMembersReq

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

type IsInChatChatMembersReqBuilder

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

func NewIsInChatChatMembersReqBuilder

func NewIsInChatChatMembersReqBuilder() *IsInChatChatMembersReqBuilder

func (*IsInChatChatMembersReqBuilder) Build

func (*IsInChatChatMembersReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_a0553eda9014c201e6969b478895c230

type IsInChatChatMembersResp

type IsInChatChatMembersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *IsInChatChatMembersRespData `json:"data"` // 业务数据
}

func (*IsInChatChatMembersResp) Success

func (resp *IsInChatChatMembersResp) Success() bool

type IsInChatChatMembersRespData

type IsInChatChatMembersRespData struct {
	IsInChat *bool `json:"is_in_chat,omitempty"` // 用户或者机器人是否在群中
}

type LinkChatPathReqBodyBuilder added in v3.0.3

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

func NewLinkChatPathReqBodyBuilder added in v3.0.3

func NewLinkChatPathReqBodyBuilder() *LinkChatPathReqBodyBuilder

func (*LinkChatPathReqBodyBuilder) Build added in v3.0.3

func (builder *LinkChatPathReqBodyBuilder) Build() (*LinkChatReqBody, error)

func (*LinkChatPathReqBodyBuilder) ValidityPeriod added in v3.0.3

func (builder *LinkChatPathReqBodyBuilder) ValidityPeriod(validityPeriod string) *LinkChatPathReqBodyBuilder

群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效

示例值:week

type LinkChatReq added in v3.0.3

type LinkChatReq struct {
	Body *LinkChatReqBody `body:""`
	// contains filtered or unexported fields
}

type LinkChatReqBody added in v3.0.3

type LinkChatReqBody struct {
	ValidityPeriod *string `json:"validity_period,omitempty"` // 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效
}

type LinkChatReqBodyBuilder added in v3.0.3

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

func NewLinkChatReqBodyBuilder added in v3.0.3

func NewLinkChatReqBodyBuilder() *LinkChatReqBodyBuilder

func (*LinkChatReqBodyBuilder) Build added in v3.0.3

func (builder *LinkChatReqBodyBuilder) Build() *LinkChatReqBody

func (*LinkChatReqBodyBuilder) ValidityPeriod added in v3.0.3

func (builder *LinkChatReqBodyBuilder) ValidityPeriod(validityPeriod string) *LinkChatReqBodyBuilder

群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效

示例值:week

type LinkChatReqBuilder added in v3.0.3

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

func NewLinkChatReqBuilder added in v3.0.3

func NewLinkChatReqBuilder() *LinkChatReqBuilder

func (*LinkChatReqBuilder) Body added in v3.0.3

获取指定群的分享链接。

func (*LinkChatReqBuilder) Build added in v3.0.3

func (builder *LinkChatReqBuilder) Build() *LinkChatReq

func (*LinkChatReqBuilder) ChatId added in v3.0.3

func (builder *LinkChatReqBuilder) ChatId(chatId string) *LinkChatReqBuilder

待获取分享链接的群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:单聊、密聊、团队群不支持分享群链接

示例值:oc_a0553eda9014c201e6969b478895c230

type LinkChatResp added in v3.0.3

type LinkChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *LinkChatRespData `json:"data"` // 业务数据
}

func (*LinkChatResp) Success added in v3.0.3

func (resp *LinkChatResp) Success() bool

type LinkChatRespData added in v3.0.3

type LinkChatRespData struct {
	ShareLink   *string `json:"share_link,omitempty"`   // 群分享链接
	ExpireTime  *string `json:"expire_time,omitempty"`  // 分享链接过期时间戳(秒级)
	IsPermanent *bool   `json:"is_permanent,omitempty"` // 分享链接是否永久有效
}

type ListChat

type ListChat struct {
	ChatId      *string `json:"chat_id,omitempty"`       // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	Avatar      *string `json:"avatar,omitempty"`        // 群头像 URL
	Name        *string `json:"name,omitempty"`          // 群名称
	Description *string `json:"description,omitempty"`   // 群描述
	OwnerId     *string `json:"owner_id,omitempty"`      // 群主 ID
	OwnerIdType *string `json:"owner_id_type,omitempty"` // 群主 ID 类型
	External    *bool   `json:"external,omitempty"`      // 是否是外部群
	TenantKey   *string `json:"tenant_key,omitempty"`    // 租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识

}

type ListChatBuilder

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

func NewListChatBuilder

func NewListChatBuilder() *ListChatBuilder

func (*ListChatBuilder) Build

func (builder *ListChatBuilder) Build() *ListChat

func (*ListChatBuilder) ChatId

func (builder *ListChatBuilder) ChatId(chatId string) *ListChatBuilder

群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_a0553eda9014c201e6969b478895c230

func (*ListChatBuilder) Description

func (builder *ListChatBuilder) Description(description string) *ListChatBuilder

群描述

示例值:测试群描述

func (*ListChatBuilder) External

func (builder *ListChatBuilder) External(external bool) *ListChatBuilder

是否是外部群

示例值:false

func (*ListChatBuilder) Name

func (builder *ListChatBuilder) Name(name string) *ListChatBuilder

群名称

示例值:测试群名称

func (*ListChatBuilder) OwnerId

func (builder *ListChatBuilder) OwnerId(ownerId string) *ListChatBuilder

群主 ID

示例值:4d7a3c6g

func (*ListChatBuilder) OwnerIdType

func (builder *ListChatBuilder) OwnerIdType(ownerIdType string) *ListChatBuilder

群主 ID 类型

示例值:user_id

func (*ListChatBuilder) TenantKey

func (builder *ListChatBuilder) TenantKey(tenantKey string) *ListChatBuilder

租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识

示例值:736588c9260f175e

type ListChatIterator

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

func (*ListChatIterator) Next

func (iterator *ListChatIterator) Next() (bool, *ListChat, error)

func (*ListChatIterator) NextPageToken

func (iterator *ListChatIterator) NextPageToken() *string

type ListChatReq

type ListChatReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListChatReqBuilder

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

func NewListChatReqBuilder

func NewListChatReqBuilder() *ListChatReqBuilder

func (*ListChatReqBuilder) Build

func (builder *ListChatReqBuilder) Build() *ListChatReq

func (*ListChatReqBuilder) Limit

func (builder *ListChatReqBuilder) Limit(limit int) *ListChatReqBuilder

最大返回多少记录,当使用迭代器访问时才有效

func (*ListChatReqBuilder) PageSize

func (builder *ListChatReqBuilder) PageSize(pageSize int) *ListChatReqBuilder

分页大小

示例值:10

func (*ListChatReqBuilder) PageToken

func (builder *ListChatReqBuilder) PageToken(pageToken string) *ListChatReqBuilder

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该page_token 获取查询结果

示例值:dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==

func (*ListChatReqBuilder) SortType added in v3.0.22

func (builder *ListChatReqBuilder) SortType(sortType string) *ListChatReqBuilder

群组排序方式

示例值:ByCreateTimeAsc

func (*ListChatReqBuilder) UserIdType

func (builder *ListChatReqBuilder) UserIdType(userIdType string) *ListChatReqBuilder

此次调用中使用的用户ID的类型

示例值:

type ListChatResp

type ListChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListChatRespData `json:"data"` // 业务数据
}

func (*ListChatResp) Success

func (resp *ListChatResp) Success() bool

type ListChatRespData

type ListChatRespData struct {
	Items     []*ListChat `json:"items,omitempty"`      // chat 列表
	PageToken *string     `json:"page_token,omitempty"` // 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
	HasMore   *bool       `json:"has_more,omitempty"`   // 是否还有更多项
}

type ListEventModerator

type ListEventModerator struct {
	TenantKey *string `json:"tenant_key,omitempty"` // 租户 Key
	UserId    *UserId `json:"user_id,omitempty"`    // 用户 ID
}

type ListEventModeratorBuilder

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

func NewListEventModeratorBuilder

func NewListEventModeratorBuilder() *ListEventModeratorBuilder

func (*ListEventModeratorBuilder) Build

func (*ListEventModeratorBuilder) TenantKey

func (builder *ListEventModeratorBuilder) TenantKey(tenantKey string) *ListEventModeratorBuilder

租户 Key

示例值:86gwe65

func (*ListEventModeratorBuilder) UserId

用户 ID

示例值:

type ListMember

type ListMember struct {
	MemberIdType *string `json:"member_id_type,omitempty"` // 成员的用户 ID 类型,与查询参数中的 member_id_type 相同。取值为:`open_id`、`user_id`、`union_id`其中之一。
	MemberId     *string `json:"member_id,omitempty"`      // 成员的用户ID,ID值与查询参数中的 member_id_type 对应。;;不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)
	Name         *string `json:"name,omitempty"`           // 名字
	TenantKey    *string `json:"tenant_key,omitempty"`     // 租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
}

type ListMemberBuilder

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

func NewListMemberBuilder

func NewListMemberBuilder() *ListMemberBuilder

func (*ListMemberBuilder) Build

func (builder *ListMemberBuilder) Build() *ListMember

func (*ListMemberBuilder) MemberId

func (builder *ListMemberBuilder) MemberId(memberId string) *ListMemberBuilder

成员的用户ID,ID值与查询参数中的 member_id_type 对应。;;不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)

示例值:4d7a3c6g

func (*ListMemberBuilder) MemberIdType

func (builder *ListMemberBuilder) MemberIdType(memberIdType string) *ListMemberBuilder

成员的用户 ID 类型,与查询参数中的 member_id_type 相同。取值为:`open_id`、`user_id`、`union_id`其中之一。

示例值:user_id

func (*ListMemberBuilder) Name

func (builder *ListMemberBuilder) Name(name string) *ListMemberBuilder

名字

示例值:张三

func (*ListMemberBuilder) TenantKey

func (builder *ListMemberBuilder) TenantKey(tenantKey string) *ListMemberBuilder

租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识

示例值:

type ListMessageIterator

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

func (*ListMessageIterator) Next

func (iterator *ListMessageIterator) Next() (bool, *Message, error)

func (*ListMessageIterator) NextPageToken

func (iterator *ListMessageIterator) NextPageToken() *string

type ListMessageReactionIterator

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

func (*ListMessageReactionIterator) Next

func (iterator *ListMessageReactionIterator) Next() (bool, *MessageReaction, error)

func (*ListMessageReactionIterator) NextPageToken

func (iterator *ListMessageReactionIterator) NextPageToken() *string

type ListMessageReactionReq

type ListMessageReactionReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListMessageReactionReqBuilder

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

func NewListMessageReactionReqBuilder

func NewListMessageReactionReqBuilder() *ListMessageReactionReqBuilder

func (*ListMessageReactionReqBuilder) Build

func (*ListMessageReactionReqBuilder) Limit

最大返回多少记录,当使用迭代器访问时才有效

func (*ListMessageReactionReqBuilder) MessageId

待获取reaction的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_8964d1b4*********2b31383276113

func (*ListMessageReactionReqBuilder) PageSize

分页大小

示例值:10

func (*ListMessageReactionReqBuilder) PageToken

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时,会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果

示例值:YhljsPiGfUgnVAg9urvRFd-BvSqRL20wMZNAWfa9xXkud6UKCybPuUgQ1vM26dj6

func (*ListMessageReactionReqBuilder) ReactionType

func (builder *ListMessageReactionReqBuilder) ReactionType(reactionType string) *ListMessageReactionReqBuilder

待查询消息reaction的类型[emoji类型列举](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce);;**注意**:不传入该参数,表示拉取所有类型reaction

示例值:LAUGH

func (*ListMessageReactionReqBuilder) UserIdType

func (builder *ListMessageReactionReqBuilder) UserIdType(userIdType string) *ListMessageReactionReqBuilder

当操作人为用户时返回用户ID的类型

示例值:

type ListMessageReactionResp

type ListMessageReactionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListMessageReactionRespData `json:"data"` // 业务数据
}

func (*ListMessageReactionResp) Success

func (resp *ListMessageReactionResp) Success() bool

type ListMessageReactionRespData

type ListMessageReactionRespData struct {
	Items     []*MessageReaction `json:"items,omitempty"`      //  查询指定reaction_type返回的reaction列表
	HasMore   *bool              `json:"has_more,omitempty"`   // 是否还有后续翻页
	PageToken *string            `json:"page_token,omitempty"` //  下一页分页的token
}

type ListMessageReq

type ListMessageReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListMessageReqBuilder

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

func NewListMessageReqBuilder

func NewListMessageReqBuilder() *ListMessageReqBuilder

func (*ListMessageReqBuilder) Build

func (builder *ListMessageReqBuilder) Build() *ListMessageReq

func (*ListMessageReqBuilder) ContainerId

func (builder *ListMessageReqBuilder) ContainerId(containerId string) *ListMessageReqBuilder

容器的id,即chat的id,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_234jsi43d3ssi993d43545f

func (*ListMessageReqBuilder) ContainerIdType

func (builder *ListMessageReqBuilder) ContainerIdType(containerIdType string) *ListMessageReqBuilder

容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group)

示例值:chat

func (*ListMessageReqBuilder) EndTime

func (builder *ListMessageReqBuilder) EndTime(endTime string) *ListMessageReqBuilder

历史信息的结束时间(秒级时间戳)

示例值:1608594809

func (*ListMessageReqBuilder) Limit

func (builder *ListMessageReqBuilder) Limit(limit int) *ListMessageReqBuilder

最大返回多少记录,当使用迭代器访问时才有效

func (*ListMessageReqBuilder) PageSize

func (builder *ListMessageReqBuilder) PageSize(pageSize int) *ListMessageReqBuilder

分页大小

示例值:20

func (*ListMessageReqBuilder) PageToken

func (builder *ListMessageReqBuilder) PageToken(pageToken string) *ListMessageReqBuilder

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该page_token 获取查询结果

示例值:GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==

func (*ListMessageReqBuilder) SortType added in v3.0.22

func (builder *ListMessageReqBuilder) SortType(sortType string) *ListMessageReqBuilder

消息排序方式

示例值:ByCreateTimeAsc

func (*ListMessageReqBuilder) StartTime

func (builder *ListMessageReqBuilder) StartTime(startTime string) *ListMessageReqBuilder

历史信息的起始时间(秒级时间戳)

示例值:1609296809

type ListMessageResp

type ListMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListMessageRespData `json:"data"` // 业务数据
}

func (*ListMessageResp) Success

func (resp *ListMessageResp) Success() bool

type ListMessageRespData

type ListMessageRespData struct {
	HasMore   *bool      `json:"has_more,omitempty"`   // 是否还有后续翻页
	PageToken *string    `json:"page_token,omitempty"` // 下一页分页的token
	Items     []*Message `json:"items,omitempty"`      // message[]
}

type ListModerator

type ListModerator struct {
	UserIdType *string `json:"user_id_type,omitempty"` // 可发言用户 ID 类型
	UserId     *string `json:"user_id,omitempty"`      // 可发言用户 ID
	TenantKey  *string `json:"tenant_key,omitempty"`   // 租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
}

type ListModeratorBuilder

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

func NewListModeratorBuilder

func NewListModeratorBuilder() *ListModeratorBuilder

func (*ListModeratorBuilder) Build

func (builder *ListModeratorBuilder) Build() *ListModerator

func (*ListModeratorBuilder) TenantKey

func (builder *ListModeratorBuilder) TenantKey(tenantKey string) *ListModeratorBuilder

租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识

示例值:

func (*ListModeratorBuilder) UserId

func (builder *ListModeratorBuilder) UserId(userId string) *ListModeratorBuilder

可发言用户 ID

示例值:4d7a3c6g

func (*ListModeratorBuilder) UserIdType

func (builder *ListModeratorBuilder) UserIdType(userIdType string) *ListModeratorBuilder

可发言用户 ID 类型

示例值:user_id

type ListNotifyStatus added in v3.0.13

type ListNotifyStatus struct {
	UserId           *UserId `json:"user_id,omitempty"`            // 用户id
	NotifyStatusType *string `json:"notify_status_type,omitempty"` // 加急状态类型
}

type ListNotifyStatusBuilder added in v3.0.13

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

func NewListNotifyStatusBuilder added in v3.0.13

func NewListNotifyStatusBuilder() *ListNotifyStatusBuilder

func (*ListNotifyStatusBuilder) Build added in v3.0.13

func (builder *ListNotifyStatusBuilder) Build() *ListNotifyStatus

func (*ListNotifyStatusBuilder) NotifyStatusType added in v3.0.13

func (builder *ListNotifyStatusBuilder) NotifyStatusType(notifyStatusType string) *ListNotifyStatusBuilder

加急状态类型

示例值:

func (*ListNotifyStatusBuilder) UserId added in v3.0.13

func (builder *ListNotifyStatusBuilder) UserId(userId *UserId) *ListNotifyStatusBuilder

用户id

示例值:

type ListPinIterator added in v3.0.3

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

func (*ListPinIterator) Next added in v3.0.3

func (iterator *ListPinIterator) Next() (bool, *Pin, error)

func (*ListPinIterator) NextPageToken added in v3.0.3

func (iterator *ListPinIterator) NextPageToken() *string

type ListPinReq added in v3.0.3

type ListPinReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListPinReqBuilder added in v3.0.3

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

func NewListPinReqBuilder added in v3.0.3

func NewListPinReqBuilder() *ListPinReqBuilder

func (*ListPinReqBuilder) Build added in v3.0.3

func (builder *ListPinReqBuilder) Build() *ListPinReq

func (*ListPinReqBuilder) ChatId added in v3.0.3

func (builder *ListPinReqBuilder) ChatId(chatId string) *ListPinReqBuilder

待获取Pin消息的Chat ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_234jsi43d3ssi993d43545f

func (*ListPinReqBuilder) EndTime added in v3.0.3

func (builder *ListPinReqBuilder) EndTime(endTime string) *ListPinReqBuilder

Pin信息的结束时间(毫秒级时间戳)。若未填写默认从群聊内最新的Pin信息开始获取;;**注意**:`end_time`值应大于`start_time`值

示例值:1658731646425

func (*ListPinReqBuilder) Limit added in v3.0.3

func (builder *ListPinReqBuilder) Limit(limit int) *ListPinReqBuilder

最大返回多少记录,当使用迭代器访问时才有效

func (*ListPinReqBuilder) PageSize added in v3.0.3

func (builder *ListPinReqBuilder) PageSize(pageSize int) *ListPinReqBuilder

此次调用中使用的分页的大小

示例值:20

func (*ListPinReqBuilder) PageToken added in v3.0.3

func (builder *ListPinReqBuilder) PageToken(pageToken string) *ListPinReqBuilder

下一页分页的token

示例值:GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==

func (*ListPinReqBuilder) StartTime added in v3.0.3

func (builder *ListPinReqBuilder) StartTime(startTime string) *ListPinReqBuilder

Pin信息的起始时间(毫秒级时间戳)。若未填写默认获取到群聊内最早的Pin信息

示例值:1658632251800

type ListPinResp added in v3.0.3

type ListPinResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListPinRespData `json:"data"` // 业务数据
}

func (*ListPinResp) Success added in v3.0.3

func (resp *ListPinResp) Success() bool

type ListPinRespData added in v3.0.3

type ListPinRespData struct {
	Items     []*Pin  `json:"items,omitempty"`      // Pin的操作信息
	HasMore   *bool   `json:"has_more,omitempty"`   // 是否还有更多项
	PageToken *string `json:"page_token,omitempty"` // 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
}

type ListTabsChatTabReq

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

type ListTabsChatTabReqBuilder

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

func NewListTabsChatTabReqBuilder

func NewListTabsChatTabReqBuilder() *ListTabsChatTabReqBuilder

func (*ListTabsChatTabReqBuilder) Build

func (*ListTabsChatTabReqBuilder) ChatId

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:支持群模式为`p2p`与`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type ListTabsChatTabResp

type ListTabsChatTabResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListTabsChatTabRespData `json:"data"` // 业务数据
}

func (*ListTabsChatTabResp) Success

func (resp *ListTabsChatTabResp) Success() bool

type ListTabsChatTabRespData

type ListTabsChatTabRespData struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 会话标签页
}

type MeJoinChatMembersReq

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

type MeJoinChatMembersReqBuilder

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

func NewMeJoinChatMembersReqBuilder

func NewMeJoinChatMembersReqBuilder() *MeJoinChatMembersReqBuilder

func (*MeJoinChatMembersReqBuilder) Build

func (*MeJoinChatMembersReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:;- 仅支持公开(Public)群类型;- 对于已认证企业的飞书的群人数默认上限:普通群5000人,会议群3000人,话题群5000人

示例值:oc_a0553eda9014c201e6969b478895c230

type MeJoinChatMembersResp

type MeJoinChatMembersResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*MeJoinChatMembersResp) Success

func (resp *MeJoinChatMembersResp) Success() bool

type Mention

type Mention struct {
	Key       *string `json:"key,omitempty"`        // 被@的用户或机器人的序号。例如,第3个被@到的成员,值为“@_user_3”
	Id        *string `json:"id,omitempty"`         // 被@的用户或者机器人的open_id
	IdType    *string `json:"id_type,omitempty"`    // 被@的用户或机器人 id 类型,目前仅支持 `open_id` ([什么是 Open ID?](https://open.feishu.cn/document/home/user-identity-introduction/open-id))
	Name      *string `json:"name,omitempty"`       // 被@的用户或机器人的姓名
	TenantKey *string `json:"tenant_key,omitempty"` // 为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
}

type MentionBuilder

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

func NewMentionBuilder

func NewMentionBuilder() *MentionBuilder

func (*MentionBuilder) Build

func (builder *MentionBuilder) Build() *Mention

func (*MentionBuilder) Id

func (builder *MentionBuilder) Id(id string) *MentionBuilder

被@的用户或者机器人的open_id

示例值:ou_155184d1e73cbfb8973e5a9e698e74f2

func (*MentionBuilder) IdType

func (builder *MentionBuilder) IdType(idType string) *MentionBuilder

被@的用户或机器人 id 类型,目前仅支持 `open_id` ([什么是 Open ID?](https://open.feishu.cn/document/home/user-identity-introduction/open-id))

示例值:open_id

func (*MentionBuilder) Key

func (builder *MentionBuilder) Key(key string) *MentionBuilder

被@的用户或机器人的序号。例如,第3个被@到的成员,值为“@_user_3”

示例值:@_user_1

func (*MentionBuilder) Name

func (builder *MentionBuilder) Name(name string) *MentionBuilder

被@的用户或机器人的姓名

示例值:Tom

func (*MentionBuilder) TenantKey

func (builder *MentionBuilder) TenantKey(tenantKey string) *MentionBuilder

为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识

示例值:736588c9260f175e

type MentionEvent

type MentionEvent struct {
	Key       *string `json:"key,omitempty"`        // mention key
	Id        *UserId `json:"id,omitempty"`         // 用户 ID
	Name      *string `json:"name,omitempty"`       // 用户姓名
	TenantKey *string `json:"tenant_key,omitempty"` // tenant key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
}

type MentionEventBuilder

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

func NewMentionEventBuilder

func NewMentionEventBuilder() *MentionEventBuilder

func (*MentionEventBuilder) Build

func (builder *MentionEventBuilder) Build() *MentionEvent

func (*MentionEventBuilder) Id

用户 ID

示例值:

func (*MentionEventBuilder) Key

func (builder *MentionEventBuilder) Key(key string) *MentionEventBuilder

mention key

示例值:@_user_1

func (*MentionEventBuilder) Name

func (builder *MentionEventBuilder) Name(name string) *MentionEventBuilder

用户姓名

示例值:Tom

func (*MentionEventBuilder) TenantKey

func (builder *MentionEventBuilder) TenantKey(tenantKey string) *MentionEventBuilder

tenant key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识

示例值:736588c9260f175e

type MergeForwardMessagePathReqBodyBuilder added in v3.0.21

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

func NewMergeForwardMessagePathReqBodyBuilder added in v3.0.21

func NewMergeForwardMessagePathReqBodyBuilder() *MergeForwardMessagePathReqBodyBuilder

func (*MergeForwardMessagePathReqBodyBuilder) Build added in v3.0.21

func (*MergeForwardMessagePathReqBodyBuilder) MessageIdList added in v3.0.21

要转发的消息ID列表

示例值:

func (*MergeForwardMessagePathReqBodyBuilder) ReceiveId added in v3.0.21

依据receive_id_type的值,填写对应的转发目标的ID

示例值:oc_a0553eda9014c201e6969b478895c230

type MergeForwardMessageReq added in v3.0.21

type MergeForwardMessageReq struct {
	Body *MergeForwardMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type MergeForwardMessageReqBody added in v3.0.21

type MergeForwardMessageReqBody struct {
	ReceiveId     *string  `json:"receive_id,omitempty"`      // 依据receive_id_type的值,填写对应的转发目标的ID
	MessageIdList []string `json:"message_id_list,omitempty"` // 要转发的消息ID列表
}

type MergeForwardMessageReqBodyBuilder added in v3.0.21

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

func NewMergeForwardMessageReqBodyBuilder added in v3.0.21

func NewMergeForwardMessageReqBodyBuilder() *MergeForwardMessageReqBodyBuilder

func (*MergeForwardMessageReqBodyBuilder) Build added in v3.0.21

func (*MergeForwardMessageReqBodyBuilder) MessageIdList added in v3.0.21

func (builder *MergeForwardMessageReqBodyBuilder) MessageIdList(messageIdList []string) *MergeForwardMessageReqBodyBuilder

要转发的消息ID列表

示例值:

func (*MergeForwardMessageReqBodyBuilder) ReceiveId added in v3.0.21

依据receive_id_type的值,填写对应的转发目标的ID

示例值:oc_a0553eda9014c201e6969b478895c230

type MergeForwardMessageReqBuilder added in v3.0.21

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

func NewMergeForwardMessageReqBuilder added in v3.0.21

func NewMergeForwardMessageReqBuilder() *MergeForwardMessageReqBuilder

func (*MergeForwardMessageReqBuilder) Body added in v3.0.21

合并转发多条消息

func (*MergeForwardMessageReqBuilder) Build added in v3.0.21

func (*MergeForwardMessageReqBuilder) ReceiveIdType added in v3.0.21

func (builder *MergeForwardMessageReqBuilder) ReceiveIdType(receiveIdType string) *MergeForwardMessageReqBuilder

消息接收者id类型 open_id/user_id/union_id/email/chat_id

示例值:

func (*MergeForwardMessageReqBuilder) Uuid added in v3.0.21

由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。

示例值:b13g2t38-1jd2-458b-8djf-dtbca5104204

type MergeForwardMessageResp added in v3.0.21

type MergeForwardMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *MergeForwardMessageRespData `json:"data"` // 业务数据
}

func (*MergeForwardMessageResp) Success added in v3.0.21

func (resp *MergeForwardMessageResp) Success() bool

type MergeForwardMessageRespData added in v3.0.21

type MergeForwardMessageRespData struct {
	Message              *Message `json:"message,omitempty"`                 // 合并转发生成的新消息
	InvalidMessageIdList []string `json:"invalid_message_id_list,omitempty"` // 无效的消息ID列表
}

type Message

type Message struct {
	MessageId      *string      `json:"message_id,omitempty"`       // 消息id,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
	RootId         *string      `json:"root_id,omitempty"`          // 根消息id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
	ParentId       *string      `json:"parent_id,omitempty"`        // 父消息的id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
	MsgType        *string      `json:"msg_type,omitempty"`         // 消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[接收消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/events/message_content)
	CreateTime     *string      `json:"create_time,omitempty"`      // 消息生成的时间戳(毫秒)
	UpdateTime     *string      `json:"update_time,omitempty"`      // 消息更新的时间戳(毫秒)
	Deleted        *bool        `json:"deleted,omitempty"`          // 消息是否被撤回
	Updated        *bool        `json:"updated,omitempty"`          // 消息是否被更新
	ChatId         *string      `json:"chat_id,omitempty"`          // 所属的群
	Sender         *Sender      `json:"sender,omitempty"`           // 发送者,可以是用户或应用
	Body           *MessageBody `json:"body,omitempty"`             // 消息内容
	Mentions       []*Mention   `json:"mentions,omitempty"`         // 被@的用户或机器人的id列表
	UpperMessageId *string      `json:"upper_message_id,omitempty"` // 合并转发消息中,上一层级的消息id message_id,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
}

type MessageAudio

type MessageAudio struct {
	FileKey string `json:"file_key,omitempty"`
}

* audio类型消息结构化 *

func (*MessageAudio) String

func (m *MessageAudio) String() (string, error)

type MessageBody

type MessageBody struct {
	Content *string `json:"content,omitempty"` // 消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考:[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)
}

type MessageBodyBuilder

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

func NewMessageBodyBuilder

func NewMessageBodyBuilder() *MessageBodyBuilder

func (*MessageBodyBuilder) Build

func (builder *MessageBodyBuilder) Build() *MessageBody

func (*MessageBodyBuilder) Content

func (builder *MessageBodyBuilder) Content(content string) *MessageBodyBuilder

消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考:[发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)

示例值:text:测试消息

type MessageBuilder

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

func NewMessageBuilder

func NewMessageBuilder() *MessageBuilder

func (*MessageBuilder) Body

func (builder *MessageBuilder) Body(body *MessageBody) *MessageBuilder

消息内容

示例值:json结构

func (*MessageBuilder) Build

func (builder *MessageBuilder) Build() *Message

func (*MessageBuilder) ChatId

func (builder *MessageBuilder) ChatId(chatId string) *MessageBuilder

所属的群

示例值:oc_5ad11d72b830411d72b836c20

func (*MessageBuilder) CreateTime

func (builder *MessageBuilder) CreateTime(createTime string) *MessageBuilder

消息生成的时间戳(毫秒)

示例值:1615380573411

func (*MessageBuilder) Deleted

func (builder *MessageBuilder) Deleted(deleted bool) *MessageBuilder

消息是否被撤回

示例值:false

func (*MessageBuilder) Mentions

func (builder *MessageBuilder) Mentions(mentions []*Mention) *MessageBuilder

被@的用户或机器人的id列表

示例值:

func (*MessageBuilder) MessageId

func (builder *MessageBuilder) MessageId(messageId string) *MessageBuilder

消息id,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

func (*MessageBuilder) MsgType

func (builder *MessageBuilder) MsgType(msgType string) *MessageBuilder

消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[接收消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/events/message_content)

示例值:card

func (*MessageBuilder) ParentId

func (builder *MessageBuilder) ParentId(parentId string) *MessageBuilder

父消息的id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_d4be107c616aed9c1da8ed8068570a9f

func (*MessageBuilder) RootId

func (builder *MessageBuilder) RootId(rootId string) *MessageBuilder

根消息id,用于回复消息场景,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_40eb06e7b84dc71c03e009ad3c754195

func (*MessageBuilder) Sender

func (builder *MessageBuilder) Sender(sender *Sender) *MessageBuilder

发送者,可以是用户或应用

示例值:object

func (*MessageBuilder) UpdateTime

func (builder *MessageBuilder) UpdateTime(updateTime string) *MessageBuilder

消息更新的时间戳(毫秒)

示例值:1615380573411

func (*MessageBuilder) Updated

func (builder *MessageBuilder) Updated(updated bool) *MessageBuilder

消息是否被更新

示例值:false

func (*MessageBuilder) UpperMessageId

func (builder *MessageBuilder) UpperMessageId(upperMessageId string) *MessageBuilder

合并转发消息中,上一层级的消息id message_id,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_40eb06e7b84dc71c03e009ad3c754195

type MessageFile

type MessageFile struct {
	FileKey string `json:"file_key,omitempty"`
}

* 文件类型消息结构化 *

func (*MessageFile) String

func (m *MessageFile) String() (string, error)

type MessageImage

type MessageImage struct {
	ImageKey string `json:"image_key,omitempty"`
}

*

image类型消息结构化

*

func (*MessageImage) String

func (m *MessageImage) String() (string, error)

type MessageMedia

type MessageMedia struct {
	FileKey  string `json:"file_key,omitempty"`
	ImageKey string `json:"image_key,omitempty"`
}

* media类型消息结构化 *

func (*MessageMedia) String

func (m *MessageMedia) String() (string, error)

type MessagePost

type MessagePost struct {
	ZhCN *MessagePostContent `json:"zh_cn,omitempty"`
	EnUS *MessagePostContent `json:"en_us,omitempty"`
	JaJP *MessagePostContent `json:"ja_jp,omitempty"`
}

func NewMessagePost

func NewMessagePost() *MessagePost

func (*MessagePost) Build

func (m *MessagePost) Build() (string, error)

func (*MessagePost) EnUs

func (m *MessagePost) EnUs(enUs *MessagePostContent) *MessagePost

func (*MessagePost) JaJs

func (m *MessagePost) JaJs(jaJp *MessagePostContent) *MessagePost

func (*MessagePost) String

func (m *MessagePost) String() (string, error)

func (*MessagePost) ZhCn

func (m *MessagePost) ZhCn(zhCn *MessagePostContent) *MessagePost

type MessagePostA

type MessagePostA struct {
	Text     string `json:"text,omitempty"`
	Href     string `json:"href,omitempty"`
	UnEscape bool   `json:"un_escape,omitempty"`
}

func (*MessagePostA) IsPost

func (m *MessagePostA) IsPost()

func (*MessagePostA) MarshalJSON

func (m *MessagePostA) MarshalJSON() ([]byte, error)

func (*MessagePostA) Tag

func (m *MessagePostA) Tag() string

type MessagePostAt

type MessagePostAt struct {
	UserId   string `json:"user_id,omitempty"`
	UserName string `json:"user_name,omitempty"`
}

func (*MessagePostAt) IsPost

func (m *MessagePostAt) IsPost()

func (*MessagePostAt) MarshalJSON

func (m *MessagePostAt) MarshalJSON() ([]byte, error)

func (*MessagePostAt) Tag

func (m *MessagePostAt) Tag() string

type MessagePostContent

type MessagePostContent struct {
	Title   string                 `json:"title,omitempty"`
	Content [][]MessagePostElement `json:"content,omitempty"`
}

func NewMessagePostContent

func NewMessagePostContent() *MessagePostContent

func (*MessagePostContent) AppendContent

func (m *MessagePostContent) AppendContent(postElements []MessagePostElement) *MessagePostContent

func (*MessagePostContent) Build

func (*MessagePostContent) ContentTitle

func (m *MessagePostContent) ContentTitle(title string) *MessagePostContent

type MessagePostElement

type MessagePostElement interface {
	Tag() string
	IsPost()
	MarshalJSON() ([]byte, error)
}

type MessagePostImage added in v3.0.4

type MessagePostImage struct {
	ImageKey string `json:"image_key,omitempty"`
}

func (*MessagePostImage) IsPost added in v3.0.4

func (m *MessagePostImage) IsPost()

func (*MessagePostImage) MarshalJSON added in v3.0.4

func (m *MessagePostImage) MarshalJSON() ([]byte, error)

func (*MessagePostImage) Tag added in v3.0.4

func (m *MessagePostImage) Tag() string

type MessagePostMedia added in v3.0.4

type MessagePostMedia struct {
	FileKey  string `json:"file_key,omitempty"`
	ImageKey string `json:"image_key,omitempty"`
}

func (*MessagePostMedia) IsPost added in v3.0.4

func (m *MessagePostMedia) IsPost()

func (*MessagePostMedia) MarshalJSON added in v3.0.4

func (m *MessagePostMedia) MarshalJSON() ([]byte, error)

func (*MessagePostMedia) Tag added in v3.0.4

func (m *MessagePostMedia) Tag() string

type MessagePostText

type MessagePostText struct {
	Text     string `json:"text,omitempty"`
	UnEscape bool   `json:"un_escape,omitempty"`
}

func (*MessagePostText) IsPost

func (m *MessagePostText) IsPost()

func (*MessagePostText) MarshalJSON

func (m *MessagePostText) MarshalJSON() ([]byte, error)

func (*MessagePostText) Tag

func (m *MessagePostText) Tag() string

type MessageReaction

type MessageReaction struct {
	ReactionId   *string   `json:"reaction_id,omitempty"`   // reaction资源ID
	Operator     *Operator `json:"operator,omitempty"`      // 添加reaction的操作人
	ActionTime   *string   `json:"action_time,omitempty"`   // reaction动作的的unix timestamp(单位:ms)
	ReactionType *Emoji    `json:"reaction_type,omitempty"` // reaction资源类型
}

type MessageReactionBuilder

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

func NewMessageReactionBuilder

func NewMessageReactionBuilder() *MessageReactionBuilder

func (*MessageReactionBuilder) ActionTime

func (builder *MessageReactionBuilder) ActionTime(actionTime string) *MessageReactionBuilder

reaction动作的的unix timestamp(单位:ms)

示例值:

func (*MessageReactionBuilder) Build

func (builder *MessageReactionBuilder) Build() *MessageReaction

func (*MessageReactionBuilder) Operator

func (builder *MessageReactionBuilder) Operator(operator *Operator) *MessageReactionBuilder

添加reaction的操作人

示例值:

func (*MessageReactionBuilder) ReactionId

func (builder *MessageReactionBuilder) ReactionId(reactionId string) *MessageReactionBuilder

reaction资源ID

示例值:

func (*MessageReactionBuilder) ReactionType

func (builder *MessageReactionBuilder) ReactionType(reactionType *Emoji) *MessageReactionBuilder

reaction资源类型

示例值:

type MessageResource

type MessageResource struct {
}

type MessageShareChat

type MessageShareChat struct {
	ChatId string `json:"chat_id,omitempty"`
}

func (*MessageShareChat) String

func (m *MessageShareChat) String() (string, error)

type MessageShareUser

type MessageShareUser struct {
	UserId string `json:"user_id,omitempty"`
}

func (*MessageShareUser) String

func (m *MessageShareUser) String() (string, error)

type MessageSticker

type MessageSticker struct {
	FileKey string `json:"file_key,omitempty"`
}

* sticker 类型消息结构化 *

func (*MessageSticker) String

func (m *MessageSticker) String() (string, error)

type MessageText

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

* text类型消息结构化

func NewMessageTextBuilder added in v3.0.4

func NewMessageTextBuilder() *MessageText

func NewTextMsgBuilder

func NewTextMsgBuilder() *MessageText

func (*MessageText) AtAll

func (t *MessageText) AtAll() *MessageText

func (*MessageText) AtUser

func (t *MessageText) AtUser(userId, name string) *MessageText

func (*MessageText) Build

func (t *MessageText) Build() string

func (*MessageText) Line

func (t *MessageText) Line() *MessageText

func (*MessageText) Text

func (t *MessageText) Text(text string) *MessageText

func (*MessageText) TextLine

func (t *MessageText) TextLine(text string) *MessageText

type ModeratorList

type ModeratorList struct {
	AddedMemberList   []*ListEventModerator `json:"added_member_list,omitempty"`   // 被添加进可发言名单的用户列表(列表中一定会有owner)
	RemovedMemberList []*ListEventModerator `json:"removed_member_list,omitempty"` // 被移除出可发言名单的用户列表
}

type ModeratorListBuilder

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

func NewModeratorListBuilder

func NewModeratorListBuilder() *ModeratorListBuilder

func (*ModeratorListBuilder) AddedMemberList

func (builder *ModeratorListBuilder) AddedMemberList(addedMemberList []*ListEventModerator) *ModeratorListBuilder

被添加进可发言名单的用户列表(列表中一定会有owner)

示例值:

func (*ModeratorListBuilder) Build

func (builder *ModeratorListBuilder) Build() *ModeratorList

func (*ModeratorListBuilder) RemovedMemberList

func (builder *ModeratorListBuilder) RemovedMemberList(removedMemberList []*ListEventModerator) *ModeratorListBuilder

被移除出可发言名单的用户列表

示例值:

type MsgProcessData

type MsgProcessData struct {
	PDate                   *string  `json:"p_date,omitempty"`                        // 分区日期
	DepartmentId            *string  `json:"department_id,omitempty"`                 // 部门id
	DepartmentPath          *string  `json:"department_path,omitempty"`               // 部门路径
	AvgImpMsgReadRate12h    *float64 `json:"avg_imp_msg_read_rate_12h,omitempty"`     // 人均重要消息 12 小时阅读率
	MsgReadRate12h          *float64 `json:"msg_read_rate_12h,omitempty"`             // 人均 12 小时阅读率
	AvgReceiveMsgCnt        *float64 `json:"avg_receive_msg_cnt,omitempty"`           // 人均接收消息数
	AvgReadMsgCnt           *float64 `json:"avg_read_msg_cnt,omitempty"`              // 人均阅读消息数
	AvgImpReadMsgCnt        *float64 `json:"avg_imp_read_msg_cnt,omitempty"`          // 人均重要消息阅读数
	AvgImpReceiveMsgCnt     *float64 `json:"avg_imp_receive_msg_cnt,omitempty"`       // 人均重要消息接收数
	HighLoadRate            *float64 `json:"high_load_rate,omitempty"`                // 信息高负载员工占比
	BigGroupMsgRate         *float64 `json:"big_group_msg_rate,omitempty"`            // 大群(100人以上)消息占比
	BigGroupTopicMsgRate    *float64 `json:"big_group_topic_msg_rate,omitempty"`      // 大群消息中话题消息占比
	AvgReceiveBotMsgCnt     *float64 `json:"avg_receive_bot_msg_cnt,omitempty"`       // 人均接收 bot 消息数
	AvgBotImpMsgReadRate12h *float64 `json:"avg_bot_imp_msg_read_rate_12h,omitempty"` // 重要 bot 消息 12 小时阅读率
	ReceiveBotMsgRate       *float64 `json:"receive_bot_msg_rate,omitempty"`          // 接收 bot 消息占比
	UseChatBoxRate          *float64 `json:"use_chat_box_rate,omitempty"`             // 会话盒子使用率
	ReceiveMuteMsgRate      *float64 `json:"receive_mute_msg_rate,omitempty"`         // 接收消息中 mute 消息占比
	ReadMuteMsgRate         *float64 `json:"read_mute_msg_rate,omitempty"`            // 阅读消息中 mute 消息占比
	AvgReceiveImpMsgChatCnt *float64 `json:"avg_receive_imp_msg_chat_cnt,omitempty"`  // 人均有重要消息的会话数
}

type MsgProcessDataBuilder

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

func NewMsgProcessDataBuilder

func NewMsgProcessDataBuilder() *MsgProcessDataBuilder

func (*MsgProcessDataBuilder) AvgBotImpMsgReadRate12h

func (builder *MsgProcessDataBuilder) AvgBotImpMsgReadRate12h(avgBotImpMsgReadRate12h float64) *MsgProcessDataBuilder

重要 bot 消息 12 小时阅读率

示例值:0.50

func (*MsgProcessDataBuilder) AvgImpMsgReadRate12h

func (builder *MsgProcessDataBuilder) AvgImpMsgReadRate12h(avgImpMsgReadRate12h float64) *MsgProcessDataBuilder

人均重要消息 12 小时阅读率

示例值:0.50

func (*MsgProcessDataBuilder) AvgImpReadMsgCnt

func (builder *MsgProcessDataBuilder) AvgImpReadMsgCnt(avgImpReadMsgCnt float64) *MsgProcessDataBuilder

人均重要消息阅读数

示例值:50

func (*MsgProcessDataBuilder) AvgImpReceiveMsgCnt

func (builder *MsgProcessDataBuilder) AvgImpReceiveMsgCnt(avgImpReceiveMsgCnt float64) *MsgProcessDataBuilder

人均重要消息接收数

示例值:50

func (*MsgProcessDataBuilder) AvgReadMsgCnt

func (builder *MsgProcessDataBuilder) AvgReadMsgCnt(avgReadMsgCnt float64) *MsgProcessDataBuilder

人均阅读消息数

示例值:50

func (*MsgProcessDataBuilder) AvgReceiveBotMsgCnt

func (builder *MsgProcessDataBuilder) AvgReceiveBotMsgCnt(avgReceiveBotMsgCnt float64) *MsgProcessDataBuilder

人均接收 bot 消息数

示例值:0.50

func (*MsgProcessDataBuilder) AvgReceiveImpMsgChatCnt

func (builder *MsgProcessDataBuilder) AvgReceiveImpMsgChatCnt(avgReceiveImpMsgChatCnt float64) *MsgProcessDataBuilder

人均有重要消息的会话数

示例值:50

func (*MsgProcessDataBuilder) AvgReceiveMsgCnt

func (builder *MsgProcessDataBuilder) AvgReceiveMsgCnt(avgReceiveMsgCnt float64) *MsgProcessDataBuilder

人均接收消息数

示例值:50

func (*MsgProcessDataBuilder) BigGroupMsgRate

func (builder *MsgProcessDataBuilder) BigGroupMsgRate(bigGroupMsgRate float64) *MsgProcessDataBuilder

大群(100人以上)消息占比

示例值:0.50

func (*MsgProcessDataBuilder) BigGroupTopicMsgRate

func (builder *MsgProcessDataBuilder) BigGroupTopicMsgRate(bigGroupTopicMsgRate float64) *MsgProcessDataBuilder

大群消息中话题消息占比

示例值:0.50

func (*MsgProcessDataBuilder) Build

func (builder *MsgProcessDataBuilder) Build() *MsgProcessData

func (*MsgProcessDataBuilder) DepartmentId

func (builder *MsgProcessDataBuilder) DepartmentId(departmentId string) *MsgProcessDataBuilder

部门id

示例值:123456

func (*MsgProcessDataBuilder) DepartmentPath

func (builder *MsgProcessDataBuilder) DepartmentPath(departmentPath string) *MsgProcessDataBuilder

部门路径

示例值:test/subtest

func (*MsgProcessDataBuilder) HighLoadRate

func (builder *MsgProcessDataBuilder) HighLoadRate(highLoadRate float64) *MsgProcessDataBuilder

信息高负载员工占比

示例值:0.50

func (*MsgProcessDataBuilder) MsgReadRate12h

func (builder *MsgProcessDataBuilder) MsgReadRate12h(msgReadRate12h float64) *MsgProcessDataBuilder

人均 12 小时阅读率

示例值:0.50

func (*MsgProcessDataBuilder) PDate

func (builder *MsgProcessDataBuilder) PDate(pDate string) *MsgProcessDataBuilder

分区日期

示例值:2022-02-02

func (*MsgProcessDataBuilder) ReadMuteMsgRate

func (builder *MsgProcessDataBuilder) ReadMuteMsgRate(readMuteMsgRate float64) *MsgProcessDataBuilder

阅读消息中 mute 消息占比

示例值:0.50

func (*MsgProcessDataBuilder) ReceiveBotMsgRate

func (builder *MsgProcessDataBuilder) ReceiveBotMsgRate(receiveBotMsgRate float64) *MsgProcessDataBuilder

接收 bot 消息占比

示例值:0.50

func (*MsgProcessDataBuilder) ReceiveMuteMsgRate

func (builder *MsgProcessDataBuilder) ReceiveMuteMsgRate(receiveMuteMsgRate float64) *MsgProcessDataBuilder

接收消息中 mute 消息占比

示例值:0.50

func (*MsgProcessDataBuilder) UseChatBoxRate

func (builder *MsgProcessDataBuilder) UseChatBoxRate(useChatBoxRate float64) *MsgProcessDataBuilder

会话盒子使用率

示例值:0.50

type Operator

type Operator struct {
	OperatorId   *string `json:"operator_id,omitempty"`   // 操作人ID
	OperatorType *string `json:"operator_type,omitempty"` // 操作人身份,用户或应用
}

type OperatorBuilder

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

func NewOperatorBuilder

func NewOperatorBuilder() *OperatorBuilder

func (*OperatorBuilder) Build

func (builder *OperatorBuilder) Build() *Operator

func (*OperatorBuilder) OperatorId

func (builder *OperatorBuilder) OperatorId(operatorId string) *OperatorBuilder

操作人ID

示例值:ou_ff0b7ba35fb********67dfc8b885136

func (*OperatorBuilder) OperatorType

func (builder *OperatorBuilder) OperatorType(operatorType string) *OperatorBuilder

操作人身份,用户或应用

示例值:app/user

type P1AddBotV1

type P1AddBotV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1AddBotV1Data `json:"event"`
}

func (*P1AddBotV1) RawReq

func (m *P1AddBotV1) RawReq(req *larkevent.EventReq)

type P1AddBotV1Data

type P1AddBotV1Data struct {
	Type                string         `json:"type,omitempty"`                   // 事件类型
	AppID               string         `json:"app_id,omitempty"`                 // 应用 ID
	ChatI18nNames       *ChatI18nNames `json:"chat_i18n_names,omitempty"`        // 群名称国际化字段
	ChatName            string         `json:"chat_name,omitempty"`              // 群名称
	ChatOwnerEmployeeID string         `json:"chat_owner_employee_id,omitempty"` // 群主的employee_id(即“用户ID”。如果群主是机器人则没有这个字段,仅企业自建应用返回)
	ChatOwnerName       string         `json:"chat_owner_name,omitempty"`        // 群主姓名
	ChatOwnerOpenID     string         `json:"chat_owner_open_id,omitempty"`     // 群主的open_id
	OpenChatID          string         `json:"open_chat_id,omitempty"`           // 群聊的id
	OperatorEmployeeID  string         `json:"operator_employee_id,omitempty"`   // 操作者的emplolyee_id ,仅企业自建应用返回
	OperatorName        string         `json:"operator_name,omitempty"`          // 操作者姓名
	OperatorOpenID      string         `json:"operator_open_id,omitempty"`       //操作者的open_id
	OwnerIsBot          bool           `json:"owner_is_bot,omitempty"`           //群主是否是机器人
	TenantKey           string         `json:"tenant_key,omitempty"`             // 企业标识
}

type P1AddBotV1Handler

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

func NewP1AddBotV1Handler

func NewP1AddBotV1Handler(handler func(context.Context, *P1AddBotV1) error) *P1AddBotV1Handler

func (*P1AddBotV1Handler) Event

func (h *P1AddBotV1Handler) Event() interface{}

func (*P1AddBotV1Handler) Handle

func (h *P1AddBotV1Handler) Handle(ctx context.Context, event interface{}) error

type P1ChatDisbandV1

type P1ChatDisbandV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1ChatDisbandV1Data `json:"event"`
}

func (*P1ChatDisbandV1) RawReq

func (m *P1ChatDisbandV1) RawReq(req *larkevent.EventReq)

type P1ChatDisbandV1Data

type P1ChatDisbandV1Data struct {
	Type      string        `json:"type,omitempty"`       // 事件类型
	AppID     string        `json:"app_id,omitempty"`     // APP ID
	ChatId    string        `json:"chat_id,omitempty"`    // 群聊的id
	Operator  *P1OperatorV1 `json:"operator,omitempty"`   // 解散群的人
	TenantKey string        `json:"tenant_key,omitempty"` // 企业标识
}

type P1ChatDisbandV1Handler

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

func NewP1DisbandChatV1Handler

func NewP1DisbandChatV1Handler(handler func(context.Context, *P1ChatDisbandV1) error) *P1ChatDisbandV1Handler

func (*P1ChatDisbandV1Handler) Event

func (h *P1ChatDisbandV1Handler) Event() interface{}

func (*P1ChatDisbandV1Handler) Handle

func (h *P1ChatDisbandV1Handler) Handle(ctx context.Context, event interface{}) error

type P1GroupSettingChangeV1

type P1GroupSettingChangeV1 struct {
	OwnerOpenId         string `json:"owner_open_id,omitempty"`         // 当群主发生变化时会有下面2个字段。若群主未发生变化,则不会有这2个字段。
	OwnerUserId         string `json:"owner_user_id,omitempty"`         // 当群主发生变化时会有下面2个字段。若群主未发生变化,则不会有这2个字段。
	AddMemberPermission string `json:"add_member_permission,omitempty"` // 当“仅群主可添加群成员”配置变化时有下面的字段。
	MessageNotification bool   `json:"message_notification,omitempty"`  // 当“消息提醒”配置变化时有下面的字段。

}

type P1GroupSettingUpdatedV1

type P1GroupSettingUpdatedV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1GroupSettingUpdatedV1Data `json:"event"`
}

func (*P1GroupSettingUpdatedV1) RawReq

func (m *P1GroupSettingUpdatedV1) RawReq(req *larkevent.EventReq)

type P1GroupSettingUpdatedV1Data

type P1GroupSettingUpdatedV1Data struct {
	Type         string                  `json:"type,omitempty"`       // 事件类型
	AppID        string                  `json:"app_id,omitempty"`     // 应用ID
	ChatId       string                  `json:"chat_id,omitempty"`    // 群聊ID
	Operator     *P1OperatorV1           `json:"operator,omitempty"`   // 配置变化的操作者
	TenantKey    string                  `json:"tenant_key,omitempty"` // 企业标识
	BeforeChange *P1GroupSettingChangeV1 `json:"before_change,omitempty"`
	AfterChange  *P1GroupSettingChangeV1 `json:"after_change,omitempty"`
}

type P1GroupSettingUpdatedV1Handler

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

func (*P1GroupSettingUpdatedV1Handler) Event

func (h *P1GroupSettingUpdatedV1Handler) Event() interface{}

func (*P1GroupSettingUpdatedV1Handler) Handle

func (h *P1GroupSettingUpdatedV1Handler) Handle(ctx context.Context, event interface{}) error

type P1MessageReadV1

type P1MessageReadV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1MessageReadV1Data `json:"event"`
}

func (*P1MessageReadV1) RawReq

func (m *P1MessageReadV1) RawReq(req *larkevent.EventReq)

type P1MessageReadV1Data

type P1MessageReadV1Data struct {
	MessageIdList []string `json:"message_id_list,omitempty"` // 已读消息列表
	AppID         string   `json:"app_id"`                    // 应用ID
	OpenAppID     string   `json:"open_chat_id"`
	OpenID        string   `json:"open_id"`
	TenantKey     string   `json:"tenant_key"` // 企业标识
	Type          string   `json:"type"`       // 事件类型
}

protocol v1的 Message_Read

type P1MessageReadV1Handler

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

protocol v1 的 message_read

func NewP1MessageReadV1Handler

func NewP1MessageReadV1Handler(handler func(context.Context, *P1MessageReadV1) error) *P1MessageReadV1Handler

func (*P1MessageReadV1Handler) Event

func (h *P1MessageReadV1Handler) Event() interface{}

func (*P1MessageReadV1Handler) Handle

func (h *P1MessageReadV1Handler) Handle(ctx context.Context, event interface{}) error

type P1MessageReceiveV1

type P1MessageReceiveV1 struct {
	*larkevent.EventBase
	*larkevent.EventReq
	Event *P1MessageReceiveV1Data `json:"event"`
}

protocol v1的 message

func (*P1MessageReceiveV1) RawReq

func (m *P1MessageReceiveV1) RawReq(req *larkevent.EventReq)

type P1MessageReceiveV1Data

type P1MessageReceiveV1Data struct {
	Type             string   `json:"type,omitempty"`       // 事件类型
	AppID            string   `json:"app_id,omitempty"`     // 应用ID
	TenantKey        string   `json:"tenant_key,omitempty"` // 企业标识
	RootID           string   `json:"root_id,omitempty"`
	ParentID         string   `json:"parent_id,omitempty"`
	OpenChatID       string   `json:"open_chat_id,omitempty"`    //发消息的open_chat_id
	ChatType         string   `json:"chat_type,omitempty"`       //私聊private,群聊group
	MsgType          string   `json:"msg_type,omitempty"`        //消息类型
	OpenID           string   `json:"open_id,omitempty"`         //发消息的用户open_id
	EmployeeID       string   `json:"employee_id,omitempty"`     // 即“用户ID”,仅企业自建应用会返回
	UnionID          string   `json:"union_id,omitempty"`        //发消息的用户union_id
	OpenMessageID    string   `json:"open_message_id,omitempty"` //消息id
	IsMention        bool     `json:"is_mention,omitempty"`
	Text             string   `json:"text,omitempty"`                // 消息文本,可能包含被@的人/机器人。
	TextWithoutAtBot string   `json:"text_without_at_bot,omitempty"` //消息内容,会过滤掉at你的机器人的内容,当内容只有at机器人,该字段会被过滤。
	Title            string   `json:"title,omitempty"`               //消息标题
	ImageKeys        []string `json:"image_keys,omitempty"`          //富文本里面的图片的keys
	ImageKey         string   `json:"image_key,omitempty"`           // image_key,获取图片内容请查/ssl:ttdoc/ukTMukTMukTM/uYzN5QjL2cTO04iN3kDN
	FileKey          string   `json:"file_key,omitempty"`
}

type P1MessageReceiveV1Handler

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

protocol v1 的 message

func NewP1MessageReceiveV1Handler

func NewP1MessageReceiveV1Handler(handler func(context.Context, *P1MessageReceiveV1) error) *P1MessageReceiveV1Handler

func (*P1MessageReceiveV1Handler) Event

func (h *P1MessageReceiveV1Handler) Event() interface{}

func (*P1MessageReceiveV1Handler) Handle

func (h *P1MessageReceiveV1Handler) Handle(ctx context.Context, event interface{}) error

type P1OperatorV1

type P1OperatorV1 struct {
	OpenId string `json:"open_id,omitempty"` // 员工对此应用的唯一标识,同一员工对不同应用的open_id不同
	UserId string `json:"user_id,omitempty"` // 即“用户ID”,仅企业自建应用会返回
}

type P1P2PChatCreatedV1

type P1P2PChatCreatedV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1P2PChatCreatedV1Data `json:"event"`
}

func (*P1P2PChatCreatedV1) RawReq

func (m *P1P2PChatCreatedV1) RawReq(req *larkevent.EventReq)

type P1P2PChatCreatedV1Data

type P1P2PChatCreatedV1Data struct {
	AppID     string        `json:"app_id,omitempty"`     // APP ID
	ChatID    string        `json:"chat_id,omitempty"`    //机器人和用户的会话id
	Operator  *P1OperatorV1 `json:"operator,omitempty"`   // 会话的发起人。可能是用户,也可能是机器人。
	TenantKey string        `json:"tenant_key,omitempty"` // 企业标识
	Type      string        `json:"type,omitempty"`       // 事件类型
	User      *P1UserV1     `json:"user,omitempty"`       // 会话的用户
}

type P1P2PChatCreatedV1Handler

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

func NewP1P2PChatCreatedV1Handler

func NewP1P2PChatCreatedV1Handler(handler func(context.Context, *P1P2PChatCreatedV1) error) *P1P2PChatCreatedV1Handler

func (*P1P2PChatCreatedV1Handler) Event

func (h *P1P2PChatCreatedV1Handler) Event() interface{}

func (*P1P2PChatCreatedV1Handler) Handle

func (h *P1P2PChatCreatedV1Handler) Handle(ctx context.Context, event interface{}) error

type P1RemoveBotV1

type P1RemoveBotV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1RemoveBotV1Data `json:"event"`
}

func (*P1RemoveBotV1) RawReq

func (m *P1RemoveBotV1) RawReq(req *larkevent.EventReq)

type P1RemoveBotV1Data

type P1RemoveBotV1Data struct {
	Type                string         `json:"type,omitempty"`                   // 事件类型 移除机器人:remove_bot
	AppID               string         `json:"app_id,omitempty"`                 // 应用 ID
	ChatI18nNames       *ChatI18nNames `json:"chat_i18n_names,omitempty"`        // 群名称国际化字段
	ChatName            string         `json:"chat_name,omitempty"`              // 群名称
	ChatOwnerEmployeeID string         `json:"chat_owner_employee_id,omitempty"` // 群主的employee_id(即“用户ID”。如果群主是机器人则没有这个字段,仅企业自建应用返回)
	ChatOwnerName       string         `json:"chat_owner_name,omitempty"`        // 群主姓名
	ChatOwnerOpenID     string         `json:"chat_owner_open_id,omitempty"`     // 群主的open_id
	OpenChatID          string         `json:"open_chat_id,omitempty"`           // 群聊的id
	OperatorEmployeeID  string         `json:"operator_employee_id,omitempty"`   // 操作者姓名
	OperatorName        string         `json:"operator_name,omitempty"`          // 操作者的emplolyee_id ,仅企业自建应用返回
	OperatorOpenID      string         `json:"operator_open_id,omitempty"`       //操作者的open_id
	OwnerIsBot          bool           `json:"owner_is_bot,omitempty"`           //群主是否是机器人
	TenantKey           string         `json:"tenant_key,omitempty"`             // 企业标识
}

type P1RemoveBotV1Handler

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

func NewP1RemoveBotV1Handler

func NewP1RemoveBotV1Handler(handler func(context.Context, *P1RemoveBotV1) error) *P1RemoveBotV1Handler

func (*P1RemoveBotV1Handler) Event

func (h *P1RemoveBotV1Handler) Event() interface{}

func (*P1RemoveBotV1Handler) Handle

func (h *P1RemoveBotV1Handler) Handle(ctx context.Context, event interface{}) error

type P1UserInOutChatV1

type P1UserInOutChatV1 struct {
	*larkevent.EventReq
	*larkevent.EventBase
	Event *P1UserInOutChatV1Data `json:"event"`
}

func (*P1UserInOutChatV1) RawReq

func (m *P1UserInOutChatV1) RawReq(req *larkevent.EventReq)

type P1UserInOutChatV1Data

type P1UserInOutChatV1Data struct {
	Type      string        `json:"type,omitempty"`       // 事件类型,add_user_to_chat/remove_user_from_chat/revoke_add_user_from_chat
	AppID     string        `json:"app_id,omitempty"`     // APP ID
	ChatId    string        `json:"chat_id,omitempty"`    // 群聊的id
	Operator  *P1OperatorV1 `json:"operator,omitempty"`   // 用户进出群的操作人。用户主动退群的话,operator 就是user自己
	TenantKey string        `json:"tenant_key,omitempty"` // 企业标识
	Users     []*P1UserV1   `json:"users,omitempty"`
}

type P1UserInOutChatV1Handler

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

func NewP1UserInOutChatV1Handler

func NewP1UserInOutChatV1Handler(handler func(context.Context, *P1UserInOutChatV1) error) *P1UserInOutChatV1Handler

func (*P1UserInOutChatV1Handler) Event

func (h *P1UserInOutChatV1Handler) Event() interface{}

func (*P1UserInOutChatV1Handler) Handle

func (h *P1UserInOutChatV1Handler) Handle(ctx context.Context, event interface{}) error

type P1UserV1

type P1UserV1 struct {
	OpenId string `json:"open_id,omitempty"` // 员工对此应用的唯一标识,同一员工对不同应用的open_id不同
	UserId string `json:"user_id,omitempty"` // 即“用户ID”,仅企业自建应用会返回
	Name   string `json:"name,omitempty"`    // 姓名
}

type P2ChatDisbandedV1

type P2ChatDisbandedV1 struct {
	*larkevent.EventV2Base                        // 事件基础数据
	*larkevent.EventReq                           // 请求原生数据
	Event                  *P2ChatDisbandedV1Data `json:"event"` // 事件内容
}

func (*P2ChatDisbandedV1) RawReq

func (m *P2ChatDisbandedV1) RawReq(req *larkevent.EventReq)

type P2ChatDisbandedV1Data

type P2ChatDisbandedV1Data struct {
	ChatId            *string    `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId    `json:"operator_id,omitempty"`         // 操作者的ID
	External          *bool      `json:"external,omitempty"`            // 被解散的群是否是外部群
	OperatorTenantKey *string    `json:"operator_tenant_key,omitempty"` // 操作者的租户 Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
	Name              *string    `json:"name,omitempty"`                // 群名称
	I18nNames         *I18nNames `json:"i18n_names,omitempty"`          // 群国际化名称
}

type P2ChatDisbandedV1Handler

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

消息处理器定义

func NewP2ChatDisbandedV1Handler

func NewP2ChatDisbandedV1Handler(handler func(context.Context, *P2ChatDisbandedV1) error) *P2ChatDisbandedV1Handler

func (*P2ChatDisbandedV1Handler) Event

func (h *P2ChatDisbandedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatDisbandedV1Handler) Handle

func (h *P2ChatDisbandedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2ChatMemberBotAddedV1

type P2ChatMemberBotAddedV1 struct {
	*larkevent.EventV2Base                             // 事件基础数据
	*larkevent.EventReq                                // 请求原生数据
	Event                  *P2ChatMemberBotAddedV1Data `json:"event"` // 事件内容
}

func (*P2ChatMemberBotAddedV1) RawReq

func (m *P2ChatMemberBotAddedV1) RawReq(req *larkevent.EventReq)

type P2ChatMemberBotAddedV1Data

type P2ChatMemberBotAddedV1Data struct {
	ChatId            *string    `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId    `json:"operator_id,omitempty"`         // 用户 ID
	External          *bool      `json:"external,omitempty"`            // 是否是外部群
	OperatorTenantKey *string    `json:"operator_tenant_key,omitempty"` // 操作者的租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
	Name              *string    `json:"name,omitempty"`                // 群名称
	I18nNames         *I18nNames `json:"i18n_names,omitempty"`          // 群国际化名称
}

type P2ChatMemberBotAddedV1Handler

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

消息处理器定义

func (*P2ChatMemberBotAddedV1Handler) Event

func (h *P2ChatMemberBotAddedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatMemberBotAddedV1Handler) Handle

func (h *P2ChatMemberBotAddedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2ChatMemberBotDeletedV1

type P2ChatMemberBotDeletedV1 struct {
	*larkevent.EventV2Base                               // 事件基础数据
	*larkevent.EventReq                                  // 请求原生数据
	Event                  *P2ChatMemberBotDeletedV1Data `json:"event"` // 事件内容
}

func (*P2ChatMemberBotDeletedV1) RawReq

func (m *P2ChatMemberBotDeletedV1) RawReq(req *larkevent.EventReq)

type P2ChatMemberBotDeletedV1Data

type P2ChatMemberBotDeletedV1Data struct {
	ChatId            *string    `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId    `json:"operator_id,omitempty"`         // 用户 ID
	External          *bool      `json:"external,omitempty"`            // 是否是外部群
	OperatorTenantKey *string    `json:"operator_tenant_key,omitempty"` // 操作者租户 Key
	Name              *string    `json:"name,omitempty"`                // 群名称
	I18nNames         *I18nNames `json:"i18n_names,omitempty"`          // 群国际化名称
}

type P2ChatMemberBotDeletedV1Handler

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

消息处理器定义

func (*P2ChatMemberBotDeletedV1Handler) Event

func (h *P2ChatMemberBotDeletedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatMemberBotDeletedV1Handler) Handle

func (h *P2ChatMemberBotDeletedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2ChatMemberUserAddedV1

type P2ChatMemberUserAddedV1 struct {
	*larkevent.EventV2Base                              // 事件基础数据
	*larkevent.EventReq                                 // 请求原生数据
	Event                  *P2ChatMemberUserAddedV1Data `json:"event"` // 事件内容
}

func (*P2ChatMemberUserAddedV1) RawReq

func (m *P2ChatMemberUserAddedV1) RawReq(req *larkevent.EventReq)

type P2ChatMemberUserAddedV1Data

type P2ChatMemberUserAddedV1Data struct {
	ChatId            *string           `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId           `json:"operator_id,omitempty"`         // 用户 ID
	External          *bool             `json:"external,omitempty"`            // 是否是外部群
	OperatorTenantKey *string           `json:"operator_tenant_key,omitempty"` // 操作者租户 Key
	Users             []*ChatMemberUser `json:"users,omitempty"`               // 被添加的用户列表
	Name              *string           `json:"name,omitempty"`                // 群名称
	I18nNames         *I18nNames        `json:"i18n_names,omitempty"`          // 群国际化名称
}

type P2ChatMemberUserAddedV1Handler

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

消息处理器定义

func (*P2ChatMemberUserAddedV1Handler) Event

func (h *P2ChatMemberUserAddedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatMemberUserAddedV1Handler) Handle

func (h *P2ChatMemberUserAddedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2ChatMemberUserDeletedV1

type P2ChatMemberUserDeletedV1 struct {
	*larkevent.EventV2Base                                // 事件基础数据
	*larkevent.EventReq                                   // 请求原生数据
	Event                  *P2ChatMemberUserDeletedV1Data `json:"event"` // 事件内容
}

func (*P2ChatMemberUserDeletedV1) RawReq

func (m *P2ChatMemberUserDeletedV1) RawReq(req *larkevent.EventReq)

type P2ChatMemberUserDeletedV1Data

type P2ChatMemberUserDeletedV1Data struct {
	ChatId            *string           `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId           `json:"operator_id,omitempty"`         // 用户 ID
	External          *bool             `json:"external,omitempty"`            // 是否是外部群
	OperatorTenantKey *string           `json:"operator_tenant_key,omitempty"` // 操作者的租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
	Users             []*ChatMemberUser `json:"users,omitempty"`               // 被移除用户列表
	Name              *string           `json:"name,omitempty"`                // 群名称
	I18nNames         *I18nNames        `json:"i18n_names,omitempty"`          // 群国际化名称
}

type P2ChatMemberUserDeletedV1Handler

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

消息处理器定义

func (*P2ChatMemberUserDeletedV1Handler) Event

func (h *P2ChatMemberUserDeletedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatMemberUserDeletedV1Handler) Handle

func (h *P2ChatMemberUserDeletedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2ChatMemberUserWithdrawnV1

type P2ChatMemberUserWithdrawnV1 struct {
	*larkevent.EventV2Base                                  // 事件基础数据
	*larkevent.EventReq                                     // 请求原生数据
	Event                  *P2ChatMemberUserWithdrawnV1Data `json:"event"` // 事件内容
}

func (*P2ChatMemberUserWithdrawnV1) RawReq

func (m *P2ChatMemberUserWithdrawnV1) RawReq(req *larkevent.EventReq)

type P2ChatMemberUserWithdrawnV1Data

type P2ChatMemberUserWithdrawnV1Data struct {
	ChatId            *string           `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId           `json:"operator_id,omitempty"`         // 用户 ID
	External          *bool             `json:"external,omitempty"`            // 是否是外部群
	OperatorTenantKey *string           `json:"operator_tenant_key,omitempty"` // 操作者的租户Key,为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用中的唯一标识
	Users             []*ChatMemberUser `json:"users,omitempty"`               // 被撤销加群的用户列表
	Name              *string           `json:"name,omitempty"`                // 群名称
	I18nNames         *I18nNames        `json:"i18n_names,omitempty"`          // 群国际化名称
}

type P2ChatMemberUserWithdrawnV1Handler

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

消息处理器定义

func (*P2ChatMemberUserWithdrawnV1Handler) Event

func (h *P2ChatMemberUserWithdrawnV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatMemberUserWithdrawnV1Handler) Handle

func (h *P2ChatMemberUserWithdrawnV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2ChatUpdatedV1

type P2ChatUpdatedV1 struct {
	*larkevent.EventV2Base                      // 事件基础数据
	*larkevent.EventReq                         // 请求原生数据
	Event                  *P2ChatUpdatedV1Data `json:"event"` // 事件内容
}

func (*P2ChatUpdatedV1) RawReq

func (m *P2ChatUpdatedV1) RawReq(req *larkevent.EventReq)

type P2ChatUpdatedV1Data

type P2ChatUpdatedV1Data struct {
	ChatId            *string        `json:"chat_id,omitempty"`             // 群组 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)
	OperatorId        *UserId        `json:"operator_id,omitempty"`         // 用户 ID
	External          *bool          `json:"external,omitempty"`            // 是否是外部群
	OperatorTenantKey *string        `json:"operator_tenant_key,omitempty"` // 操作者租户 Key
	AfterChange       *ChatChange    `json:"after_change,omitempty"`        // 更新后的群信息
	BeforeChange      *ChatChange    `json:"before_change,omitempty"`       // 更新前的群信息
	ModeratorList     *ModeratorList `json:"moderator_list,omitempty"`      // 群可发言成员名单的变更信息
}

type P2ChatUpdatedV1Handler

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

消息处理器定义

func NewP2ChatUpdatedV1Handler

func NewP2ChatUpdatedV1Handler(handler func(context.Context, *P2ChatUpdatedV1) error) *P2ChatUpdatedV1Handler

func (*P2ChatUpdatedV1Handler) Event

func (h *P2ChatUpdatedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2ChatUpdatedV1Handler) Handle

func (h *P2ChatUpdatedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2MessageReactionCreatedV1

type P2MessageReactionCreatedV1 struct {
	*larkevent.EventV2Base                                 // 事件基础数据
	*larkevent.EventReq                                    // 请求原生数据
	Event                  *P2MessageReactionCreatedV1Data `json:"event"` // 事件内容
}

func (*P2MessageReactionCreatedV1) RawReq

func (m *P2MessageReactionCreatedV1) RawReq(req *larkevent.EventReq)

type P2MessageReactionCreatedV1Data

type P2MessageReactionCreatedV1Data struct {
	MessageId    *string `json:"message_id,omitempty"`    // 消息的 open_message_id
	ReactionType *Emoji  `json:"reaction_type,omitempty"` // 表情回复的资源类型
	OperatorType *string `json:"operator_type,omitempty"` // 操作人类型;;注意事项:;- 如果操作人类型是"user",则会返回 ==user_id==;- 如果操作人类型是"app",则会返回 ==app_id==
	UserId       *UserId `json:"user_id,omitempty"`       // 用户 ID
	AppId        *string `json:"app_id,omitempty"`        // 应用 ID
	ActionTime   *string `json:"action_time,omitempty"`   // 添加表情回复时间戳(单位:ms)
}

type P2MessageReactionCreatedV1Handler

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

消息处理器定义

func (*P2MessageReactionCreatedV1Handler) Event

func (h *P2MessageReactionCreatedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2MessageReactionCreatedV1Handler) Handle

func (h *P2MessageReactionCreatedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2MessageReactionDeletedV1

type P2MessageReactionDeletedV1 struct {
	*larkevent.EventV2Base                                 // 事件基础数据
	*larkevent.EventReq                                    // 请求原生数据
	Event                  *P2MessageReactionDeletedV1Data `json:"event"` // 事件内容
}

func (*P2MessageReactionDeletedV1) RawReq

func (m *P2MessageReactionDeletedV1) RawReq(req *larkevent.EventReq)

type P2MessageReactionDeletedV1Data

type P2MessageReactionDeletedV1Data struct {
	MessageId    *string `json:"message_id,omitempty"`    // 消息的 open_message_id
	ReactionType *Emoji  `json:"reaction_type,omitempty"` // 表情回复的资源类型
	OperatorType *string `json:"operator_type,omitempty"` // 操作人类型;;注意事项:;- 如果操作人类型是"user",则会返回 ==user_id==;- 如果操作人类型是"app",则会返回 ==app_id==
	UserId       *UserId `json:"user_id,omitempty"`       // 用户 ID
	AppId        *string `json:"app_id,omitempty"`        // 应用 ID
	ActionTime   *string `json:"action_time,omitempty"`   // 表情回复被添加时的时间戳(单位:ms)
}

type P2MessageReactionDeletedV1Handler

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

消息处理器定义

func (*P2MessageReactionDeletedV1Handler) Event

func (h *P2MessageReactionDeletedV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2MessageReactionDeletedV1Handler) Handle

func (h *P2MessageReactionDeletedV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2MessageReadV1

type P2MessageReadV1 struct {
	*larkevent.EventV2Base                      // 事件基础数据
	*larkevent.EventReq                         // 请求原生数据
	Event                  *P2MessageReadV1Data `json:"event"` // 事件内容
}

func (*P2MessageReadV1) RawReq

func (m *P2MessageReadV1) RawReq(req *larkevent.EventReq)

type P2MessageReadV1Data

type P2MessageReadV1Data struct {
	Reader        *EventMessageReader `json:"reader,omitempty"`          // -
	MessageIdList []string            `json:"message_id_list,omitempty"` // 消息列表
}

type P2MessageReadV1Handler

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

消息处理器定义

func NewP2MessageReadV1Handler

func NewP2MessageReadV1Handler(handler func(context.Context, *P2MessageReadV1) error) *P2MessageReadV1Handler

func (*P2MessageReadV1Handler) Event

func (h *P2MessageReadV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2MessageReadV1Handler) Handle

func (h *P2MessageReadV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2MessageRecalledV1 added in v3.0.10

type P2MessageRecalledV1 struct {
	*larkevent.EventV2Base                          // 事件基础数据
	*larkevent.EventReq                             // 请求原生数据
	Event                  *P2MessageRecalledV1Data `json:"event"` // 事件内容
}

func (*P2MessageRecalledV1) RawReq added in v3.0.10

func (m *P2MessageRecalledV1) RawReq(req *larkevent.EventReq)

type P2MessageRecalledV1Data added in v3.0.10

type P2MessageRecalledV1Data struct {
	MessageId  *string `json:"message_id,omitempty"`  // 消息ID
	ChatId     *string `json:"chat_id,omitempty"`     // 群ID
	RecallTime *string `json:"recall_time,omitempty"` // 撤回事件
	RecallType *string `json:"recall_type,omitempty"` // 撤回类型
}

type P2MessageRecalledV1Handler added in v3.0.10

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

消息处理器定义

func NewP2MessageRecalledV1Handler added in v3.0.10

func NewP2MessageRecalledV1Handler(handler func(context.Context, *P2MessageRecalledV1) error) *P2MessageRecalledV1Handler

func (*P2MessageRecalledV1Handler) Event added in v3.0.10

func (h *P2MessageRecalledV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2MessageRecalledV1Handler) Handle added in v3.0.10

func (h *P2MessageRecalledV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type P2MessageReceiveV1

type P2MessageReceiveV1 struct {
	*larkevent.EventV2Base                         // 事件基础数据
	*larkevent.EventReq                            // 请求原生数据
	Event                  *P2MessageReceiveV1Data `json:"event"` // 事件内容
}

func (*P2MessageReceiveV1) RawReq

func (m *P2MessageReceiveV1) RawReq(req *larkevent.EventReq)

type P2MessageReceiveV1Data

type P2MessageReceiveV1Data struct {
	Sender  *EventSender  `json:"sender,omitempty"`  // 事件的发送者
	Message *EventMessage `json:"message,omitempty"` // 事件中包含的消息内容
}

type P2MessageReceiveV1Handler

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

消息处理器定义

func NewP2MessageReceiveV1Handler

func NewP2MessageReceiveV1Handler(handler func(context.Context, *P2MessageReceiveV1) error) *P2MessageReceiveV1Handler

func (*P2MessageReceiveV1Handler) Event

func (h *P2MessageReceiveV1Handler) Event() interface{}

返回事件的消息体的实例,用于反序列化用

func (*P2MessageReceiveV1Handler) Handle

func (h *P2MessageReceiveV1Handler) Handle(ctx context.Context, event interface{}) error

回调开发者注册的handle

type PatchChatAnnouncementPathReqBodyBuilder

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

func NewPatchChatAnnouncementPathReqBodyBuilder

func NewPatchChatAnnouncementPathReqBodyBuilder() *PatchChatAnnouncementPathReqBodyBuilder

func (*PatchChatAnnouncementPathReqBodyBuilder) Build

func (*PatchChatAnnouncementPathReqBodyBuilder) Requests

修改文档请求的序列化字段;;更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同

示例值:{\"requestType\":\"InsertBlocksRequestType\",\"insertBlocksRequest\":{\"payload\":\"{\\\"blocks\\\":[{\\\"type\\\":\\\"paragraph\\\",\\\"paragraph\\\":{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"ylyyyyyDocs API Sample Content\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}}]}\",\"location\":{\"zoneId\":\"0\",\"index\":0, \"endOfZone\": true}}}

func (*PatchChatAnnouncementPathReqBodyBuilder) Revision

文档当前版本号 int64 类型,[获取群公告信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get)接口会返回

示例值:12

type PatchChatAnnouncementReq

type PatchChatAnnouncementReq struct {
	Body *PatchChatAnnouncementReqBody `body:""`
	// contains filtered or unexported fields
}

type PatchChatAnnouncementReqBody

type PatchChatAnnouncementReqBody struct {
	Revision *string  `json:"revision,omitempty"` // 文档当前版本号 int64 类型,[获取群公告信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get)接口会返回
	Requests []string `json:"requests,omitempty"` // 修改文档请求的序列化字段;;更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同
}

type PatchChatAnnouncementReqBodyBuilder

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

func NewPatchChatAnnouncementReqBodyBuilder

func NewPatchChatAnnouncementReqBodyBuilder() *PatchChatAnnouncementReqBodyBuilder

func (*PatchChatAnnouncementReqBodyBuilder) Build

func (*PatchChatAnnouncementReqBodyBuilder) Requests

修改文档请求的序列化字段;;更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同

示例值:{\"requestType\":\"InsertBlocksRequestType\",\"insertBlocksRequest\":{\"payload\":\"{\\\"blocks\\\":[{\\\"type\\\":\\\"paragraph\\\",\\\"paragraph\\\":{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"ylyyyyyDocs API Sample Content\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}}]}\",\"location\":{\"zoneId\":\"0\",\"index\":0, \"endOfZone\": true}}}

func (*PatchChatAnnouncementReqBodyBuilder) Revision

文档当前版本号 int64 类型,[获取群公告信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get)接口会返回

示例值:12

type PatchChatAnnouncementReqBuilder

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

func NewPatchChatAnnouncementReqBuilder

func NewPatchChatAnnouncementReqBuilder() *PatchChatAnnouncementReqBuilder

func (*PatchChatAnnouncementReqBuilder) Body

更新会话中的群公告信息,更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。

func (*PatchChatAnnouncementReqBuilder) Build

func (*PatchChatAnnouncementReqBuilder) ChatId

待修改公告的群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:不支持P2P单聊

示例值:oc_5ad11d72b830411d72b836c20

type PatchChatAnnouncementResp

type PatchChatAnnouncementResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*PatchChatAnnouncementResp) Success

func (resp *PatchChatAnnouncementResp) Success() bool

type PatchChatMenuItemPathReqBodyBuilder added in v3.0.13

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

func NewPatchChatMenuItemPathReqBodyBuilder added in v3.0.13

func NewPatchChatMenuItemPathReqBodyBuilder() *PatchChatMenuItemPathReqBodyBuilder

func (*PatchChatMenuItemPathReqBodyBuilder) Build added in v3.0.13

func (*PatchChatMenuItemPathReqBodyBuilder) ChatMenuItem added in v3.0.13

元信息

示例值:

func (*PatchChatMenuItemPathReqBodyBuilder) UpdateFields added in v3.0.13

要修改的字段

示例值:["ICON"]

type PatchChatMenuItemReq added in v3.0.13

type PatchChatMenuItemReq struct {
	Body *PatchChatMenuItemReqBody `body:""`
	// contains filtered or unexported fields
}

type PatchChatMenuItemReqBody added in v3.0.13

type PatchChatMenuItemReqBody struct {
	UpdateFields []string      `json:"update_fields,omitempty"`  // 要修改的字段
	ChatMenuItem *ChatMenuItem `json:"chat_menu_item,omitempty"` // 元信息
}

type PatchChatMenuItemReqBodyBuilder added in v3.0.13

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

func NewPatchChatMenuItemReqBodyBuilder added in v3.0.13

func NewPatchChatMenuItemReqBodyBuilder() *PatchChatMenuItemReqBodyBuilder

func (*PatchChatMenuItemReqBodyBuilder) Build added in v3.0.13

func (*PatchChatMenuItemReqBodyBuilder) ChatMenuItem added in v3.0.13

元信息

示例值:

func (*PatchChatMenuItemReqBodyBuilder) UpdateFields added in v3.0.13

func (builder *PatchChatMenuItemReqBodyBuilder) UpdateFields(updateFields []string) *PatchChatMenuItemReqBodyBuilder

要修改的字段

示例值:["ICON"]

type PatchChatMenuItemReqBuilder added in v3.0.13

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

func NewPatchChatMenuItemReqBuilder added in v3.0.13

func NewPatchChatMenuItemReqBuilder() *PatchChatMenuItemReqBuilder

func (*PatchChatMenuItemReqBuilder) Body added in v3.0.13

修改某个一级菜单或者二级菜单的元信息。

func (*PatchChatMenuItemReqBuilder) Build added in v3.0.13

func (*PatchChatMenuItemReqBuilder) ChatId added in v3.0.13

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*PatchChatMenuItemReqBuilder) MenuItemId added in v3.0.13

func (builder *PatchChatMenuItemReqBuilder) MenuItemId(menuItemId string) *PatchChatMenuItemReqBuilder

一级或二级菜单ID,通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口通过群ID获取菜单ID。

示例值:7156553273518882844

type PatchChatMenuItemResp added in v3.0.13

type PatchChatMenuItemResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *PatchChatMenuItemRespData `json:"data"` // 业务数据
}

func (*PatchChatMenuItemResp) Success added in v3.0.13

func (resp *PatchChatMenuItemResp) Success() bool

type PatchChatMenuItemRespData added in v3.0.13

type PatchChatMenuItemRespData struct {
	ChatMenuItem *ChatMenuItem `json:"chat_menu_item,omitempty"` // 修改后的菜单元信息
}

type PatchMessagePathReqBodyBuilder

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

func NewPatchMessagePathReqBodyBuilder

func NewPatchMessagePathReqBodyBuilder() *PatchMessagePathReqBodyBuilder

func (*PatchMessagePathReqBodyBuilder) Build

func (*PatchMessagePathReqBodyBuilder) Content

消息内容 json 格式,[发送消息 content 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式

示例值:参考链接

type PatchMessageReq

type PatchMessageReq struct {
	Body *PatchMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type PatchMessageReqBody

type PatchMessageReqBody struct {
	Content *string `json:"content,omitempty"` // 消息内容 json 格式,[发送消息 content 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式
}

type PatchMessageReqBodyBuilder

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

func NewPatchMessageReqBodyBuilder

func NewPatchMessageReqBodyBuilder() *PatchMessageReqBodyBuilder

func (*PatchMessageReqBodyBuilder) Build

func (*PatchMessageReqBodyBuilder) Content

消息内容 json 格式,[发送消息 content 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式

示例值:参考链接

type PatchMessageReqBuilder

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

func NewPatchMessageReqBuilder

func NewPatchMessageReqBuilder() *PatchMessageReqBuilder

func (*PatchMessageReqBuilder) Body

更新应用已发送的消息卡片内容。

func (*PatchMessageReqBuilder) Build

func (builder *PatchMessageReqBuilder) Build() *PatchMessageReq

func (*PatchMessageReqBuilder) MessageId

func (builder *PatchMessageReqBuilder) MessageId(messageId string) *PatchMessageReqBuilder

待更新的消息的ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

type PatchMessageResp

type PatchMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*PatchMessageResp) Success

func (resp *PatchMessageResp) Success() bool

type Pin added in v3.0.1

type Pin struct {
	MessageId      *string `json:"message_id,omitempty"`       // Pin的消息ID
	ChatId         *string `json:"chat_id,omitempty"`          // Pin消息所在的群聊ID
	OperatorId     *string `json:"operator_id,omitempty"`      // Pin的操作人ID
	OperatorIdType *string `json:"operator_id_type,omitempty"` // Pin的操作人ID类型。当Pin的操作人为用户时,为==open_id==;当Pin的操作人为机器人时,为==app_id==
	CreateTime     *string `json:"create_time,omitempty"`      // Pin的创建时间(毫秒级时间戳)
}

type PinBuilder added in v3.0.1

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

func NewPinBuilder added in v3.0.1

func NewPinBuilder() *PinBuilder

func (*PinBuilder) Build added in v3.0.1

func (builder *PinBuilder) Build() *Pin

func (*PinBuilder) ChatId added in v3.0.1

func (builder *PinBuilder) ChatId(chatId string) *PinBuilder

Pin消息所在的群聊ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*PinBuilder) CreateTime added in v3.0.1

func (builder *PinBuilder) CreateTime(createTime string) *PinBuilder

Pin的创建时间(毫秒级时间戳)

示例值:1615380573211

func (*PinBuilder) MessageId added in v3.0.1

func (builder *PinBuilder) MessageId(messageId string) *PinBuilder

Pin的消息ID

示例值:om_dc13264520392913993dd051dba21dcf

func (*PinBuilder) OperatorId added in v3.0.1

func (builder *PinBuilder) OperatorId(operatorId string) *PinBuilder

Pin的操作人ID

示例值:ou_7d8a6e6df7621556ce0d21922b676706ccs

func (*PinBuilder) OperatorIdType added in v3.0.1

func (builder *PinBuilder) OperatorIdType(operatorIdType string) *PinBuilder

Pin的操作人ID类型。当Pin的操作人为用户时,为==open_id==;当Pin的操作人为机器人时,为==app_id==

示例值:open_id

type PinedMessage added in v3.0.1

type PinedMessage struct {
	Pin     *Pin     `json:"pin,omitempty"`     // Pin的操作信息
	Message *Message `json:"message,omitempty"` // 被Pin的消息实体
}

type PinedMessageBuilder added in v3.0.1

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

func NewPinedMessageBuilder added in v3.0.1

func NewPinedMessageBuilder() *PinedMessageBuilder

func (*PinedMessageBuilder) Build added in v3.0.1

func (builder *PinedMessageBuilder) Build() *PinedMessage

func (*PinedMessageBuilder) Message added in v3.0.1

func (builder *PinedMessageBuilder) Message(message *Message) *PinedMessageBuilder

被Pin的消息实体

示例值:

func (*PinedMessageBuilder) Pin added in v3.0.1

func (builder *PinedMessageBuilder) Pin(pin *Pin) *PinedMessageBuilder

Pin的操作信息

示例值:

type PutTopNoticeChatTopNoticePathReqBodyBuilder

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

func NewPutTopNoticeChatTopNoticePathReqBodyBuilder

func NewPutTopNoticeChatTopNoticePathReqBodyBuilder() *PutTopNoticeChatTopNoticePathReqBodyBuilder

func (*PutTopNoticeChatTopNoticePathReqBodyBuilder) Build

func (*PutTopNoticeChatTopNoticePathReqBodyBuilder) ChatTopNotice

要进行发布的群置顶

示例值:

type PutTopNoticeChatTopNoticeReq

type PutTopNoticeChatTopNoticeReq struct {
	Body *PutTopNoticeChatTopNoticeReqBody `body:""`
	// contains filtered or unexported fields
}

type PutTopNoticeChatTopNoticeReqBody

type PutTopNoticeChatTopNoticeReqBody struct {
	ChatTopNotice []*ChatTopNotice `json:"chat_top_notice,omitempty"` // 要进行发布的群置顶
}

type PutTopNoticeChatTopNoticeReqBodyBuilder

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

func NewPutTopNoticeChatTopNoticeReqBodyBuilder

func NewPutTopNoticeChatTopNoticeReqBodyBuilder() *PutTopNoticeChatTopNoticeReqBodyBuilder

func (*PutTopNoticeChatTopNoticeReqBodyBuilder) Build

func (*PutTopNoticeChatTopNoticeReqBodyBuilder) ChatTopNotice

要进行发布的群置顶

示例值:

type PutTopNoticeChatTopNoticeReqBuilder

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

func NewPutTopNoticeChatTopNoticeReqBuilder

func NewPutTopNoticeChatTopNoticeReqBuilder() *PutTopNoticeChatTopNoticeReqBuilder

func (*PutTopNoticeChatTopNoticeReqBuilder) Body

更新会话中的群置顶信息,可以将群中的某一条消息,或者群公告置顶显示。

func (*PutTopNoticeChatTopNoticeReqBuilder) Build

func (*PutTopNoticeChatTopNoticeReqBuilder) ChatId

待修改置顶的群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_5ad11d72b830411d72b836c20

type PutTopNoticeChatTopNoticeResp

type PutTopNoticeChatTopNoticeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*PutTopNoticeChatTopNoticeResp) Success

func (resp *PutTopNoticeChatTopNoticeResp) Success() bool

type ReadUser

type ReadUser struct {
	UserIdType *string `json:"user_id_type,omitempty"` // 用户id类型
	UserId     *string `json:"user_id,omitempty"`      // 用户id
	Timestamp  *string `json:"timestamp,omitempty"`    // 阅读时间
	TenantKey  *string `json:"tenant_key,omitempty"`   // tenant key
}

type ReadUserBatchMessageReq

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

type ReadUserBatchMessageReqBuilder

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

func NewReadUserBatchMessageReqBuilder

func NewReadUserBatchMessageReqBuilder() *ReadUserBatchMessageReqBuilder

func (*ReadUserBatchMessageReqBuilder) BatchMessageId

func (builder *ReadUserBatchMessageReqBuilder) BatchMessageId(batchMessageId string) *ReadUserBatchMessageReqBuilder

待查询的批量消息的ID,通过调用[批量发送消息接口]( https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)的返回值中得到

示例值:bm_dc13264520392913993dd051dba21dcf

func (*ReadUserBatchMessageReqBuilder) Build

type ReadUserBatchMessageResp

type ReadUserBatchMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ReadUserBatchMessageRespData `json:"data"` // 业务数据
}

func (*ReadUserBatchMessageResp) Success

func (resp *ReadUserBatchMessageResp) Success() bool

type ReadUserBatchMessageRespData

type ReadUserBatchMessageRespData struct {
	ReadUser *BatchMessageReadUser `json:"read_user,omitempty"` // 批量发送消息的用户阅读情况
}

type ReadUserBuilder

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

func NewReadUserBuilder

func NewReadUserBuilder() *ReadUserBuilder

func (*ReadUserBuilder) Build

func (builder *ReadUserBuilder) Build() *ReadUser

func (*ReadUserBuilder) TenantKey

func (builder *ReadUserBuilder) TenantKey(tenantKey string) *ReadUserBuilder

tenant key

示例值:736588c9260f175e

func (*ReadUserBuilder) Timestamp

func (builder *ReadUserBuilder) Timestamp(timestamp string) *ReadUserBuilder

阅读时间

示例值:1609484183000

func (*ReadUserBuilder) UserId

func (builder *ReadUserBuilder) UserId(userId string) *ReadUserBuilder

用户id

示例值:ou_9b851f7b51a9d58d109982337c46f3de

func (*ReadUserBuilder) UserIdType

func (builder *ReadUserBuilder) UserIdType(userIdType string) *ReadUserBuilder

用户id类型

示例值:open_id

type ReadUsersMessageReq

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

type ReadUsersMessageReqBuilder

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

func NewReadUsersMessageReqBuilder

func NewReadUsersMessageReqBuilder() *ReadUsersMessageReqBuilder

func (*ReadUsersMessageReqBuilder) Build

func (*ReadUsersMessageReqBuilder) MessageId

func (builder *ReadUsersMessageReqBuilder) MessageId(messageId string) *ReadUsersMessageReqBuilder

待查询的消息的ID,说明参见:[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2);;**注意**:不支持查询批量消息

示例值:om_dc13264520392913993dd051dba21dcf

func (*ReadUsersMessageReqBuilder) PageSize

func (builder *ReadUsersMessageReqBuilder) PageSize(pageSize int) *ReadUsersMessageReqBuilder

此次调用中使用的分页的大小

示例值:20

func (*ReadUsersMessageReqBuilder) PageToken

func (builder *ReadUsersMessageReqBuilder) PageToken(pageToken string) *ReadUsersMessageReqBuilder

下一页分页的token

示例值:GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==

func (*ReadUsersMessageReqBuilder) UserIdType

func (builder *ReadUsersMessageReqBuilder) UserIdType(userIdType string) *ReadUsersMessageReqBuilder

此次调用中使用的用户ID的类型

示例值:

type ReadUsersMessageResp

type ReadUsersMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ReadUsersMessageRespData `json:"data"` // 业务数据
}

func (*ReadUsersMessageResp) Success

func (resp *ReadUsersMessageResp) Success() bool

type ReadUsersMessageRespData

type ReadUsersMessageRespData struct {
	Items     []*ReadUser `json:"items,omitempty"`      // -
	HasMore   *bool       `json:"has_more,omitempty"`   // 是否还有下一页
	PageToken *string     `json:"page_token,omitempty"` // 下一页分页的token
}

type ReplyMessagePathReqBodyBuilder

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

func NewReplyMessagePathReqBodyBuilder

func NewReplyMessagePathReqBodyBuilder() *ReplyMessagePathReqBodyBuilder

func (*ReplyMessagePathReqBodyBuilder) Build

func (*ReplyMessagePathReqBodyBuilder) Content

消息内容 json 格式,格式说明参考: [发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)

示例值:{\"text\":\"<at user_id=\\\"ou_155184d1e73cbfb8973e5a9e698e74f2\\\">Tom </at> test content\"}

func (*ReplyMessagePathReqBodyBuilder) MsgType

消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user

示例值:text

func (*ReplyMessagePathReqBodyBuilder) Uuid added in v3.0.1

由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次

示例值:a0d69e20-1dd1-458b-k525-dfeca4015204

type ReplyMessageReq

type ReplyMessageReq struct {
	Body *ReplyMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type ReplyMessageReqBody

type ReplyMessageReqBody struct {
	Content *string `json:"content,omitempty"`  // 消息内容 json 格式,格式说明参考: [发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)
	MsgType *string `json:"msg_type,omitempty"` // 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user
	Uuid    *string `json:"uuid,omitempty"`     // 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次
}

type ReplyMessageReqBodyBuilder

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

func NewReplyMessageReqBodyBuilder

func NewReplyMessageReqBodyBuilder() *ReplyMessageReqBodyBuilder

func (*ReplyMessageReqBodyBuilder) Build

func (*ReplyMessageReqBodyBuilder) Content

消息内容 json 格式,格式说明参考: [发送消息Content](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)

示例值:{\"text\":\"<at user_id=\\\"ou_155184d1e73cbfb8973e5a9e698e74f2\\\">Tom </at> test content\"}

func (*ReplyMessageReqBodyBuilder) MsgType

消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user

示例值:text

func (*ReplyMessageReqBodyBuilder) Uuid added in v3.0.1

由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次

示例值:a0d69e20-1dd1-458b-k525-dfeca4015204

type ReplyMessageReqBuilder

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

func NewReplyMessageReqBuilder

func NewReplyMessageReqBuilder() *ReplyMessageReqBuilder

func (*ReplyMessageReqBuilder) Body

回复指定消息,支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。

func (*ReplyMessageReqBuilder) Build

func (builder *ReplyMessageReqBuilder) Build() *ReplyMessageReq

func (*ReplyMessageReqBuilder) MessageId

func (builder *ReplyMessageReqBuilder) MessageId(messageId string) *ReplyMessageReqBuilder

待回复的消息的ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)

示例值:om_dc13264520392913993dd051dba21dcf

type ReplyMessageResp

type ReplyMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ReplyMessageRespData `json:"data"` // 业务数据
}

func (*ReplyMessageResp) Success

func (resp *ReplyMessageResp) Success() bool

type ReplyMessageRespData

type ReplyMessageRespData struct {
	MessageId      *string      `json:"message_id,omitempty"`       // 消息id open_message_id
	RootId         *string      `json:"root_id,omitempty"`          // 根消息id open_message_id
	ParentId       *string      `json:"parent_id,omitempty"`        // 父消息的id open_message_id
	MsgType        *string      `json:"msg_type,omitempty"`         // 消息类型 text post card image等等
	CreateTime     *string      `json:"create_time,omitempty"`      // 消息生成的时间戳(毫秒)
	UpdateTime     *string      `json:"update_time,omitempty"`      // 消息更新的时间戳
	Deleted        *bool        `json:"deleted,omitempty"`          // 消息是否被撤回
	Updated        *bool        `json:"updated,omitempty"`          // 消息是否被更新
	ChatId         *string      `json:"chat_id,omitempty"`          // 所属的群
	Sender         *Sender      `json:"sender,omitempty"`           // 发送者,可以是用户或应用
	Body           *MessageBody `json:"body,omitempty"`             // 消息内容,json结构
	Mentions       []*Mention   `json:"mentions,omitempty"`         // 被艾特的人或应用的id
	UpperMessageId *string      `json:"upper_message_id,omitempty"` // 合并消息的上一层级消息id open_message_id
}

type RestrictedModeSetting added in v3.0.20

type RestrictedModeSetting struct {
	Status                         *bool   `json:"status,omitempty"`                            // 防泄密模式是否开启
	ScreenshotHasPermissionSetting *string `json:"screenshot_has_permission_setting,omitempty"` // 允许截屏录屏
	DownloadHasPermissionSetting   *string `json:"download_has_permission_setting,omitempty"`   // 允许下载消息中图片、视频和文件
	MessageHasPermissionSetting    *string `json:"message_has_permission_setting,omitempty"`    // 允许复制和转发消息
}

type RestrictedModeSettingBuilder added in v3.0.20

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

func NewRestrictedModeSettingBuilder added in v3.0.20

func NewRestrictedModeSettingBuilder() *RestrictedModeSettingBuilder

func (*RestrictedModeSettingBuilder) Build added in v3.0.20

func (*RestrictedModeSettingBuilder) DownloadHasPermissionSetting added in v3.0.20

func (builder *RestrictedModeSettingBuilder) DownloadHasPermissionSetting(downloadHasPermissionSetting string) *RestrictedModeSettingBuilder

允许下载消息中图片、视频和文件

示例值:all_members

func (*RestrictedModeSettingBuilder) MessageHasPermissionSetting added in v3.0.20

func (builder *RestrictedModeSettingBuilder) MessageHasPermissionSetting(messageHasPermissionSetting string) *RestrictedModeSettingBuilder

允许复制和转发消息

示例值:all_members

func (*RestrictedModeSettingBuilder) ScreenshotHasPermissionSetting added in v3.0.20

func (builder *RestrictedModeSettingBuilder) ScreenshotHasPermissionSetting(screenshotHasPermissionSetting string) *RestrictedModeSettingBuilder

允许截屏录屏

示例值:all_members

func (*RestrictedModeSettingBuilder) Status added in v3.0.20

防泄密模式是否开启

示例值:true

type SearchChatIterator

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

func (*SearchChatIterator) Next

func (iterator *SearchChatIterator) Next() (bool, *ListChat, error)

func (*SearchChatIterator) NextPageToken

func (iterator *SearchChatIterator) NextPageToken() *string

type SearchChatReq

type SearchChatReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type SearchChatReqBuilder

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

func NewSearchChatReqBuilder

func NewSearchChatReqBuilder() *SearchChatReqBuilder

func (*SearchChatReqBuilder) Build

func (builder *SearchChatReqBuilder) Build() *SearchChatReq

func (*SearchChatReqBuilder) Limit

func (builder *SearchChatReqBuilder) Limit(limit int) *SearchChatReqBuilder

最大返回多少记录,当使用迭代器访问时才有效

func (*SearchChatReqBuilder) PageSize

func (builder *SearchChatReqBuilder) PageSize(pageSize int) *SearchChatReqBuilder

分页大小

示例值:10

func (*SearchChatReqBuilder) PageToken

func (builder *SearchChatReqBuilder) PageToken(pageToken string) *SearchChatReqBuilder

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该page_token 获取查询结果

示例值:dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==

func (*SearchChatReqBuilder) Query

func (builder *SearchChatReqBuilder) Query(query string) *SearchChatReqBuilder

关键词;;**注意事项**:;- 关键词支持匹配群国际化名称、群成员名称;- 支持使用多语种搜索;- 支持拼音、前缀等模糊搜索;- 关键词为空值或长度超过`64`个字符时将返回空的结果

示例值:abc

func (*SearchChatReqBuilder) UserIdType

func (builder *SearchChatReqBuilder) UserIdType(userIdType string) *SearchChatReqBuilder

此次调用中使用的用户ID的类型

示例值:

type SearchChatResp

type SearchChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *SearchChatRespData `json:"data"` // 业务数据
}

func (*SearchChatResp) Success

func (resp *SearchChatResp) Success() bool

type SearchChatRespData

type SearchChatRespData struct {
	Items     []*ListChat `json:"items,omitempty"`      // chat 列表
	PageToken *string     `json:"page_token,omitempty"` // 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
	HasMore   *bool       `json:"has_more,omitempty"`   // 是否还有更多群组
}

type Sender

type Sender struct {
	Id         *string `json:"id,omitempty"`          // 该字段标识发送者的id
	IdType     *string `json:"id_type,omitempty"`     // 该字段标识发送者的id类型;;**可选值有:**;- `open_id`;- `app_id`
	SenderType *string `json:"sender_type,omitempty"` // 该字段标识发送者的类型;;**可选值有:**;- `user`: 用户;- `app`: 应用;- `anonymous`: 匿名;- `unknown`: 未知
	TenantKey  *string `json:"tenant_key,omitempty"`  // 为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
}

type SenderBuilder

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

func NewSenderBuilder

func NewSenderBuilder() *SenderBuilder

func (*SenderBuilder) Build

func (builder *SenderBuilder) Build() *Sender

func (*SenderBuilder) Id

func (builder *SenderBuilder) Id(id string) *SenderBuilder

该字段标识发送者的id

示例值:cli_9f427eec54ae901b

func (*SenderBuilder) IdType

func (builder *SenderBuilder) IdType(idType string) *SenderBuilder

该字段标识发送者的id类型;;**可选值有:**;- `open_id`;- `app_id`

示例值:app_id

func (*SenderBuilder) SenderType

func (builder *SenderBuilder) SenderType(senderType string) *SenderBuilder

该字段标识发送者的类型;;**可选值有:**;- `user`: 用户;- `app`: 应用;- `anonymous`: 匿名;- `unknown`: 未知

示例值:app

func (*SenderBuilder) TenantKey

func (builder *SenderBuilder) TenantKey(tenantKey string) *SenderBuilder

为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识

示例值:736588c9260f175e

type SortChatMenuTreePathReqBodyBuilder added in v3.0.13

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

func NewSortChatMenuTreePathReqBodyBuilder added in v3.0.13

func NewSortChatMenuTreePathReqBodyBuilder() *SortChatMenuTreePathReqBodyBuilder

func (*SortChatMenuTreePathReqBodyBuilder) Build added in v3.0.13

func (*SortChatMenuTreePathReqBodyBuilder) ChatMenuTopLevelIds added in v3.0.13

func (builder *SortChatMenuTreePathReqBodyBuilder) ChatMenuTopLevelIds(chatMenuTopLevelIds []string) *SortChatMenuTreePathReqBodyBuilder

新的一级菜单的顺序,进行排序ID列表需要跟群内目前存在的一级菜单ID列表对齐。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。

示例值:7156553273518882844

type SortChatMenuTreeReq added in v3.0.13

type SortChatMenuTreeReq struct {
	Body *SortChatMenuTreeReqBody `body:""`
	// contains filtered or unexported fields
}

type SortChatMenuTreeReqBody added in v3.0.13

type SortChatMenuTreeReqBody struct {
	ChatMenuTopLevelIds []string `json:"chat_menu_top_level_ids,omitempty"` // 新的一级菜单的顺序,进行排序ID列表需要跟群内目前存在的一级菜单ID列表对齐。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。
}

type SortChatMenuTreeReqBodyBuilder added in v3.0.13

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

func NewSortChatMenuTreeReqBodyBuilder added in v3.0.13

func NewSortChatMenuTreeReqBodyBuilder() *SortChatMenuTreeReqBodyBuilder

func (*SortChatMenuTreeReqBodyBuilder) Build added in v3.0.13

func (*SortChatMenuTreeReqBodyBuilder) ChatMenuTopLevelIds added in v3.0.13

func (builder *SortChatMenuTreeReqBodyBuilder) ChatMenuTopLevelIds(chatMenuTopLevelIds []string) *SortChatMenuTreeReqBodyBuilder

新的一级菜单的顺序,进行排序ID列表需要跟群内目前存在的一级菜单ID列表对齐。通过 [获取群菜单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) 接口获取群内菜单详情。

示例值:7156553273518882844

type SortChatMenuTreeReqBuilder added in v3.0.13

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

func NewSortChatMenuTreeReqBuilder added in v3.0.13

func NewSortChatMenuTreeReqBuilder() *SortChatMenuTreeReqBuilder

func (*SortChatMenuTreeReqBuilder) Body added in v3.0.13

给一个群内的一级菜单排序。

func (*SortChatMenuTreeReqBuilder) Build added in v3.0.13

func (*SortChatMenuTreeReqBuilder) ChatId added in v3.0.13

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type SortChatMenuTreeResp added in v3.0.13

type SortChatMenuTreeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *SortChatMenuTreeRespData `json:"data"` // 业务数据
}

func (*SortChatMenuTreeResp) Success added in v3.0.13

func (resp *SortChatMenuTreeResp) Success() bool

type SortChatMenuTreeRespData added in v3.0.13

type SortChatMenuTreeRespData struct {
	MenuTree *ChatMenuTree `json:"menu_tree,omitempty"` // 排序后群内菜单
}

type SortTabsChatTabPathReqBodyBuilder

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

func NewSortTabsChatTabPathReqBodyBuilder

func NewSortTabsChatTabPathReqBodyBuilder() *SortTabsChatTabPathReqBodyBuilder

func (*SortTabsChatTabPathReqBodyBuilder) Build

func (*SortTabsChatTabPathReqBodyBuilder) TabIds

会话标签页ID列表,Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取;;**注意**:必须包含该会话中全部的Tab ID

示例值:["7101214603622940671", "7101214603622940672"]

type SortTabsChatTabReq

type SortTabsChatTabReq struct {
	Body *SortTabsChatTabReqBody `body:""`
	// contains filtered or unexported fields
}

type SortTabsChatTabReqBody

type SortTabsChatTabReqBody struct {
	TabIds []string `json:"tab_ids,omitempty"` // 会话标签页ID列表,Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取;;**注意**:必须包含该会话中全部的Tab ID
}

type SortTabsChatTabReqBodyBuilder

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

func NewSortTabsChatTabReqBodyBuilder

func NewSortTabsChatTabReqBodyBuilder() *SortTabsChatTabReqBodyBuilder

func (*SortTabsChatTabReqBodyBuilder) Build

func (*SortTabsChatTabReqBodyBuilder) TabIds

会话标签页ID列表,Tab ID可以在[添加会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create)与[拉取会话标签页](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs)的返回值中获取;;**注意**:必须包含该会话中全部的Tab ID

示例值:["7101214603622940671", "7101214603622940672"]

type SortTabsChatTabReqBuilder

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

func NewSortTabsChatTabReqBuilder

func NewSortTabsChatTabReqBuilder() *SortTabsChatTabReqBuilder

func (*SortTabsChatTabReqBuilder) Body

会话标签页排序。

func (*SortTabsChatTabReqBuilder) Build

func (*SortTabsChatTabReqBuilder) ChatId

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:支持群模式为`p2p`与`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type SortTabsChatTabResp

type SortTabsChatTabResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *SortTabsChatTabRespData `json:"data"` // 业务数据
}

func (*SortTabsChatTabResp) Success

func (resp *SortTabsChatTabResp) Success() bool

type SortTabsChatTabRespData

type SortTabsChatTabRespData struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 会话标签页
}

type SpecialFocus

type SpecialFocus struct {
	Id     *string `json:"id,omitempty"`      // 成员ID
	IdType *string `json:"id_type,omitempty"` // 成员ID类型。根据member_id_type参数返回`open_id`、`user_id`或`union_id`类型的用户ID;机器人返回`app_id`
}

type SpecialFocusBuilder

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

func NewSpecialFocusBuilder

func NewSpecialFocusBuilder() *SpecialFocusBuilder

func (*SpecialFocusBuilder) Build

func (builder *SpecialFocusBuilder) Build() *SpecialFocus

func (*SpecialFocusBuilder) Id

成员ID

示例值:ou_155184d1e73cbfb8973e5a9e698e74f2

func (*SpecialFocusBuilder) IdType

func (builder *SpecialFocusBuilder) IdType(idType string) *SpecialFocusBuilder

成员ID类型。根据member_id_type参数返回`open_id`、`user_id`或`union_id`类型的用户ID;机器人返回`app_id`

示例值:

type SpecialFocusUnread

type SpecialFocusUnread struct {
	Id          *string `json:"id,omitempty"`           // 成员ID
	IdType      *string `json:"id_type,omitempty"`      // 成员ID类型。根据 ==member_id_type== 参数返回`open_id`、`user_id`或`union_id`类型的用户ID;机器人返回`app_id`
	UnreadCount *string `json:"unread_count,omitempty"` // 未读数
}

type SpecialFocusUnreadBuilder

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

func NewSpecialFocusUnreadBuilder

func NewSpecialFocusUnreadBuilder() *SpecialFocusUnreadBuilder

func (*SpecialFocusUnreadBuilder) Build

func (*SpecialFocusUnreadBuilder) Id

成员ID

示例值:

func (*SpecialFocusUnreadBuilder) IdType

成员ID类型。根据 ==member_id_type== 参数返回`open_id`、`user_id`或`union_id`类型的用户ID;机器人返回`app_id`

示例值:

func (*SpecialFocusUnreadBuilder) UnreadCount

func (builder *SpecialFocusUnreadBuilder) UnreadCount(unreadCount string) *SpecialFocusUnreadBuilder

未读数

示例值:

type Toolkit added in v3.0.1

type Toolkit struct {
	ToolkitId    *string              `json:"toolkit_id,omitempty"`    // 快捷组件ID
	ImageKey     *string              `json:"image_key,omitempty"`     // 快捷组件小图标 ;;上传message类型的图片[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)
	ToolkitName  *string              `json:"toolkit_name,omitempty"`  // 快捷组件名称
	I18nName     *I18nNames           `json:"i18n_name,omitempty"`     // 国际化名称
	ToolkitType  *string              `json:"toolkit_type,omitempty"`  // 快捷组件类型
	RedirectLink *ToolkitRedirectLink `json:"redirect_link,omitempty"` // 跳转类型快捷组件
	Callback     *ToolkitCallback     `json:"callback,omitempty"`      // 回调类型快捷组件
}

type ToolkitBuilder added in v3.0.1

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

func NewToolkitBuilder added in v3.0.1

func NewToolkitBuilder() *ToolkitBuilder

func (*ToolkitBuilder) Build added in v3.0.1

func (builder *ToolkitBuilder) Build() *Toolkit

func (*ToolkitBuilder) Callback added in v3.0.1

func (builder *ToolkitBuilder) Callback(callback *ToolkitCallback) *ToolkitBuilder

回调类型快捷组件

示例值:

func (*ToolkitBuilder) I18nName added in v3.0.1

func (builder *ToolkitBuilder) I18nName(i18nName *I18nNames) *ToolkitBuilder

国际化名称

示例值:

func (*ToolkitBuilder) ImageKey added in v3.0.1

func (builder *ToolkitBuilder) ImageKey(imageKey string) *ToolkitBuilder

快捷组件小图标 ;;上传message类型的图片[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)

示例值:img_v2_2995edd9-a22c-44ca-9559-71bbc1e661bg

func (builder *ToolkitBuilder) RedirectLink(redirectLink *ToolkitRedirectLink) *ToolkitBuilder

跳转类型快捷组件

示例值:

func (*ToolkitBuilder) ToolkitId added in v3.0.1

func (builder *ToolkitBuilder) ToolkitId(toolkitId string) *ToolkitBuilder

快捷组件ID

示例值:7101214603622940671

func (*ToolkitBuilder) ToolkitName added in v3.0.1

func (builder *ToolkitBuilder) ToolkitName(toolkitName string) *ToolkitBuilder

快捷组件名称

示例值:群组

func (*ToolkitBuilder) ToolkitType added in v3.0.1

func (builder *ToolkitBuilder) ToolkitType(toolkitType string) *ToolkitBuilder

快捷组件类型

示例值:redirect_link

type ToolkitCallback added in v3.0.1

type ToolkitCallback struct {
	Webhook   *string `json:"webhook,omitempty"`    // 回调地址
	ActionKey *string `json:"action_key,omitempty"` // 开发者自己识别的action_key,标识快捷组件的作用,回调时会把该字段带到回调地址
}

type ToolkitCallbackBuilder added in v3.0.1

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

func NewToolkitCallbackBuilder added in v3.0.1

func NewToolkitCallbackBuilder() *ToolkitCallbackBuilder

func (*ToolkitCallbackBuilder) ActionKey added in v3.0.1

func (builder *ToolkitCallbackBuilder) ActionKey(actionKey string) *ToolkitCallbackBuilder

开发者自己识别的action_key,标识快捷组件的作用,回调时会把该字段带到回调地址

示例值:SendMessage

func (*ToolkitCallbackBuilder) Build added in v3.0.1

func (builder *ToolkitCallbackBuilder) Build() *ToolkitCallback

func (*ToolkitCallbackBuilder) Webhook added in v3.0.1

func (builder *ToolkitCallbackBuilder) Webhook(webhook string) *ToolkitCallbackBuilder

回调地址

示例值:https://***.com/

type ToolkitRedirectLink struct {
	Url *string `json:"url,omitempty"` // 跳转url
}

type ToolkitRedirectLinkBuilder added in v3.0.1

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

func NewToolkitRedirectLinkBuilder added in v3.0.1

func NewToolkitRedirectLinkBuilder() *ToolkitRedirectLinkBuilder

func (*ToolkitRedirectLinkBuilder) Build added in v3.0.1

func (*ToolkitRedirectLinkBuilder) Url added in v3.0.1

跳转url

示例值:https://applink.feishu.cn/client/calendar/open

type UpdateChatModerationPathReqBodyBuilder

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

func NewUpdateChatModerationPathReqBodyBuilder

func NewUpdateChatModerationPathReqBodyBuilder() *UpdateChatModerationPathReqBodyBuilder

func (*UpdateChatModerationPathReqBodyBuilder) Build

func (*UpdateChatModerationPathReqBodyBuilder) ModerationSetting

func (builder *UpdateChatModerationPathReqBodyBuilder) ModerationSetting(moderationSetting string) *UpdateChatModerationPathReqBodyBuilder

群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式)

示例值:moderator_list

func (*UpdateChatModerationPathReqBodyBuilder) ModeratorAddedList

func (builder *UpdateChatModerationPathReqBodyBuilder) ModeratorAddedList(moderatorAddedList []string) *UpdateChatModerationPathReqBodyBuilder

选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户)

示例值:["4d7a3c6g"]

func (*UpdateChatModerationPathReqBodyBuilder) ModeratorRemovedList

func (builder *UpdateChatModerationPathReqBodyBuilder) ModeratorRemovedList(moderatorRemovedList []string) *UpdateChatModerationPathReqBodyBuilder

选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户)

示例值:["4d7a3ih6"]

type UpdateChatModerationReq

type UpdateChatModerationReq struct {
	Body *UpdateChatModerationReqBody `body:""`
	// contains filtered or unexported fields
}

type UpdateChatModerationReqBody

type UpdateChatModerationReqBody struct {
	ModerationSetting    *string  `json:"moderation_setting,omitempty"`     // 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式)
	ModeratorAddedList   []string `json:"moderator_added_list,omitempty"`   // 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户)
	ModeratorRemovedList []string `json:"moderator_removed_list,omitempty"` // 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户)
}

type UpdateChatModerationReqBodyBuilder

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

func NewUpdateChatModerationReqBodyBuilder

func NewUpdateChatModerationReqBodyBuilder() *UpdateChatModerationReqBodyBuilder

func (*UpdateChatModerationReqBodyBuilder) Build

func (*UpdateChatModerationReqBodyBuilder) ModerationSetting

func (builder *UpdateChatModerationReqBodyBuilder) ModerationSetting(moderationSetting string) *UpdateChatModerationReqBodyBuilder

群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式)

示例值:moderator_list

func (*UpdateChatModerationReqBodyBuilder) ModeratorAddedList

func (builder *UpdateChatModerationReqBodyBuilder) ModeratorAddedList(moderatorAddedList []string) *UpdateChatModerationReqBodyBuilder

选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户)

示例值:["4d7a3c6g"]

func (*UpdateChatModerationReqBodyBuilder) ModeratorRemovedList

func (builder *UpdateChatModerationReqBodyBuilder) ModeratorRemovedList(moderatorRemovedList []string) *UpdateChatModerationReqBodyBuilder

选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户)

示例值:["4d7a3ih6"]

type UpdateChatModerationReqBuilder

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

func NewUpdateChatModerationReqBuilder

func NewUpdateChatModerationReqBuilder() *UpdateChatModerationReqBuilder

func (*UpdateChatModerationReqBuilder) Body

更新群组的发言权限设置,可设置为全员可发言、仅管理员可发言 或 指定用户可发言。

func (*UpdateChatModerationReqBuilder) Build

func (*UpdateChatModerationReqBuilder) ChatId

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)

示例值:oc_a0553eda9014c201e6969b478895c230

func (*UpdateChatModerationReqBuilder) UserIdType

func (builder *UpdateChatModerationReqBuilder) UserIdType(userIdType string) *UpdateChatModerationReqBuilder

此次调用中使用的用户ID的类型

示例值:

type UpdateChatModerationResp

type UpdateChatModerationResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*UpdateChatModerationResp) Success

func (resp *UpdateChatModerationResp) Success() bool

type UpdateChatPathReqBodyBuilder

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

func NewUpdateChatPathReqBodyBuilder

func NewUpdateChatPathReqBodyBuilder() *UpdateChatPathReqBodyBuilder

func (*UpdateChatPathReqBodyBuilder) AddMemberPermission

func (builder *UpdateChatPathReqBodyBuilder) AddMemberPermission(addMemberPermission string) *UpdateChatPathReqBodyBuilder

邀请用户或机器人入群权限;;注意:;- 若值设置为`only_owner`,则share_card_permission只能设置为`not_allowed`;- 若值设置为`all_members`,则share_card_permission只能设置为`allowed`;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员

示例值:all_members

func (*UpdateChatPathReqBodyBuilder) AtAllPermission

func (builder *UpdateChatPathReqBodyBuilder) AtAllPermission(atAllPermission string) *UpdateChatPathReqBodyBuilder

at 所有人权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员

示例值:all_members

func (*UpdateChatPathReqBodyBuilder) Avatar

群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)

示例值:default-avatar_44ae0ca3-e140-494b-956f-78091e348435

func (*UpdateChatPathReqBodyBuilder) Build

func (*UpdateChatPathReqBodyBuilder) ChatType added in v3.0.10

群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群

示例值:private

func (*UpdateChatPathReqBodyBuilder) Description

func (builder *UpdateChatPathReqBodyBuilder) Description(description string) *UpdateChatPathReqBodyBuilder

群描述

示例值:测试群描述

func (*UpdateChatPathReqBodyBuilder) EditPermission

func (builder *UpdateChatPathReqBodyBuilder) EditPermission(editPermission string) *UpdateChatPathReqBodyBuilder

群编辑权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员

示例值:all_members

func (*UpdateChatPathReqBodyBuilder) I18nNames

群国际化名称

示例值:

func (*UpdateChatPathReqBodyBuilder) JoinMessageVisibility

func (builder *UpdateChatPathReqBodyBuilder) JoinMessageVisibility(joinMessageVisibility string) *UpdateChatPathReqBodyBuilder

入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:only_owner

func (*UpdateChatPathReqBodyBuilder) LeaveMessageVisibility

func (builder *UpdateChatPathReqBodyBuilder) LeaveMessageVisibility(leaveMessageVisibility string) *UpdateChatPathReqBodyBuilder

出群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:only_owner

func (*UpdateChatPathReqBodyBuilder) MembershipApproval

func (builder *UpdateChatPathReqBodyBuilder) MembershipApproval(membershipApproval string) *UpdateChatPathReqBodyBuilder

加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

示例值:no_approval_required

func (*UpdateChatPathReqBodyBuilder) Name

群名称

示例值:群聊

func (*UpdateChatPathReqBodyBuilder) OwnerId

新群主 ID

示例值:4d7a3c6g

func (*UpdateChatPathReqBodyBuilder) RestrictedModeSetting added in v3.0.20

func (builder *UpdateChatPathReqBodyBuilder) RestrictedModeSetting(restrictedModeSetting *RestrictedModeSetting) *UpdateChatPathReqBodyBuilder

防泄密模式设置

示例值:

func (*UpdateChatPathReqBodyBuilder) ShareCardPermission

func (builder *UpdateChatPathReqBodyBuilder) ShareCardPermission(shareCardPermission string) *UpdateChatPathReqBodyBuilder

群分享权限;;**可选值有**:;- `allowed`:允许;- `not_allowed`:不允许

示例值:allowed

func (*UpdateChatPathReqBodyBuilder) UrgentSetting added in v3.0.29

func (builder *UpdateChatPathReqBodyBuilder) UrgentSetting(urgentSetting string) *UpdateChatPathReqBodyBuilder

谁可以加急

示例值:all_members

func (*UpdateChatPathReqBodyBuilder) VideoConferenceSetting added in v3.0.29

func (builder *UpdateChatPathReqBodyBuilder) VideoConferenceSetting(videoConferenceSetting string) *UpdateChatPathReqBodyBuilder

谁可以发起视频会议

示例值:all_members

type UpdateChatReq

type UpdateChatReq struct {
	Body *UpdateChatReqBody `body:""`
	// contains filtered or unexported fields
}

type UpdateChatReqBody

type UpdateChatReqBody struct {
	Avatar                 *string    `json:"avatar,omitempty"`                   // 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)
	Name                   *string    `json:"name,omitempty"`                     // 群名称
	Description            *string    `json:"description,omitempty"`              // 群描述
	I18nNames              *I18nNames `json:"i18n_names,omitempty"`               // 群国际化名称
	AddMemberPermission    *string    `json:"add_member_permission,omitempty"`    // 邀请用户或机器人入群权限;;注意:;- 若值设置为`only_owner`,则share_card_permission只能设置为`not_allowed`;- 若值设置为`all_members`,则share_card_permission只能设置为`allowed`;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	ShareCardPermission    *string    `json:"share_card_permission,omitempty"`    // 群分享权限;;**可选值有**:;- `allowed`:允许;- `not_allowed`:不允许
	AtAllPermission        *string    `json:"at_all_permission,omitempty"`        // at 所有人权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	EditPermission         *string    `json:"edit_permission,omitempty"`          // 群编辑权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员
	OwnerId                *string    `json:"owner_id,omitempty"`                 // 新群主 ID
	JoinMessageVisibility  *string    `json:"join_message_visibility,omitempty"`  // 入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见
	LeaveMessageVisibility *string    `json:"leave_message_visibility,omitempty"` // 出群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见
	MembershipApproval     *string    `json:"membership_approval,omitempty"`      // 加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

	RestrictedModeSetting  *RestrictedModeSetting `json:"restricted_mode_setting,omitempty"`  // 防泄密模式设置
	ChatType               *string                `json:"chat_type,omitempty"`                // 群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群
	UrgentSetting          *string                `json:"urgent_setting,omitempty"`           // 谁可以加急
	VideoConferenceSetting *string                `json:"video_conference_setting,omitempty"` // 谁可以发起视频会议
}

type UpdateChatReqBodyBuilder

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

func NewUpdateChatReqBodyBuilder

func NewUpdateChatReqBodyBuilder() *UpdateChatReqBodyBuilder

func (*UpdateChatReqBodyBuilder) AddMemberPermission

func (builder *UpdateChatReqBodyBuilder) AddMemberPermission(addMemberPermission string) *UpdateChatReqBodyBuilder

邀请用户或机器人入群权限;;注意:;- 若值设置为`only_owner`,则share_card_permission只能设置为`not_allowed`;- 若值设置为`all_members`,则share_card_permission只能设置为`allowed`;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员

示例值:all_members

func (*UpdateChatReqBodyBuilder) AtAllPermission

func (builder *UpdateChatReqBodyBuilder) AtAllPermission(atAllPermission string) *UpdateChatReqBodyBuilder

at 所有人权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员

示例值:all_members

func (*UpdateChatReqBodyBuilder) Avatar

func (builder *UpdateChatReqBodyBuilder) Avatar(avatar string) *UpdateChatReqBodyBuilder

群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)

示例值:default-avatar_44ae0ca3-e140-494b-956f-78091e348435

func (*UpdateChatReqBodyBuilder) Build

func (builder *UpdateChatReqBodyBuilder) Build() *UpdateChatReqBody

func (*UpdateChatReqBodyBuilder) ChatType added in v3.0.10

func (builder *UpdateChatReqBodyBuilder) ChatType(chatType string) *UpdateChatReqBodyBuilder

群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群

示例值:private

func (*UpdateChatReqBodyBuilder) Description

func (builder *UpdateChatReqBodyBuilder) Description(description string) *UpdateChatReqBodyBuilder

群描述

示例值:测试群描述

func (*UpdateChatReqBodyBuilder) EditPermission

func (builder *UpdateChatReqBodyBuilder) EditPermission(editPermission string) *UpdateChatReqBodyBuilder

群编辑权限;;**可选值有**:;- `only_owner`:仅群主和管理员;- `all_members`:所有成员

示例值:all_members

func (*UpdateChatReqBodyBuilder) I18nNames

func (builder *UpdateChatReqBodyBuilder) I18nNames(i18nNames *I18nNames) *UpdateChatReqBodyBuilder

群国际化名称

示例值:

func (*UpdateChatReqBodyBuilder) JoinMessageVisibility

func (builder *UpdateChatReqBodyBuilder) JoinMessageVisibility(joinMessageVisibility string) *UpdateChatReqBodyBuilder

入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:only_owner

func (*UpdateChatReqBodyBuilder) LeaveMessageVisibility

func (builder *UpdateChatReqBodyBuilder) LeaveMessageVisibility(leaveMessageVisibility string) *UpdateChatReqBodyBuilder

出群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

示例值:only_owner

func (*UpdateChatReqBodyBuilder) MembershipApproval

func (builder *UpdateChatReqBodyBuilder) MembershipApproval(membershipApproval string) *UpdateChatReqBodyBuilder

加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

示例值:no_approval_required

func (*UpdateChatReqBodyBuilder) Name

群名称

示例值:群聊

func (*UpdateChatReqBodyBuilder) OwnerId

func (builder *UpdateChatReqBodyBuilder) OwnerId(ownerId string) *UpdateChatReqBodyBuilder

新群主 ID

示例值:4d7a3c6g

func (*UpdateChatReqBodyBuilder) RestrictedModeSetting added in v3.0.20

func (builder *UpdateChatReqBodyBuilder) RestrictedModeSetting(restrictedModeSetting *RestrictedModeSetting) *UpdateChatReqBodyBuilder

防泄密模式设置

示例值:

func (*UpdateChatReqBodyBuilder) ShareCardPermission

func (builder *UpdateChatReqBodyBuilder) ShareCardPermission(shareCardPermission string) *UpdateChatReqBodyBuilder

群分享权限;;**可选值有**:;- `allowed`:允许;- `not_allowed`:不允许

示例值:allowed

func (*UpdateChatReqBodyBuilder) UrgentSetting added in v3.0.29

func (builder *UpdateChatReqBodyBuilder) UrgentSetting(urgentSetting string) *UpdateChatReqBodyBuilder

谁可以加急

示例值:all_members

func (*UpdateChatReqBodyBuilder) VideoConferenceSetting added in v3.0.29

func (builder *UpdateChatReqBodyBuilder) VideoConferenceSetting(videoConferenceSetting string) *UpdateChatReqBodyBuilder

谁可以发起视频会议

示例值:all_members

type UpdateChatReqBuilder

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

func NewUpdateChatReqBuilder

func NewUpdateChatReqBuilder() *UpdateChatReqBuilder

func (*UpdateChatReqBuilder) Body

更新群头像、群名称、群描述、群配置、转让群主等。

func (*UpdateChatReqBuilder) Build

func (builder *UpdateChatReqBuilder) Build() *UpdateChatReq

func (*UpdateChatReqBuilder) ChatId

func (builder *UpdateChatReqBuilder) ChatId(chatId string) *UpdateChatReqBuilder

群 ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:仅支持群模式为`group`的群组ID

示例值:oc_a0553eda9014c201e6969b478895c230

func (*UpdateChatReqBuilder) UserIdType

func (builder *UpdateChatReqBuilder) UserIdType(userIdType string) *UpdateChatReqBuilder

此次调用中使用的用户ID的类型

示例值:

type UpdateChatResp

type UpdateChatResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*UpdateChatResp) Success

func (resp *UpdateChatResp) Success() bool

type UpdateMessagePathReqBodyBuilder added in v3.0.24

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

func NewUpdateMessagePathReqBodyBuilder added in v3.0.24

func NewUpdateMessagePathReqBodyBuilder() *UpdateMessagePathReqBodyBuilder

func (*UpdateMessagePathReqBodyBuilder) Build added in v3.0.24

func (*UpdateMessagePathReqBodyBuilder) Content added in v3.0.24

消息内容 JSON 格式

示例值:"{\"text\":\"Tom test content\"}"

func (*UpdateMessagePathReqBodyBuilder) MsgType added in v3.0.24

消息的类型,仅支持文本(text)和富文本(post)类型

示例值:text

type UpdateMessageReq added in v3.0.24

type UpdateMessageReq struct {
	Body *UpdateMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type UpdateMessageReqBody added in v3.0.24

type UpdateMessageReqBody struct {
	MsgType *string `json:"msg_type,omitempty"` // 消息的类型,仅支持文本(text)和富文本(post)类型
	Content *string `json:"content,omitempty"`  // 消息内容 JSON 格式
}

type UpdateMessageReqBodyBuilder added in v3.0.24

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

func NewUpdateMessageReqBodyBuilder added in v3.0.24

func NewUpdateMessageReqBodyBuilder() *UpdateMessageReqBodyBuilder

func (*UpdateMessageReqBodyBuilder) Build added in v3.0.24

func (*UpdateMessageReqBodyBuilder) Content added in v3.0.24

消息内容 JSON 格式

示例值:"{\"text\":\"Tom test content\"}"

func (*UpdateMessageReqBodyBuilder) MsgType added in v3.0.24

消息的类型,仅支持文本(text)和富文本(post)类型

示例值:text

type UpdateMessageReqBuilder added in v3.0.24

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

func NewUpdateMessageReqBuilder added in v3.0.24

func NewUpdateMessageReqBuilder() *UpdateMessageReqBuilder

func (*UpdateMessageReqBuilder) Body added in v3.0.24

编辑已发送的消息内容,当前仅支持编辑文本和富文本消息。

func (*UpdateMessageReqBuilder) Build added in v3.0.24

func (builder *UpdateMessageReqBuilder) Build() *UpdateMessageReq

func (*UpdateMessageReqBuilder) MessageId added in v3.0.24

func (builder *UpdateMessageReqBuilder) MessageId(messageId string) *UpdateMessageReqBuilder

消息ID

示例值:om_dc13264520392913993dd051dba21dcf

type UpdateMessageResp added in v3.0.24

type UpdateMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *UpdateMessageRespData `json:"data"` // 业务数据
}

func (*UpdateMessageResp) Success added in v3.0.24

func (resp *UpdateMessageResp) Success() bool

type UpdateMessageRespData added in v3.0.24

type UpdateMessageRespData struct {
	MessageId      *string      `json:"message_id,omitempty"`       // 消息id open_message_id
	RootId         *string      `json:"root_id,omitempty"`          // 根消息id open_message_id
	ParentId       *string      `json:"parent_id,omitempty"`        // 父消息的id open_message_id
	MsgType        *string      `json:"msg_type,omitempty"`         // 消息类型 text post card image等等
	CreateTime     *string      `json:"create_time,omitempty"`      // 消息生成的时间戳(毫秒)
	UpdateTime     *string      `json:"update_time,omitempty"`      // 消息更新的时间戳
	Deleted        *bool        `json:"deleted,omitempty"`          // 消息是否被撤回
	Updated        *bool        `json:"updated,omitempty"`          // 消息是否被更新
	ChatId         *string      `json:"chat_id,omitempty"`          // 所属的群
	Sender         *Sender      `json:"sender,omitempty"`           // 发送者,可以是用户或应用
	Body           *MessageBody `json:"body,omitempty"`             // 消息内容,json结构
	Mentions       []*Mention   `json:"mentions,omitempty"`         // 被艾特的人或应用的id
	UpperMessageId *string      `json:"upper_message_id,omitempty"` // 合并消息的上一层级消息id open_message_id
}

type UpdateTabsChatTabPathReqBodyBuilder

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

func NewUpdateTabsChatTabPathReqBodyBuilder

func NewUpdateTabsChatTabPathReqBodyBuilder() *UpdateTabsChatTabPathReqBodyBuilder

func (*UpdateTabsChatTabPathReqBodyBuilder) Build

func (*UpdateTabsChatTabPathReqBodyBuilder) ChatTabs

会话标签页

示例值:

type UpdateTabsChatTabReq

type UpdateTabsChatTabReq struct {
	Body *UpdateTabsChatTabReqBody `body:""`
	// contains filtered or unexported fields
}

type UpdateTabsChatTabReqBody

type UpdateTabsChatTabReqBody struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 会话标签页
}

type UpdateTabsChatTabReqBodyBuilder

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

func NewUpdateTabsChatTabReqBodyBuilder

func NewUpdateTabsChatTabReqBodyBuilder() *UpdateTabsChatTabReqBodyBuilder

func (*UpdateTabsChatTabReqBodyBuilder) Build

func (*UpdateTabsChatTabReqBodyBuilder) ChatTabs

会话标签页

示例值:

type UpdateTabsChatTabReqBuilder

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

func NewUpdateTabsChatTabReqBuilder

func NewUpdateTabsChatTabReqBuilder() *UpdateTabsChatTabReqBuilder

func (*UpdateTabsChatTabReqBuilder) Body

更新会话标签页

func (*UpdateTabsChatTabReqBuilder) Build

func (*UpdateTabsChatTabReqBuilder) ChatId

群ID,详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description);;**注意**:支持群模式为`p2p`与`group`的群ID

示例值:oc_a0553eda9014c201e6969b478895c230

type UpdateTabsChatTabResp

type UpdateTabsChatTabResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *UpdateTabsChatTabRespData `json:"data"` // 业务数据
}

func (*UpdateTabsChatTabResp) Success

func (resp *UpdateTabsChatTabResp) Success() bool

type UpdateTabsChatTabRespData

type UpdateTabsChatTabRespData struct {
	ChatTabs []*ChatTab `json:"chat_tabs,omitempty"` // 群标签
}

type UrgentAppMessageReq

type UrgentAppMessageReq struct {
	UrgentReceivers *UrgentReceivers `body:""`
	// contains filtered or unexported fields
}

type UrgentAppMessageReqBuilder

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

func NewUrgentAppMessageReqBuilder

func NewUrgentAppMessageReqBuilder() *UrgentAppMessageReqBuilder

func (*UrgentAppMessageReqBuilder) Build

func (*UrgentAppMessageReqBuilder) MessageId

func (builder *UrgentAppMessageReqBuilder) MessageId(messageId string) *UrgentAppMessageReqBuilder

待加急的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2);;**注意**:不支持批量消息ID(bm_xxx)

示例值:om_dc13264520392913993dd051dba21dcf

func (*UrgentAppMessageReqBuilder) UrgentReceivers

func (builder *UrgentAppMessageReqBuilder) UrgentReceivers(urgentReceivers *UrgentReceivers) *UrgentAppMessageReqBuilder

对指定消息进行应用内加急。

func (*UrgentAppMessageReqBuilder) UserIdType

func (builder *UrgentAppMessageReqBuilder) UserIdType(userIdType string) *UrgentAppMessageReqBuilder

此次调用中使用的用户ID的类型

示例值:

type UrgentAppMessageResp

type UrgentAppMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *UrgentAppMessageRespData `json:"data"` // 业务数据
}

func (*UrgentAppMessageResp) Success

func (resp *UrgentAppMessageResp) Success() bool

type UrgentAppMessageRespData

type UrgentAppMessageRespData struct {
	InvalidUserIdList []string `json:"invalid_user_id_list,omitempty"` // 无效的用户ID
}

type UrgentPhoneMessageReq

type UrgentPhoneMessageReq struct {
	UrgentReceivers *UrgentReceivers `body:""`
	// contains filtered or unexported fields
}

type UrgentPhoneMessageReqBuilder

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

func NewUrgentPhoneMessageReqBuilder

func NewUrgentPhoneMessageReqBuilder() *UrgentPhoneMessageReqBuilder

func (*UrgentPhoneMessageReqBuilder) Build

func (*UrgentPhoneMessageReqBuilder) MessageId

func (builder *UrgentPhoneMessageReqBuilder) MessageId(messageId string) *UrgentPhoneMessageReqBuilder

待加急的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2);;**注意**:不支持批量消息ID(bm_xxx)

示例值:om_dc13264520392913993dd051dba21dcf

func (*UrgentPhoneMessageReqBuilder) UrgentReceivers

func (builder *UrgentPhoneMessageReqBuilder) UrgentReceivers(urgentReceivers *UrgentReceivers) *UrgentPhoneMessageReqBuilder

对指定消息进行应用内加急与电话加急。

func (*UrgentPhoneMessageReqBuilder) UserIdType

func (builder *UrgentPhoneMessageReqBuilder) UserIdType(userIdType string) *UrgentPhoneMessageReqBuilder

此次调用中使用的用户ID的类型

示例值:open_id

type UrgentPhoneMessageResp

type UrgentPhoneMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *UrgentPhoneMessageRespData `json:"data"` // 业务数据
}

func (*UrgentPhoneMessageResp) Success

func (resp *UrgentPhoneMessageResp) Success() bool

type UrgentPhoneMessageRespData

type UrgentPhoneMessageRespData struct {
	InvalidUserIdList []string `json:"invalid_user_id_list,omitempty"` // 无效的用户ID
}

type UrgentReceivers

type UrgentReceivers struct {
	UserIdList []string `json:"user_id_list,omitempty"` // 目标用户的ID,列表不可为空;;**注意**:;请确保所填的用户ID正确,并且用户在加急消息所在的群组中
}

type UrgentReceiversBuilder

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

func NewUrgentReceiversBuilder

func NewUrgentReceiversBuilder() *UrgentReceiversBuilder

func (*UrgentReceiversBuilder) Build

func (builder *UrgentReceiversBuilder) Build() *UrgentReceivers

func (*UrgentReceiversBuilder) UserIdList

func (builder *UrgentReceiversBuilder) UserIdList(userIdList []string) *UrgentReceiversBuilder

目标用户的ID,列表不可为空;;**注意**:;请确保所填的用户ID正确,并且用户在加急消息所在的群组中

示例值:["ou_6yf8af6bgb9100449565764t3382b168"]

type UrgentSmsMessageReq

type UrgentSmsMessageReq struct {
	UrgentReceivers *UrgentReceivers `body:""`
	// contains filtered or unexported fields
}

type UrgentSmsMessageReqBuilder

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

func NewUrgentSmsMessageReqBuilder

func NewUrgentSmsMessageReqBuilder() *UrgentSmsMessageReqBuilder

func (*UrgentSmsMessageReqBuilder) Build

func (*UrgentSmsMessageReqBuilder) MessageId

func (builder *UrgentSmsMessageReqBuilder) MessageId(messageId string) *UrgentSmsMessageReqBuilder

待加急的消息ID,详情参见[消息ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2);;**注意**:不支持批量消息ID(bm_xxx)

示例值:om_dc13264520392913993dd051dba21dcf

func (*UrgentSmsMessageReqBuilder) UrgentReceivers

func (builder *UrgentSmsMessageReqBuilder) UrgentReceivers(urgentReceivers *UrgentReceivers) *UrgentSmsMessageReqBuilder

对指定消息进行应用内加急与短信加急。

func (*UrgentSmsMessageReqBuilder) UserIdType

func (builder *UrgentSmsMessageReqBuilder) UserIdType(userIdType string) *UrgentSmsMessageReqBuilder

此次调用中使用的用户ID的类型

示例值:

type UrgentSmsMessageResp

type UrgentSmsMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *UrgentSmsMessageRespData `json:"data"` // 业务数据
}

func (*UrgentSmsMessageResp) Success

func (resp *UrgentSmsMessageResp) Success() bool

type UrgentSmsMessageRespData

type UrgentSmsMessageRespData struct {
	InvalidUserIdList []string `json:"invalid_user_id_list,omitempty"` // 无效的用户ID
}

type UserId

type UserId struct {
	UserId  *string `json:"user_id,omitempty"`  //
	OpenId  *string `json:"open_id,omitempty"`  //
	UnionId *string `json:"union_id,omitempty"` //
}

type UserIdBuilder

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

func NewUserIdBuilder

func NewUserIdBuilder() *UserIdBuilder

func (*UserIdBuilder) Build

func (builder *UserIdBuilder) Build() *UserId

func (*UserIdBuilder) OpenId

func (builder *UserIdBuilder) OpenId(openId string) *UserIdBuilder

示例值:

func (*UserIdBuilder) UnionId

func (builder *UserIdBuilder) UnionId(unionId string) *UserIdBuilder

示例值:

func (*UserIdBuilder) UserId

func (builder *UserIdBuilder) UserId(userId string) *UserIdBuilder

示例值:

type V1 added in v3.1.0

type V1 struct {
	BatchMessage     *batchMessage     // 消息 - 批量消息
	Chat             *chat             // 群组
	ChatAnnouncement *chatAnnouncement // 群组 - 群公告
	ChatManagers     *chatManagers     // 群组 - 群成员
	ChatMemberBot    *chatMemberBot    // 事件
	ChatMemberUser   *chatMemberUser   // 事件
	ChatMembers      *chatMembers      // 群组 - 群成员
	ChatMenuItem     *chatMenuItem     // chat.menu_item
	ChatMenuTree     *chatMenuTree     // 群组 - 群菜单
	ChatModeration   *chatModeration   // chat.moderation
	ChatTab          *chatTab          // 群组 - 会话标签页
	ChatTopNotice    *chatTopNotice    // chat.top_notice
	File             *file             // 消息 - 文件信息
	Image            *image            // 消息 - 图片信息
	Message          *message          // 消息
	MessageReaction  *messageReaction  // 消息 - 表情回复
	MessageResource  *messageResource  // message.resource
	Pin              *pin              // 消息 - Pin
}

func New added in v3.1.0

func New(config *larkcore.Config) *V1

type Widget added in v3.0.17

type Widget struct {
	WidgetId   *string    `json:"widget_id,omitempty"`   // 小组件ID
	WidgetType *string    `json:"widget_type,omitempty"` // 小组件类型
	WidgetUrl  *WidgetUrl `json:"widget_url,omitempty"`  // 小组件链接,必须以http开头
}

type WidgetBuilder added in v3.0.17

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

func NewWidgetBuilder added in v3.0.17

func NewWidgetBuilder() *WidgetBuilder

func (*WidgetBuilder) Build added in v3.0.17

func (builder *WidgetBuilder) Build() *Widget

func (*WidgetBuilder) WidgetId added in v3.0.17

func (builder *WidgetBuilder) WidgetId(widgetId string) *WidgetBuilder

小组件ID

示例值:7117116451961487361

func (*WidgetBuilder) WidgetType added in v3.0.17

func (builder *WidgetBuilder) WidgetType(widgetType string) *WidgetBuilder

小组件类型

示例值:URL

func (*WidgetBuilder) WidgetUrl added in v3.0.17

func (builder *WidgetBuilder) WidgetUrl(widgetUrl *WidgetUrl) *WidgetBuilder

小组件链接,必须以http开头

示例值:

type WidgetUrl added in v3.0.17

type WidgetUrl struct {
	Url *string `json:"url,omitempty"` // 小组件的url
}

type WidgetUrlBuilder added in v3.0.17

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

func NewWidgetUrlBuilder added in v3.0.17

func NewWidgetUrlBuilder() *WidgetUrlBuilder

func (*WidgetUrlBuilder) Build added in v3.0.17

func (builder *WidgetUrlBuilder) Build() *WidgetUrl

func (*WidgetUrlBuilder) Url added in v3.0.17

func (builder *WidgetUrlBuilder) Url(url string) *WidgetUrlBuilder

小组件的url

示例值:https://open.feishu.cn/document/home/index

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL