model

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Nov 12, 2023 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnnexDeleteReq added in v1.0.0 

type AnnexDeleteReq struct {
	AnnexId string `json:"annex_id,omitempty" v:"required"`
}

笔记附件删除接口请求参数

type AnnexDownloadReq added in v1.0.0 

type AnnexDownloadReq struct {
	AnnexId string `json:"annex_id,omitempty" v:"required"`
}

笔记附件下载接口请求参数

type AnnexForeverDeleteReq added in v1.0.0 

type AnnexForeverDeleteReq struct {
	AnnexId string `json:"annex_id,omitempty" v:"required"`
}

笔记附件永久删除接口请求参数

type AnnexRecoverListRes added in v1.0.0 

type AnnexRecoverListRes struct {
	Items    []*NoteAnnex `json:"items"`
	Paginate *Paginate    `json:"paginate,omitempty"`
}

笔记附件回收站列表接口响应参数

type AnnexRecoverReq added in v1.0.0 

type AnnexRecoverReq struct {
	AnnexId string `json:"annex_id,omitempty" v:"required"`
}

笔记附件恢复删除接口请求参数

type AnnexUploadReq added in v1.0.0 

type AnnexUploadReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
}

笔记附件上传接口请求参数

type AnnexUploadRes added in v1.0.0 

type AnnexUploadRes struct {
	Id           string `json:"id,omitempty"`
	Size         int    `json:"size,omitempty"`
	Path         string `json:"path,omitempty"`
	Suffix       string `json:"suffix,omitempty"`
	OriginalName string `json:"original_name,omitempty"`
}

笔记附件上传接口响应参数

type AnswerOption added in v1.0.0 

type AnswerOption struct {
	Key   string `json:"key,omitempty" bson:"key,omitempty"`
	Value string `json:"value,omitempty" bson:"value,omitempty"`
}

type Apply added in v1.0.0 

type Apply struct {
	Id        string `json:"id,omitempty"`         // 申请ID
	UserId    int    `json:"user_id,omitempty"`    // 申请人ID
	FriendId  int    `json:"friend_id,omitempty"`  // 被申请人
	Remark    string `json:"remark,omitempty"`     // 申请备注
	Nickname  string `json:"nickname,omitempty"`   // 申请备注
	Avatar    string `json:"avatar,omitempty"`     // 申请备注
	CreatedAt string `json:"created_at,omitempty"` // 申请时间
}

type ApplyAcceptReq added in v1.0.0 

type ApplyAcceptReq struct {
	ContactApply
}

同意好友申请接口请求参数

type ApplyAgreeReq added in v1.0.0 

type ApplyAgreeReq struct {
	ApplyId string `json:"apply_id,omitempty" v:"required"`
}

同意入群申请接口请求参数

type ApplyAllRes added in v1.0.0 

type ApplyAllRes struct {
	Items []*GroupApply `json:"items"`
}

申请管理-所有入群申请列表接口响应参数

type ApplyCreateReq added in v1.0.0 

type ApplyCreateReq struct {
	ContactApply
}

添加好友申请接口请求参数

type ApplyDeclineReq added in v1.0.0 

type ApplyDeclineReq struct {
	ApplyId string `json:"apply_id,omitempty" v:"required"`
	Remark  string `json:"remark,omitempty" v:"required"`
}

拒绝好友申请接口请求参数

type ApplyDeleteReq added in v1.0.0 

type ApplyDeleteReq struct {
	ApplyId string `json:"apply_id,omitempty" v:"required"`
}

拒绝入群申请接口请求参数

type ApplyListReq added in v1.0.0 

type ApplyListReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
}

入群申请列表接口请求参数

type ApplyListRes added in v1.0.0 

type ApplyListRes struct {
	Items []*Apply `json:"items"`
}

好友申请列表接口响应参数

type ApplyUnreadNumRes 

type ApplyUnreadNumRes struct {
	UnreadNum int `json:"unread_num"`
}

好友申请未读数接口响应参数

type Card added in v1.0.0 

type Card struct {
	UserId int `json:"user_id,omitempty" bson:"user_id,omitempty" v:"required"`
}

位置消息

type CardMessageReq 

type CardMessageReq struct {
	Type       string    `json:"type,omitempty"`
	UserId     int       `json:"user_id,omitempty" v:"required"`
	Receiver   *Receiver `json:"receiver,omitempty"`
	TalkType   int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int       `json:"receiver_id" v:"required"`
}

名片消息

type ClassDeleteReq added in v1.0.0 

type ClassDeleteReq struct {
	ClassId string `json:"class_id,omitempty" v:"required"`
}

笔记分类删除接口请求参数

type ClassEditReq added in v1.0.0 

type ClassEditReq struct {
	ClassId   string `json:"class_id,omitempty"`
	ClassName string `json:"class_name,omitempty" v:"required"`
}

笔记分类编辑接口请求参数

type ClassEditRes added in v1.0.0 

type ClassEditRes struct {
	Id string `json:"id,omitempty"`
}

笔记分类编辑接口响应参数

type ClassListRes added in v1.0.0 

type ClassListRes struct {
	Items    []*NoteClass `json:"items"`
	Paginate *Paginate    `json:"paginate"`
}

笔记分类列表接口响应参数

type ClassSortReq added in v1.0.0 

type ClassSortReq struct {
	ClassId  string `json:"class_id,omitempty" v:"required"`
	SortType int    `json:"sort_type,omitempty" v:"required|in:1,2"`
}

笔记分类排序接口请求参数

type Code added in v1.0.0 

type Code struct {
	Lang string `json:"lang,omitempty" bson:"lang,omitempty" v:"required"`
	Code string `json:"code,omitempty" bson:"code,omitempty" v:"required"`
}

代码消息

type CodeMessageReq 

type CodeMessageReq struct {
	Type       string    `json:"type,omitempty"`
	Receiver   *Receiver `json:"receiver,omitempty"` // 消息接收者
	TalkType   int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int       `json:"receiver_id" v:"required"`
	Lang       string    `json:"lang" v:"required"`
	Code       string    `json:"code" v:"required"`
}

代码消息

type CollectEmoticon added in v1.0.0 

type CollectEmoticon struct {
	MediaId string `json:"media_id,omitempty"`
	Src     string `json:"src,omitempty"`
}

type Contact 

type Contact struct {
	Id       int    `json:"id"`        // 用户ID
	Nickname string `json:"nickname"`  // 昵称
	Gender   int    `json:"gender"`    // 性别[0:未知;1:男;2:女;]
	Motto    string `json:"motto"`     // 座右铭
	Avatar   string `json:"avatar"`    // 头像
	Remark   string `json:"remark"`    // 备注
	IsOnline int    `json:"is_online"` // 是否在线
	GroupId  string `json:"group_id"`  // 好友分组ID
}

type ContactApply 

type ContactApply struct {
	FriendId int    `json:"friend_id,omitempty"`
	Remark   string `json:"remark,omitempty"`
	ApplyId  string `json:"apply_id,omitempty"`
	UserId   int    `json:"user_id,omitempty"`
}

用户添加好友申请

type ContactChangeGroupReq 

type ContactChangeGroupReq struct {
	UserId  int    `json:"user_id,omitempty" v:"required"`
	GroupId string `json:"group_id,omitempty"`
}

修改好友分组接口请求参数

type ContactDeleteReq 

type ContactDeleteReq struct {
	FriendId int `json:"friend_id,omitempty" v:"required"`
}

好友删除接口请求参数

type ContactDetailReq 

type ContactDetailReq struct {
	UserId int `json:"user_id,omitempty" v:"required"`
}

好友详情接口请求参数

type ContactDetailRes 

type ContactDetailRes struct {
	Id           int    `json:"id"`
	Mobile       string `json:"mobile"`
	Nickname     string `json:"nickname"`
	Remark       string `json:"remark"`
	Avatar       string `json:"avatar"`
	Gender       int    `json:"gender"`
	Motto        string `json:"motto"`
	FriendApply  int    `json:"friend_apply"`
	FriendStatus int    `json:"friend_status"`
	GroupId      string `json:"group_id"`
	Email        string `json:"email"`
	Birthday     string `json:"birthday"` // 生日
}

好友详情接口响应参数

type ContactEditRemarkReq 

type ContactEditRemarkReq struct {
	FriendId int    `json:"friend_id,omitempty" v:"required"`
	Remark   string `json:"remark,omitempty"`
}

好友备注修改接口请求参数

type ContactGroup 

type ContactGroup struct {
	Id    string `json:"id"`    // ID
	Name  string `json:"name"`  // 分组名称
	Count int    `json:"count"` // 成员总数
	Sort  int    `json:"sort"`  // 分组排序
}

好友分组

type ContactGroupCreateReq added in v1.0.0 

type ContactGroupCreateReq struct {
	Name string `json:"name,omitempty" v:"required"`
	Sort int32  `json:"sort,omitempty" v:"required"`
}

添加好友分组接口请求参数

type ContactGroupCreateRes added in v1.0.0 

type ContactGroupCreateRes struct {
	Id int32 `json:"id,omitempty"`
}

添加好友分组接口响应参数

type ContactGroupListRes 

type ContactGroupListRes struct {
	// 分组列表
	Items []*ContactGroup `json:"items"`
}

好友分组列表接口响应参数

type ContactListItem 

type ContactListItem struct {
	Id       int    `json:"id"`            // 用户ID
	Nickname string `json:"nickname"`      // 用户昵称
	Gender   int    `json:"gender"`        // 用户性别[0:未知;1:男;2:女;]
	Motto    string `json:"motto"`         // 用户座右铭
	Avatar   string `json:"avatar" `       // 好友头像
	Remark   string `json:"friend_remark"` // 好友的备注
	IsOnline int    `json:"is_online"`     // 是否在线
	GroupId  string `json:"group_id"`      // 好友分组ID
}

type ContactListRes 

type ContactListRes struct {
	Items []*Contact `json:"items"`
}

好友列表接口响应参数

type ContactSearchReq 

type ContactSearchReq struct {
	Mobile string `json:"mobile,omitempty" v:"required"`
}

好友搜索接口请求参数

type ContactSearchRes 

type ContactSearchRes struct {
	Id       int    `json:"id,omitempty"`
	Mobile   string `json:"mobile,omitempty"`
	Nickname string `json:"nickname,omitempty"`
	Avatar   string `json:"avatar,omitempty"`
	Gender   int    `json:"gender,omitempty"`
	Motto    string `json:"motto,omitempty"`
}

好友搜索接口响应参数

type DeleteReq added in v1.0.0 

type DeleteReq struct {
	Ids string `json:"ids,omitempty" v:"required"`
}

删除表情包接口请求参数

type Emoticon added in v1.0.0 

type Emoticon struct {
	EmoticonId string `json:"emoticon_id,omitempty" bson:"emoticon_id,omitempty" v:"required"`
	Url        string `json:"url,omitempty" bson:"url,omitempty" v:"required"`       // 图片地址
	Width      int    `json:"width,omitempty" bson:"width,omitempty" v:"required"`   // 图片宽度
	Height     int    `json:"height,omitempty" bson:"height,omitempty" v:"required"` // 图片高度
	Size       int    `json:"size,omitempty" bson:"size,omitempty" v:"required"`     // 图片大小
}

表情消息

type EmoticonMessageReq 

type EmoticonMessageReq struct {
	Type       string    `json:"type,omitempty"`
	Receiver   *Receiver `json:"receiver,omitempty"` // 消息接收者
	TalkType   int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int       `json:"receiver_id" v:"required"`
	EmoticonId string    `json:"emoticon_id" v:"required"`
}

表情消息

type File added in v1.0.0 

type File struct {
	UploadId string `json:"upload_id,omitempty" bson:"upload_id,omitempty" v:"required"`
	Name     string `json:"name,omitempty" bson:"name,omitempty"`     // 文件名称
	Drive    int    `json:"drive,omitempty" bson:"drive,omitempty"`   // 文件存储方式
	Suffix   string `json:"suffix,omitempty" bson:"suffix,omitempty"` // 文件后缀
	Size     int    `json:"size,omitempty" bson:"size,omitempty"`     // 文件大小
	Path     string `json:"path,omitempty" bson:"path,omitempty"`     // 文件路径
}

文件消息

type ForgetReq added in v1.0.0 

type ForgetReq struct {
	Account  string `json:"account,omitempty" v:"required"`               // 账号
	Password string `json:"password,omitempty" v:"required|min-length:6"` // 登录密码
	Code     string `json:"code,omitempty" v:"required"`                  // 短信验证码
}

找回密码接口请求参数

type Forward added in v1.0.0 

type Forward struct {
	TalkType   int            `json:"talk_type,omitempty" bson:"talk_type,omitempty"`
	RecordsIds []int          `json:"records_ids,omitempty" bson:"records_ids,omitempty"` // 消息列表
	Items      []*ForwardItem `json:"items,omitempty" bson:"items,omitempty"`             // 消息快照
}

转发消息

type ForwardItem added in v1.0.0 

type ForwardItem struct {
	Nickname string `json:"nickname,omitempty" bson:"nickname,omitempty"`
	Text     string `json:"text,omitempty" bson:"text,omitempty"`
}

type ForwardMessageReq 

type ForwardMessageReq struct {
	Type            string    `json:"type,omitempty"`
	Mode            int       `json:"mode,omitempty" v:"required"`        // 转发模式
	MessageIds      []int     `json:"message_ids,omitempty" v:"required"` // 消息ID
	Gids            []int     `json:"gids,omitempty"`                     // 群ID列表
	Uids            []int     `json:"uids,omitempty"`                     // 好友ID列表
	Receiver        *Receiver `json:"receiver,omitempty"`                 // 消息接收者
	TalkType        int       `json:"talk_type" v:"required|in:1,2"`      // 对话类型
	ReceiverId      int       `json:"receiver_id" v:"required"`           // 接收者ID
	MsgType         int       `json:"msg_type"`                           // 消息类型
	RecordId        int       `json:"record_id" v:"min:0"`                // 上次查询的最小消息ID
	Limit           int       `json:"limit" v:"required|max:100"`         // 数据行数
	ForwardMode     int       `json:"forward_mode" v:"required|in:1,2"`
	RecordsIds      string    `json:"records_ids" v:"required"`
	ReceiveUserIds  string    `json:"receive_user_ids"`
	ReceiveGroupIds string    `json:"receive_group_ids"`
}

转发消息

type ForwardRecord 

type ForwardRecord struct {
	RecordId   int
	ReceiverId int
	TalkType   int
}

type GetInviteFriendsReq 

type GetInviteFriendsReq struct {
	GroupId int `json:"group_id,omitempty"`
}

获取待审批入群申请列表接口请求参数

type GetInviteFriendsRes added in v1.0.0 

type GetInviteFriendsRes struct {
	Items []*ContactListItem `json:"items"`
}

获取待审批入群申请列表接口响应参数

type Group added in v1.0.0 

type Group struct {
	Id        int    `json:"id,omitempty"`
	GroupName string `json:"group_name,omitempty"`
	Avatar    string `json:"avatar,omitempty"`
	Profile   string `json:"profile,omitempty"`
	Leader    int    `json:"leader,omitempty"`
	IsDisturb int    `json:"is_disturb,omitempty"`
	CreatorId int    `json:"creator_id,omitempty"`
}

type GroupApply added in v1.0.0 

type GroupApply struct {
	Id        string `json:"id,omitempty"`         // ID
	UserId    int    `json:"user_id,omitempty"`    // 用户ID
	GroupId   int    `json:"group_id,omitempty"`   // 群聊ID
	GroupName string `json:"group_name,omitempty"` // 群名称
	Remark    string `json:"remark,omitempty"`     // 备注信息
	Avatar    string `json:"avatar,omitempty"`     // 用户头像地址
	Nickname  string `json:"nickname,omitempty"`   // 用户昵称
	CreatedAt string `json:"created_at,omitempty"` // 创建时间
}

type GroupApplyCreateReq 

type GroupApplyCreateReq struct {
	GroupId int    `json:"group_id,omitempty" v:"required"`
	Remark  string `json:"remark,omitempty" v:"required"`
}

提交入群申请接口请求参数

type GroupApplyDeclineReq 

type GroupApplyDeclineReq struct {
	ApplyId string `json:"apply_id,omitempty" v:"required"`
	Remark  string `json:"remark,omitempty" v:"required"`
}

拒绝入群申请接口请求参数

type GroupApplyListRes 

type GroupApplyListRes struct {
	Items []*GroupApply `json:"items"`
}

入群申请列表接口响应参数

type GroupApplyUnreadNumRes added in v1.0.0 

type GroupApplyUnreadNumRes struct {
	UnreadNum int `json:"unread_num"`
}

type GroupAssignAdminReq 

type GroupAssignAdminReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
	UserId  int `json:"user_id,omitempty" v:"required"`
	Mode    int `json:"mode,omitempty" v:"required|in:1,2"`
}

分配管理员接口请求参数

type GroupCancelMuted added in v1.0.0 

type GroupCancelMuted struct {
	OwnerId   int    `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
}

管理员解除群禁言消息

type GroupCreate added in v1.0.0 

type GroupCreate struct {
	OwnerId   int                `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string             `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members,omitempty" bson:"members,omitempty"`       // 成员列表
}

创建群消息

type GroupCreateReq 

type GroupCreateReq struct {
	Name   string `json:"name,omitempty" v:"required"`
	Ids    string `json:"ids,omitempty" v:"required"`
	Avatar string `json:"avatar,omitempty"`
}

创建群聊接口请求参数

type GroupCreateRes 

type GroupCreateRes struct {
	GroupId int `json:"group_id,omitempty"`
}

创建群聊接口响应参数

type GroupDeleteReq added in v1.0.0 

type GroupDeleteReq struct {
	Id int32 `json:"id,omitempty" v:"required"`
}

删除好友分组接口请求参数

type GroupDeleteRes added in v1.0.0 

type GroupDeleteRes struct {
	Id int32 `json:"id,omitempty"`
}

删除好友分组接口响应参数

type GroupDetailReq 

type GroupDetailReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
}

群聊详情接口请求参数

type GroupDetailRes 

type GroupDetailRes struct {
	GroupId   int    `json:"group_id,omitempty"`
	GroupName string `json:"group_name,omitempty"`
	Profile   string `json:"profile,omitempty"`
	Avatar    string `json:"avatar,omitempty"`
	CreatedAt string `json:"created_at,omitempty"`
	IsManager bool   `json:"is_manager,omitempty"`
	IsDisturb int    `json:"is_disturb,omitempty"`
	VisitCard string `json:"visit_card,omitempty"`
	IsMute    int    `json:"is_mute,omitempty"`
	IsOvert   int    `json:"is_overt,omitempty"`
}

群聊详情接口响应参数

type GroupDismissReq 

type GroupDismissReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
}

解散群聊接口请求参数

type GroupDismissed added in v1.0.0 

type GroupDismissed struct {
	OwnerId   int    `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
}

群主解散群消息

type GroupHandoverReq 

type GroupHandoverReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
	UserId  int `json:"user_id,omitempty" v:"required"`
}

群主更换接口请求参数

type GroupInviteReq 

type GroupInviteReq struct {
	GroupId int    `json:"group_id,omitempty" v:"required"`
	Ids     string `json:"ids,omitempty" v:"required"`
}

邀请加入群聊接口请求参数

type GroupJoin added in v1.0.0 

type GroupJoin struct {
	OwnerId   int                `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string             `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members,omitempty" bson:"members,omitempty"`       // 成员列表
}

群主邀请加入群消息

type GroupListRes 

type GroupListRes struct {
	Items []*Group `json:"items"`
}

群列表接口响应参数

type GroupMember added in v1.0.0 

type GroupMember struct {
	UserId   int    `json:"user_id"`
	Nickname string `json:"nickname"`
	Avatar   string `json:"avatar"`
	Gender   int    `json:"gender"`
	Leader   int    `json:"leader"`
	IsMute   int    `json:"is_mute"`
	UserCard string `json:"user_card"`
	Motto    string `json:"motto"` // 座右铭
}

type GroupMemberCancelMuted added in v1.0.0 

type GroupMemberCancelMuted struct {
	OwnerId   int                `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string             `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members,omitempty" bson:"members,omitempty"`       // 成员列表
}

管理员解除群成员禁言消息

type GroupMemberKicked added in v1.0.0 

type GroupMemberKicked struct {
	OwnerId   int                `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string             `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members,omitempty" bson:"members,omitempty"`       // 成员列表
}

踢出群成员消息

type GroupMemberListReq 

type GroupMemberListReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
}

群成员列表接口请求参数

type GroupMemberListRes 

type GroupMemberListRes struct {
	Items []*GroupMember `json:"items"`
}

群成员列表接口响应参数

type GroupMemberMuted added in v1.0.0 

type GroupMemberMuted struct {
	OwnerId   int                `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string             `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members,omitempty" bson:"members,omitempty"`       // 成员列表
}

管理员设置群成员禁言消息

type GroupMemberQuit added in v1.0.0 

type GroupMemberQuit struct {
	OwnerId   int    `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
}

群成员退出群消息

type GroupMessageRevoke added in v1.0.0 

type GroupMessageRevoke struct {
	OwnerId         int    `json:"owner_id,omitempty" bson:"owner_id,omitempty"`                   // 操作人ID
	OwnerName       string `json:"owner_name,omitempty" bson:"owner_name,omitempty"`               // 操作人昵称
	RevokeMessageId string `json:"revoke_message_id,omitempty" bson:"revoke_message_id,omitempty"` // 被撤回消息ID
}

管理员撤回成员消息

type GroupMuteReq 

type GroupMuteReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
	Mode    int `json:"mode,omitempty" v:"required|in:1,2"` // 操作方式  1:开启全员禁言  2:解除全员禁言
}

全员禁言接口请求参数

type GroupMuted added in v1.0.0 

type GroupMuted struct {
	OwnerId   int    `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
}

管理员设置群禁言消息

type GroupNoSpeakReq 

type GroupNoSpeakReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
	UserId  int `json:"user_id,omitempty" v:"required"`
	Mode    int `json:"mode,omitempty" v:"required|in:1,2"`
}

群成员禁言接口请求参数

type GroupNotice added in v1.0.0 

type GroupNotice struct {
	OwnerId   int    `json:"owner_id,omitempty" bson:"owner_id,omitempty"`     // 操作人ID
	OwnerName string `json:"owner_name,omitempty" bson:"owner_name,omitempty"` // 操作人昵称
	Title     string `json:"title,omitempty" bson:"title,omitempty"`           // 标题
	Content   string `json:"content,omitempty" bson:"content,omitempty"`       // 内容
}

发布群公告

type GroupOvert added in v1.0.0 

type GroupOvert struct {
	Id        int    `json:"id,omitempty"`
	Type      int    `json:"type,omitempty"`
	Name      string `json:"name,omitempty"`
	Avatar    string `json:"avatar,omitempty"`
	Profile   string `json:"profile,omitempty"`
	Count     int    `json:"count,omitempty"`
	MaxNum    int    `json:"max_num,omitempty"`
	IsMember  bool   `json:"is_member,omitempty"`
	CreatedAt string `json:"created_at,omitempty"`
}

type GroupOvertListReq 

type GroupOvertListReq struct {
	Page int    `json:"page,omitempty" v:"required"`
	Name string `json:"name,omitempty" v:"max-length:50"`
}

公开群聊列表接口请求参数

type GroupOvertListRes 

type GroupOvertListRes struct {
	Items []*GroupOvert `json:"items"`
	Next  bool          `json:"next,omitempty"`
}

公开群聊列表接口响应参数

type GroupOvertReq 

type GroupOvertReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
	Mode    int `json:"mode,omitempty" v:"required|in:1,2"` // 操作方式  1:开启公开可见  2:关闭公开可见
}

群公开修改接口请求参数

type GroupRemarkUpdateReq 

type GroupRemarkUpdateReq struct {
	GroupId   int    `json:"group_id,omitempty" v:"required"`
	VisitCard string `json:"visit_card,omitempty"`
}

群聊名片更新接口请求参数

type GroupRemoveMemberReq 

type GroupRemoveMemberReq struct {
	GroupId    int    `json:"group_id,omitempty" v:"required"`
	MembersIds string `json:"members_ids,omitempty" v:"required"`
}

移出群成员接口请求参数

type GroupSaveReq added in v1.0.0 

type GroupSaveReq struct {
	Items []*ContactGroup `json:"items" v:"required"`
}

保存好友分组列表接口请求参数

type GroupSecedeReq 

type GroupSecedeReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
}

退出群聊接口请求参数

type GroupSettingReq 

type GroupSettingReq struct {
	GroupId   int    `json:"group_id,omitempty" v:"required"`
	GroupName string `json:"group_name,omitempty" v:"required"`
	Avatar    string `json:"avatar,omitempty"`
	Profile   string `json:"profile,omitempty"`
}

设置群聊接口请求参数

type GroupSortReq added in v1.0.0 

type GroupSortReq struct {
	Items []*ContactGroup `json:"items" v:"required"`
}

排序好友分组接口请求参数

type GroupTransfer added in v1.0.0 

type GroupTransfer struct {
	OldOwnerId   int    `json:"old_owner_id,omitempty" bson:"old_owner_id,omitempty"`     // 老群主ID
	OldOwnerName string `json:"old_owner_name,omitempty" bson:"old_owner_name,omitempty"` // 老群主昵称
	NewOwnerId   int    `json:"new_owner_id,omitempty" bson:"new_owner_id,omitempty"`     // 新群主ID
	NewOwnerName string `json:"new_owner_name,omitempty" bson:"new_owner_name,omitempty"` // 新群主昵称
}

群主转让群消息

type GroupUpdateReq added in v1.0.0 

type GroupUpdateReq struct {
	Id   int32  `json:"id,omitempty" v:"required"`
	Name string `json:"name,omitempty" v:"required"`
	Sort int32  `json:"sort,omitempty" v:"required"`
}

更新好友分组接口请求参数

type GroupUpdateRes added in v1.0.0 

type GroupUpdateRes struct {
	Id int32 `json:"id,omitempty"`
}

更新好友分组接口响应参数

type Image added in v1.0.0 

type Image struct {
	Url    string `json:"url,omitempty" bson:"url,omitempty" v:"required"`       // 图片地址
	Width  int    `json:"width,omitempty" bson:"width,omitempty" v:"required"`   // 图片宽度
	Height int    `json:"height,omitempty" bson:"height,omitempty" v:"required"` // 图片高度
	Size   int    `json:"size,omitempty" bson:"size,omitempty" v:"required"`     // 图片大小
}

图片消息

type ImageMessageReq 

type ImageMessageReq struct {
	Type       string    `json:"type,omitempty"`
	Url        string    `json:"url,omitempty" v:"required"`    // 图片地址
	Width      int       `json:"width,omitempty" v:"required"`  // 图片宽度
	Height     int       `json:"height,omitempty" v:"required"` // 图片高度
	Size       int       `json:"size,omitempty" v:"required"`   // 图片大小
	Receiver   *Receiver `json:"receiver,omitempty"`            // 消息接收者
	QuoteId    string    `json:"quote_id,omitempty"`            // 引用的消息ID
	TalkType   int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int       `json:"receiver_id" v:"required"`
}

图片消息

type InviteFriendsRes added in v1.1.0 

type InviteFriendsRes struct {
	InviteUrl string          `json:"invite_url"`
	Items     []*InviteRecord `json:"items,omitempty" bson:"items,omitempty"`
}

邀请好友接口响应参数

type InviteRecord added in v1.1.0 

type InviteRecord struct {
	Nickname  string `json:"nickname,omitempty"`   // 用户昵称
	Email     string `json:"email,omitempty"`      // 用户邮箱
	CreatedAt string `json:"created_at,omitempty"` // 注册时间
}

type ListRes added in v1.0.0 

type ListRes struct {
	CollectEmoticons []*CollectEmoticon `json:"collect_emoticon,omitempty"`
}

用户表情包列表接口响应参数

type Location added in v1.0.0 

type Location struct {
	Longitude   string `json:"longitude,omitempty" bson:"longitude,omitempty" v:"required"`     // 地理位置 经度
	Latitude    string `json:"latitude,omitempty" bson:"latitude,omitempty" v:"required"`       // 地理位置 纬度
	Description string `json:"description,omitempty" bson:"description,omitempty" v:"required"` // 位置描述
}

位置消息

type LocationMessageReq 

type LocationMessageReq struct {
	Type        string    `json:"type,omitempty"`
	Longitude   string    `json:"longitude,omitempty" v:"required"`   // 地理位置 经度
	Latitude    string    `json:"latitude,omitempty" v:"required"`    // 地理位置 纬度
	Description string    `json:"description,omitempty" v:"required"` // 位置描述
	Receiver    *Receiver `json:"receiver,omitempty"`                 // 消息接收者
	TalkType    int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId  int       `json:"receiver_id" v:"required"`
}

位置消息

type Login added in v1.0.0 

type Login struct {
	IP       string `json:"ip,omitempty" bson:"ip,omitempty"`             // 登录IP
	Address  string `json:"address,omitempty" bson:"address,omitempty"`   // 登录地址
	Platform string `json:"platform,omitempty" bson:"platform,omitempty"` // 登录平台
	Agent    string `json:"agent,omitempty" bson:"agent,omitempty"`       // 登录设备
	Reason   string `json:"reason,omitempty" bson:"reason,omitempty"`     // 登录原因
	Datetime string `json:"datetime,omitempty" bson:"datetime,omitempty"` // 登录时间
}

登录消息

type LoginMessageReq 

type LoginMessageReq struct {
	Ip       string `json:"ip,omitempty"`
	Address  string `json:"address,omitempty"`
	Platform string `json:"platform,omitempty"`
	Agent    string `json:"agent,omitempty"`
	Reason   string `json:"reason,omitempty"`
}

登录消息

type LoginReq added in v1.0.0 

type LoginReq struct {
	Account  string `json:"account,omitempty" v:"required"`                                 // 登录账号
	Password string `json:"password,omitempty" v:"required"`                                // 登录密码
	Platform string `json:"platform,omitempty" v:"required|in:web,h5,ios,windows,mac,file"` // 登录平台
}

登录接口请求参数

type LoginRes added in v1.0.0 

type LoginRes struct {
	Type        string `json:"type,omitempty"`         // Token 类型
	AccessToken string `json:"access_token,omitempty"` // token
	ExpiresIn   int    `json:"expires_in,omitempty"`   // 过期时间
}

登录接口响应参数

type Mention added in v1.0.0 

type Mention struct {
	Type int   `json:"type,omitempty" bson:"type,omitempty"` // 提及类型, 1: 所有人, 2: 指定人
	Uids []int `json:"uids,omitempty" bson:"uids,omitempty"`
}

type Message added in v1.0.0 

type Message struct {
	MsgId    string    `json:"msg_id,omitempty" bson:"msg_id,omitempty"`
	MsgType  string    `json:"msg_type,omitempty" bson:"msg_type,omitempty"`
	Sender   *Sender   `json:"sender,omitempty" bson:"sender,omitempty"`       // 发送者
	Receiver *Receiver `json:"receiver,omitempty" bson:"receiver,omitempty"`   // 接收者
	TalkType int       `json:"talk_type,omitempty" bson:"talk_type,omitempty"` // 对话类型 1:私聊 2:群聊
	Mention  *Mention  `json:"mention,omitempty" bson:"mention,omitempty"`
	QuoteId  string    `json:"quote_id,omitempty" bson:"quote_id,omitempty"` // 引用的消息ID
	Reply    *Reply    `json:"reply,omitempty" bson:"reply,omitempty"`

	Text     *Text     `json:"text,omitempty" bson:"text,omitempty"`
	Code     *Code     `json:"code,omitempty" bson:"code,omitempty"`
	Image    *Image    `json:"image,omitempty" bson:"image,omitempty"`
	Voice    *Voice    `json:"voice,omitempty" bson:"voice,omitempty"`
	Video    *Video    `json:"video,omitempty" bson:"video,omitempty"`
	File     *File     `json:"file,omitempty" bson:"file,omitempty"`
	Vote     *Vote     `json:"vote,omitempty" bson:"vote,omitempty"`
	Mixed    *Mixed    `json:"mixed,omitempty" bson:"mixed,omitempty"`
	Forward  *Forward  `json:"forward,omitempty" bson:"forward,omitempty"`
	Emoticon *Emoticon `json:"emoticon,omitempty" bson:"emoticon,omitempty"`
	Card     *Card     `json:"card,omitempty" bson:"card,omitempty"`
	Location *Location `json:"location,omitempty" bson:"location,omitempty"`
}

type MessageCollectReq added in v1.0.0 

type MessageCollectReq struct {
	RecordId int `json:"record_id" v:"required"`
}

type MessageDeleteReq added in v1.0.0 

type MessageDeleteReq struct {
	TalkType   int    `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int    `json:"receiver_id" v:"required"`
	RecordIds  string `json:"record_id" v:"record_id@required"`
}

type MessageFileReq added in v1.0.0 

type MessageFileReq struct {
	Type       string    `json:"type,omitempty"`
	Receiver   *Receiver `json:"receiver,omitempty"` // 消息接收者
	TalkType   int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int       `json:"receiver_id" v:"required"`
	UploadId   string    `json:"upload_id" v:"required"`
}

发送文件消息接口请求参数

type MessagePublishReq added in v1.0.0 

type MessagePublishReq struct {
	Type     string    `json:"type" v:"required"`
	Receiver *Receiver `json:"receiver" v:"required"`
}

type MessageRevokeReq added in v1.0.0 

type MessageRevokeReq struct {
	RecordId int `json:"record_id" v:"required"`
}

type MessageVoteHandleReq added in v1.0.0 

type MessageVoteHandleReq struct {
	RecordId int    `json:"record_id" v:"required"`
	Options  string `json:"options" v:"required"`
}

type MessageVoteReq added in v1.0.0 

type MessageVoteReq struct {
	Type       string    `json:"type,omitempty"`
	Receiver   *Receiver `json:"receiver,omitempty"` // 消息接收者
	ReceiverId int       `json:"receiver_id" v:"required"`
	Mode       int       `json:"mode" v:"in:0,1"`
	Anonymous  int       `json:"anonymous" v:"in:0,1"`
	Title      string    `json:"title" v:"required"`
	Options    []string  `json:"options"`
}

投票消息接口请求参数

type Mixed added in v1.0.0 

type Mixed struct {
	Items []*MixedItem `json:"items,omitempty" bson:"items,omitempty"`
}

图文消息

type MixedItem added in v1.0.0 

type MixedItem struct {
	MsgType string `json:"msg_type,omitempty" bson:"msg_type,omitempty"`
	Text    *Text  `json:"text,omitempty" bson:"text,omitempty"`
	Image   *Image `json:"image,omitempty" bson:"image,omitempty"`
}

type MixedMessage added in v1.0.0 

type MixedMessage struct {
	Type    int    `json:"type,omitempty"`
	Content string `json:"content,omitempty"`
}

type MixedMessageReq 

type MixedMessageReq struct {
	Type     string          `json:"type,omitempty"`
	Items    []*MixedMessage `json:"items"`
	Receiver *Receiver       `json:"receiver,omitempty"`
	QuoteId  string          `json:"quote_id,omitempty"` // 引用的消息ID
}

图文消息

type Note added in v1.0.0 

type Note struct {
	Id         string `json:"id"`          // 笔记ID
	UserId     int    `json:"user_id"`     // 用户ID
	ClassId    string `json:"class_id"`    // 分类ID
	TagsId     string `json:"tags_id"`     // 笔记关联标签
	Title      string `json:"title"`       // 笔记标题
	Abstract   string `json:"abstract"`    // 笔记摘要
	Image      string `json:"image"`       // 笔记首图
	IsAsterisk int    `json:"is_asterisk"` // 是否星标笔记[0:否;1:是;]
	Status     int    `json:"status"`      // 笔记状态[1:正常;2:已删除;]
	CreatedAt  string `json:"created_at"`  // 创建时间
	UpdatedAt  string `json:"updated_at"`  // 更新时间
	MdContent  string `json:"md_content"`  // Markdown 内容
	Content    string `json:"content"`     // Markdown 解析HTML内容
	ClassName  string `json:"class_name"`  // 分类名
}

type NoteAnnex added in v1.0.0 

type NoteAnnex struct {
	Id           string `json:"id"`                   // 文件ID
	UserId       int    `json:"user_id"`              // 上传文件的用户ID
	NoteId       string `json:"note_id"`              // 笔记ID
	Drive        int    `json:"drive"`                // 文件驱动[1:local;2:cos;]
	Suffix       string `json:"suffix"`               // 文件后缀名
	Size         int    `json:"size"`                 // 文件大小
	Path         string `json:"path"`                 // 文件地址(相对地址)
	OriginalName string `json:"original_name"`        // 原文件名
	Status       int    `json:"status"`               // 附件状态[1:正常;2:已删除;]
	Title        string `json:"title"`                // 标题
	CreatedAt    string `json:"created_at,omitempty"` // 上传时间
	DeletedAt    string `json:"deleted_at"`           // 删除时间
	Day          int    `json:"day,omitempty"`        // 剩余天数
}

type NoteAsteriskReq added in v1.0.0 

type NoteAsteriskReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
	Type   int    `json:"type,omitempty" v:"required|in:1,2"`
}

标记笔记接口请求参数

type NoteClass added in v1.0.0 

type NoteClass struct {
	Id        string `json:"id,omitempty"`         // 笔记分类ID
	ClassName string `json:"class_name,omitempty"` // 分类名
	IsDefault int    `json:"is_default,omitempty"` // 默认分类1:是 0:不是
	Count     int    `json:"count,omitempty"`      // 分类名
}

type NoteDeleteReq added in v1.0.0 

type NoteDeleteReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
}

笔记删除接口请求参数

type NoteDetailReq added in v1.0.0 

type NoteDetailReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
}

笔记详情接口请求参数

type NoteDetailRes added in v1.0.0 

type NoteDetailRes struct {
	Id         string       `json:"id,omitempty"`
	ClassId    string       `json:"class_id,omitempty"`
	Title      string       `json:"title,omitempty"`
	Content    string       `json:"content,omitempty"`
	MdContent  string       `json:"md_content,omitempty"`
	IsAsterisk int          `json:"is_asterisk,omitempty"`
	CreatedAt  string       `json:"created_at,omitempty"`
	UpdatedAt  string       `json:"updated_at,omitempty"`
	Tags       []*NoteTag   `json:"tags"`  // 标签列表
	Files      []*NoteAnnex `json:"files"` // 附件列表
}

笔记详情接口响应参数

type NoteEditReq added in v1.0.0 

type NoteEditReq struct {
	NoteId    string `json:"note_id,omitempty"`
	ClassId   string `json:"class_id,omitempty"`
	Title     string `json:"title,omitempty" v:"required"`
	Content   string `json:"content,omitempty" v:"required"`
	MdContent string `json:"md_content,omitempty" v:"required"`
}

笔记编辑接口请求参数

type NoteEditRes added in v1.0.0 

type NoteEditRes struct {
	Id       string `json:"id,omitempty"`
	Title    string `json:"title,omitempty"`
	Abstract string `json:"abstract,omitempty"`
	Image    string `json:"image,omitempty"`
}

笔记编辑接口响应参数

type NoteForeverDeleteReq added in v1.0.0 

type NoteForeverDeleteReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
}

永久删除笔记接口请求参数

type NoteListReq added in v1.0.0 

type NoteListReq struct {
	Keyword  string `json:"keyword,omitempty"`
	FindType int    `json:"find_type,omitempty"`
	Cid      string `json:"cid,omitempty"`
	Page     int    `json:"page,omitempty"`
}

笔记列表接口请求参数

type NoteListRes added in v1.0.0 

type NoteListRes struct {
	Items    []*Note   `json:"items"`
	Paginate *Paginate `json:"paginate"`
}

笔记列表请求接口响应参数

type NoteMoveReq added in v1.0.0 

type NoteMoveReq struct {
	NoteId  string `json:"note_id,omitempty" v:"required"`
	ClassId string `json:"class_id,omitempty" v:"required"`
}

笔记移动分类接口请求参数

type NoteRecoverReq added in v1.0.0 

type NoteRecoverReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
}

恢复笔记接口请求参数

type NoteTag added in v1.0.0 

type NoteTag struct {
	Id      string `json:"id"`       // 标签ID
	TagName string `json:"tag_name"` // 标签名
	Count   int    `json:"count"`    // 排序
}

type NoteTagsReq added in v1.0.0 

type NoteTagsReq struct {
	NoteId string `json:"note_id,omitempty" v:"required"`
	Tags   []int  `json:"tags,omitempty"`
}

笔记标签接口请求参数

type NoteUploadImageRes added in v1.0.0 

type NoteUploadImageRes struct {
	Url string `json:"url"`
}

笔记图片上传接口响应参数

type Notice added in v1.0.0 

type Notice struct {
	Id           string `json:"id,omitempty"`
	Title        string `json:"title,omitempty"`
	Content      string `json:"content,omitempty"`
	IsTop        int    `json:"is_top,omitempty"`
	IsConfirm    int    `json:"is_confirm,omitempty"`
	ConfirmUsers string `json:"confirm_users,omitempty"`
	CreatorId    int    `json:"creator_id,omitempty"`
	Avatar       string `json:"avatar,omitempty"`
	Nickname     string `json:"nickname,omitempty"`
	CreatedAt    string `json:"created_at,omitempty"`
	UpdatedAt    string `json:"updated_at,omitempty"`
}

type NoticeDeleteReq added in v1.0.0 

type NoticeDeleteReq struct {
	GroupId  int    `json:"group_id,omitempty" v:"required"`
	NoticeId string `json:"notice_id,omitempty" v:"required"`
}

删除群公告接口请求参数

type NoticeEdit added in v1.0.0 

type NoticeEdit struct {
	UserId    int
	GroupId   int
	NoticeId  string
	Title     string
	Content   string
	IsTop     int
	IsConfirm int
}

type NoticeEditReq added in v1.0.0 

type NoticeEditReq struct {
	GroupId   int    `json:"group_id,omitempty" v:"required"`
	NoticeId  string `json:"notice_id,omitempty"`
	Title     string `json:"title,omitempty" v:"required"`
	Content   string `json:"content,omitempty" v:"required"`
	IsTop     int    `json:"is_top,omitempty" v:"in:0,1"`
	IsConfirm int    `json:"is_confirm,omitempty" v:"in:0,1"`
}

发布或更新群公告接口请求参数

type NoticeListReq added in v1.0.0 

type NoticeListReq struct {
	GroupId int `json:"group_id,omitempty" v:"required"`
}

群公告列表接口请求参数

type NoticeListRes added in v1.0.0 

type NoticeListRes struct {
	Items []*Notice `json:"items"`
}

群公告列表接口响应参数

type NoticeMessage added in v1.0.0 

type NoticeMessage struct {
	MsgId    string    `json:"msg_id,omitempty" bson:"msg_id,omitempty"`
	MsgType  string    `json:"msg_type,omitempty" bson:"msg_type,omitempty"`
	TalkType int       `json:"talk_type,omitempty" bson:"talk_type,omitempty"` // 对话类型 1:私聊 2:群聊
	Sender   *Sender   `json:"sender,omitempty" bson:"sender,omitempty"`       // 发送者
	Receiver *Receiver `json:"receiver,omitempty" bson:"receiver,omitempty"`   // 接收者

	Login *Login `json:"login,omitempty" bson:"login,omitempty"`
}

type Paginate 

type Paginate struct {
	Page  int `json:"page,omitempty"`
	Size  int `json:"size,omitempty"`
	Total int `json:"total,omitempty"`
}

type QueryTalkRecordsOpt 

type QueryTalkRecordsOpt struct {
	TalkType   int   // 对话类型
	UserId     int   // 获取消息的用户
	ReceiverId int   // 接收者ID
	MsgType    []int // 消息类型
	RecordId   int   // 上次查询的最小消息ID
	Limit      int   // 数据行数
}

type Receiver added in v1.0.0 

type Receiver struct {
	TalkType   int    `json:"talk_type,omitempty" bson:"talk_type,omitempty"`     // 对话类型 1:私聊 2:群聊 todo
	ReceiverId int    `json:"receiver_id,omitempty" bson:"receiver_id,omitempty"` // 接收者ID, 好友ID或群ID todo
	Id         int    `json:"id,omitempty" bson:"id,omitempty"`                   // 接收者ID, 好友ID或群ID
	Name       string `json:"name,omitempty" bson:"name,omitempty"`               // 接收者名称, 好友名称或群名称
}

type RecordsFileDownloadReq added in v1.0.0 

type RecordsFileDownloadReq struct {
	RecordId int `json:"cr_id" v:"cr_id@required|min:1"`
}

type RecordsForwardReq added in v1.0.0 

type RecordsForwardReq struct {
	RecordId int `json:"record_id"` // 上次查询的最小消息ID
}

type RefreshRes added in v1.0.0 

type RefreshRes struct {
	Type        string `json:"type,omitempty"`
	AccessToken string `json:"access_token,omitempty"`
	ExpiresIn   int    `json:"expires_in,omitempty"`
}

Token 刷新接口响应参数

type RegisterReq added in v1.0.0 

type RegisterReq struct {
	Account  string `json:"account,omitempty" v:"required"`                                 // 登录账号
	Password string `json:"password,omitempty" v:"required|min-length:6"`                   // 登录密码
	Nickname string `json:"nickname,omitempty" v:"required|length:2,30"`                    // 昵称
	Platform string `json:"platform,omitempty" v:"required|in:web,h5,ios,windows,mac,file"` // 登录平台
	Code     string `json:"code,omitempty" v:"required"`                                    // 短信验证码
}

注册接口请求参数

type Reply 

type Reply struct {
	MsgId    string `json:"msg_id,omitempty" bson:"msg_id,omitempty"`
	MsgType  string `json:"msg_type,omitempty" bson:"msg_type,omitempty"` // text: 文字, image: 图片
	Content  string `json:"content,omitempty" bson:"content,omitempty"`   // 文字或图片链接
	UserId   int    `json:"user_id,omitempty" bson:"user_id,omitempty"`
	Nickname string `json:"nickname,omitempty" bson:"nickname,omitempty"`
}

type Robot 

type Robot struct {
	UserId    int    `json:"user_id,omitempty"`    // 绑定的用户ID
	IsTalk    int    `json:"is_talk,omitempty"`    // 是否可发送消息[0:否;1:是;]
	Type      int    `json:"type,omitempty"`       // 机器人类型
	Status    int    `json:"status,omitempty"`     // 状态[-1:已删除;0:正常;1:已禁用;]
	Corp      string `json:"corp,omitempty"`       // 公司
	Model     string `json:"model,omitempty"`      // 模型
	ModelType string `json:"model_type,omitempty"` // 模型类型, 文生文: text, 画图: image
	Role      string `json:"role,omitempty"`       // 角色
	Prompt    string `json:"prompt,omitempty"`     // 提示
	Proxy     string `json:"proxy,omitempty"`      // 代理
	Key       string `json:"key,omitempty"`        // 密钥
	CreatedAt int64  `json:"created_at,omitempty"` // 创建时间
	UpdatedAt int64  `json:"updated_at,omitempty"` // 更新时间
}

type SearchTalkSession 

type SearchTalkSession struct {
	Id            string `json:"id" `
	TalkType      int    `json:"talk_type" `
	ReceiverId    int    `json:"receiver_id" `
	IsDelete      int    `json:"is_delete"`
	IsTop         int    `json:"is_top"`
	IsRobot       int    `json:"is_robot"`
	IsDisturb     int    `json:"is_disturb"`
	UserAvatar    string `json:"user_avatar"`
	Nickname      string `json:"nickname"`
	GroupName     string `json:"group_name"`
	GroupAvatar   string `json:"group_avatar"`
	UpdatedAt     int64  `json:"updated_at"`
	IsTalk        int    `json:"is_talk"`
	IsOpenContext int    `json:"is_open_context"`
}

type SendEmailReq added in v1.0.0 

type SendEmailReq struct {
	Email   string `json:"email,omitempty" v:"required"`
	Channel string `json:"channel,omitempty" v:"required|in:login,register,forget_account,change_email,change_mobile"`
}

发送邮件验证码接口请求参数

type SendEmailRes added in v1.0.0 

type SendEmailRes struct {
	IsDebug bool   `json:"is_debug"`
	Code    string `json:"code"`
}

发送邮件验证码接口响应参数

type SendSmsReq added in v1.0.0 

type SendSmsReq struct {
	Mobile  string `json:"mobile,omitempty" v:"required|length:0,11"`
	Channel string `json:"channel,omitempty" v:"required|in:login,register,forget_account,change_email,change_mobile"`
}

发送短信验证码接口请求参数

type SendSmsRes added in v1.0.0 

type SendSmsRes struct {
	IsDebug bool   `json:"is_debug"`
	SmsCode string `json:"code"`
}

发送短信验证码接口响应参数

type Sender added in v1.0.0 

type Sender struct {
	Id   int    `json:"id,omitempty" bson:"id,omitempty"`     // 发送者ID
	Name string `json:"name,omitempty" bson:"name,omitempty"` // 发送者名称
}

type SessionClearContextReq added in v1.0.0 

type SessionClearContextReq struct {
	TalkType   int `json:"talk_type"`
	ReceiverId int `json:"receiver_id"`
}

type SessionClearUnreadNumReq added in v1.0.0 

type SessionClearUnreadNumReq struct {
	TalkType   int `json:"talk_type,omitempty" v:"required|in:1,2"`
	ReceiverId int `json:"receiver_id,omitempty" v:"required"`
}

会话未读数清除接口请求参数

type SessionCreateReq added in v1.0.0 

type SessionCreateReq struct {
	TalkType   int `json:"talk_type,omitempty" v:"required|in:1,2"`
	ReceiverId int `json:"receiver_id,omitempty" v:"required"`
}

会话创建接口请求参数

type SessionCreateRes added in v1.0.0 

type SessionCreateRes struct {
	Id         string `json:"id,omitempty"`
	TalkType   int    `json:"talk_type,omitempty"`
	ReceiverId int    `json:"receiver_id,omitempty"`
	IsTop      int    `json:"is_top,omitempty"`
	IsDisturb  int    `json:"is_disturb,omitempty"`
	IsOnline   int    `json:"is_online,omitempty"`
	IsRobot    int    `json:"is_robot,omitempty"`
	Name       string `json:"name,omitempty"`
	Avatar     string `json:"avatar,omitempty"`
	Remark     string `json:"remark,omitempty"`
	UnreadNum  int    `json:"unread_num,omitempty"`
	MsgText    string `json:"msg_text,omitempty"`
	UpdatedAt  string `json:"updated_at,omitempty"`
	IsTalk     int    `json:"is_talk,omitempty"`
}

会话创建接口响应参数

type SessionDeleteReq added in v1.0.0 

type SessionDeleteReq struct {
	ListId string `json:"list_id,omitempty" v:"required"`
}

会话删除接口请求参数

type SessionDisturbReq added in v1.0.0 

type SessionDisturbReq struct {
	TalkType   int `json:"talk_type,omitempty" v:"required|in:1,2"`
	ReceiverId int `json:"receiver_id,omitempty" v:"required"`
	IsDisturb  int `json:"is_disturb,omitempty" v:"required|in:0,1"`
}

会话免打扰接口请求参数

type SessionListRes added in v1.0.0 

type SessionListRes struct {
	Items []*TalkSession `json:"items"`
}

会话列表接口响应参数

type SessionOpenContextReq added in v1.0.0 

type SessionOpenContextReq struct {
	ReceiverId    int `json:"receiver_id"`
	IsOpenContext int `json:"is_open_context"`
	TalkType      int `json:"talk_type,omitempty" v:"required|in:1,2"`
}

type SessionTopReq added in v1.0.0 

type SessionTopReq struct {
	ListId string `json:"list_id,omitempty" v:"required"`
	Type   int    `json:"type,omitempty" v:"required|in:1,2"`
}

会话置顶接口请求参数

type SettingInfo added in v1.0.0 

type SettingInfo struct {
	ThemeMode           string `json:"theme_mode,omitempty"`
	ThemeBagImg         string `json:"theme_bag_img,omitempty"`
	ThemeColor          string `json:"theme_color,omitempty"`
	NotifyCueTone       string `json:"notify_cue_tone,omitempty"`
	KeyboardEventNotify string `json:"keyboard_event_notify,omitempty"`
}

type SysMessage added in v1.0.0 

type SysMessage struct {
	MsgId    string    `json:"msg_id,omitempty" bson:"msg_id,omitempty"`
	MsgType  string    `json:"msg_type,omitempty" bson:"msg_type,omitempty"`
	TalkType int       `json:"talk_type,omitempty" bson:"talk_type,omitempty"` // 对话类型 1:私聊 2:群聊
	Sender   *Sender   `json:"sender,omitempty" bson:"sender,omitempty"`       // 发送者
	Receiver *Receiver `json:"receiver,omitempty" bson:"receiver,omitempty"`   // 接收者

	Text                   *Text                   `json:"text,omitempty" bson:"text,omitempty"`
	GroupCreate            *GroupCreate            `json:"group_create,omitempty" bson:"group_create,omitempty"`
	GroupJoin              *GroupJoin              `json:"group_join,omitempty" bson:"group_join,omitempty"`
	GroupTransfer          *GroupTransfer          `json:"group_transfer,omitempty" bson:"group_transfer,omitempty"`
	GroupMuted             *GroupMuted             `json:"group_muted,omitempty" bson:"group_muted,omitempty"`
	GroupCancelMuted       *GroupCancelMuted       `json:"group_cancel_muted,omitempty" bson:"group_cancel_muted,omitempty"`
	GroupMemberMuted       *GroupMemberMuted       `json:"group_member_muted,omitempty" bson:"group_member_muted,omitempty"`
	GroupMemberCancelMuted *GroupMemberCancelMuted `json:"group_member_cancel_muted,omitempty" bson:"group_member_cancel_muted,omitempty"`
	GroupDismissed         *GroupDismissed         `json:"group_dismissed,omitempty" bson:"group_dismissed,omitempty"`
	GroupMemberQuit        *GroupMemberQuit        `json:"group_member_quit,omitempty" bson:"group_member_quit,omitempty"`
	GroupMemberKicked      *GroupMemberKicked      `json:"group_member_kicked,omitempty" bson:"group_member_kicked,omitempty"`
	GroupMessageRevoke     *GroupMessageRevoke     `json:"group_message_revoke,omitempty" bson:"group_message_revoke,omitempty"`
	GroupNotice            *GroupNotice            `json:"group_notice,omitempty" bson:"group_notice,omitempty"`
}

type TagDeleteReq added in v1.0.0 

type TagDeleteReq struct {
	TagId string `json:"tag_id,omitempty" v:"required"`
}

笔记标签删除接口请求参数

type TagEditReq added in v1.0.0 

type TagEditReq struct {
	TagId   string `json:"tag_id,omitempty"`
	TagName string `json:"tag_name,omitempty" v:"required"`
}

笔记标签编辑接口请求参数

type TagEditRes added in v1.0.0 

type TagEditRes struct {
	Id string `json:"id,omitempty"`
}

笔记标签编辑接口请求参数

type TagListRes added in v1.0.0 

type TagListRes struct {
	Tags []*NoteTag `json:"tags"`
}

笔记标签列表接口响应参数

type TalkGroupMember added in v1.0.0 

type TalkGroupMember struct {
	UserId   int    `json:"user_id"`  // 用户ID
	Nickname string `json:"nickname"` // 用户昵称
}

type TalkRecord added in v1.0.0 

type TalkRecord struct {
	Id         string `json:"id"`          // ID
	RecordId   int    `json:"record_id"`   // 记录ID
	MsgId      string `json:"msg_id"`      // 消息唯一ID
	Sequence   int64  `json:"sequence"`    // 消息时序ID
	TalkType   int    `json:"talk_type"`   // 对话类型[1:私聊;2:群聊;]
	MsgType    int    `json:"msg_type"`    // 消息类型
	UserId     int    `json:"user_id"`     // 发送者ID[0:系统用户;]
	ReceiverId int    `json:"receiver_id"` // 接收者ID(用户ID 或 群ID)
	IsRevoke   int    `json:"is_revoke"`   // 是否撤回消息[0:否;1:是;]
	IsMark     int    `json:"is_mark"`     // 是否重要消息[0:否;1:是;]
	IsRead     int    `json:"is_read"`     // 是否已读[0:否;1:是;]
	QuoteId    string `json:"quote_id"`    // 引用消息ID
	Content    string `json:"content"`     // 文本消息
	Extra      string `json:"extra"`       // 扩展信信息
	CreatedAt  string `json:"created_at"`  // 创建时间
	UpdatedAt  string `json:"updated_at"`  // 更新时间

	Sender   *Sender   `json:"sender,omitempty"`   // 发送者
	Receiver *Receiver `json:"receiver,omitempty"` // 接收者
	Mention  *Mention  `json:"mention,omitempty"`
	Reply    *Reply    `json:"reply,omitempty"`

	Text     *Text     `json:"text,omitempty"`
	Code     *Code     `json:"code,omitempty"`
	Image    *Image    `json:"image,omitempty"`
	Voice    *Voice    `json:"voice,omitempty"`
	Video    *Video    `json:"video,omitempty"`
	File     *File     `json:"file,omitempty"`
	Vote     *Vote     `json:"vote,omitempty"`
	Mixed    *Mixed    `json:"mixed,omitempty"`
	Emoticon *Emoticon `json:"emoticon,omitempty"`
	Card     *Card     `json:"card,omitempty"`
	Location *Location `json:"location,omitempty"`

	GroupCreate            *GroupCreate            `json:"group_create,omitempty"`
	GroupJoin              *GroupJoin              `json:"group_join,omitempty"`
	GroupTransfer          *GroupTransfer          `json:"group_transfer,omitempty"`
	GroupMuted             *GroupMuted             `json:"group_muted,omitempty"`
	GroupCancelMuted       *GroupCancelMuted       `json:"group_cancel_muted,omitempty"`
	GroupMemberMuted       *GroupMemberMuted       `json:"group_member_muted,omitempty"`
	GroupMemberCancelMuted *GroupMemberCancelMuted `json:"group_member_cancel_muted,omitempty"`
	GroupDismissed         *GroupDismissed         `json:"group_dismissed,omitempty"`
	GroupMemberQuit        *GroupMemberQuit        `json:"group_member_quit,omitempty"`
	GroupMemberKicked      *GroupMemberKicked      `json:"group_member_kicked,omitempty"`
	GroupMessageRevoke     *GroupMessageRevoke     `json:"group_message_revoke,omitempty"`
	GroupNotice            *GroupNotice            `json:"group_notice,omitempty"`

	Login *Login `json:"login,omitempty"`
}

type TalkRecordAudio added in v1.0.0 

type TalkRecordAudio struct {
	Name     string `json:"name"`     // 语音名称
	Suffix   string `json:"suffix"`   // 文件后缀
	Size     int    `json:"size"`     // 语音大小
	Url      string `json:"url"`      // 语音地址
	Duration int    `json:"duration"` // 语音时长
}

type TalkRecordCard added in v1.0.0 

type TalkRecordCard struct {
	UserId int `json:"user_id"` // 名片用户ID
}

type TalkRecordCode added in v1.0.0 

type TalkRecordCode struct {
	Lang string `json:"lang"` // 代码语言
	Code string `json:"code"` // 代码内容
}

type TalkRecordFile added in v1.0.0 

type TalkRecordFile struct {
	Name   string `json:"name"`   // 文件名称
	Drive  int    `json:"drive"`  // 文件存储方式
	Suffix string `json:"suffix"` // 文件后缀
	Size   int    `json:"size"`   // 文件大小
	Path   string `json:"path"`   // 文件路径
}

type TalkRecordForward added in v1.0.0 

type TalkRecordForward struct {
	TalkType   int                 `json:"talk_type"`   // 对话类型
	UserId     int                 `json:"user_id"`     // 发送者ID
	ReceiverId int                 `json:"receiver_id"` // 接收者ID
	RecordsIds []int               `json:"records_ids"` // 消息列表
	Records    []map[string]string `json:"records"`     // 消息快照
}

type TalkRecordGroupCancelMuted added in v1.0.0 

type TalkRecordGroupCancelMuted struct {
	OwnerId   int    `json:"owner_id"`   // 操作人ID
	OwnerName string `json:"owner_name"` // 操作人昵称
}

管理员解除群禁言消息

type TalkRecordGroupCreate added in v1.0.0 

type TalkRecordGroupCreate struct {
	OwnerId   int                `json:"owner_id"`   // 操作人ID
	OwnerName string             `json:"owner_name"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members"`    // 成员列表
}

创建群消息

type TalkRecordGroupDismissed added in v1.0.0 

type TalkRecordGroupDismissed struct {
	OwnerId   int    `json:"owner_id"`   // 操作人ID
	OwnerName string `json:"owner_name"` // 操作人昵称
}

群主解散群消息

type TalkRecordGroupJoin added in v1.0.0 

type TalkRecordGroupJoin struct {
	OwnerId   int                `json:"owner_id"`   // 操作人ID
	OwnerName string             `json:"owner_name"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members"`    // 成员列表
}

群主邀请加入群消息

type TalkRecordGroupMemberCancelMuted added in v1.0.0 

type TalkRecordGroupMemberCancelMuted struct {
	OwnerId   int                `json:"owner_id"`   // 操作人ID
	OwnerName string             `json:"owner_name"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members"`    // 成员列表
}

管理员解除群成员禁言消息

type TalkRecordGroupMemberKicked added in v1.0.0 

type TalkRecordGroupMemberKicked struct {
	OwnerId   int                `json:"owner_id"`   // 操作人ID
	OwnerName string             `json:"owner_name"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members"`    // 成员列表
}

踢出群成员消息

type TalkRecordGroupMemberMuted added in v1.0.0 

type TalkRecordGroupMemberMuted struct {
	OwnerId   int                `json:"owner_id"`   // 操作人ID
	OwnerName string             `json:"owner_name"` // 操作人昵称
	Members   []*TalkGroupMember `json:"members"`    // 成员列表
}

管理员设置群成员禁言消息

type TalkRecordGroupMemberQuit added in v1.0.0 

type TalkRecordGroupMemberQuit struct {
	OwnerId   int    `json:"owner_id"`   // 操作人ID
	OwnerName string `json:"owner_name"` // 操作人昵称
}

群成员退出群消息

type TalkRecordGroupMessageRevoke added in v1.0.0 

type TalkRecordGroupMessageRevoke struct {
	OwnerId         int    `json:"owner_id"`          // 操作人ID
	OwnerName       string `json:"owner_name"`        // 操作人昵称
	RevokeMessageId string `json:"revoke_message_id"` // 被撤回消息ID
}

管理员撤回成员消息

type TalkRecordGroupMuted added in v1.0.0 

type TalkRecordGroupMuted struct {
	OwnerId   int    `json:"owner_id"`   // 操作人ID
	OwnerName string `json:"owner_name"` // 操作人昵称
}

管理员设置群禁言消息

type TalkRecordGroupNotice added in v1.0.0 

type TalkRecordGroupNotice struct {
	OwnerId   int    `json:"owner_id"`   // 操作人ID
	OwnerName string `json:"owner_name"` // 操作人昵称
	Title     string `json:"title"`      // 标题
	Content   string `json:"content"`    // 内容
}

发布群公告

type TalkRecordGroupTransfer added in v1.0.0 

type TalkRecordGroupTransfer struct {
	OldOwnerId   int    `json:"old_owner_id"`   // 老群主ID
	OldOwnerName string `json:"old_owner_name"` // 老群主昵称
	NewOwnerId   int    `json:"new_owner_id"`   // 新群主ID
	NewOwnerName string `json:"new_owner_name"` // 新群主昵称
}

群主转让群消息

type TalkRecordImage added in v1.0.0 

type TalkRecordImage struct {
	Name   string `json:"name"`   // 图片名称
	Suffix string `json:"suffix"` // 图片后缀
	Size   int    `json:"size"`   // 图片大小
	Url    string `json:"url"`    // 图片地址
	Width  int    `json:"width"`  // 图片宽度
	Height int    `json:"height"` // 图片高度
}

type TalkRecordLocation added in v1.0.0 

type TalkRecordLocation struct {
	Longitude   string `json:"longitude"`   // 经度
	Latitude    string `json:"latitude"`    // 纬度
	Description string `json:"description"` // 位置描述
}

type TalkRecordLogin added in v1.0.0 

type TalkRecordLogin struct {
	IP       string `json:"ip"`       // 登录IP
	Address  string `json:"address"`  // 登录地址
	Agent    string `json:"agent"`    // 登录设备
	Platform string `json:"platform"` // 登录平台
	Reason   string `json:"reason"`   // 登录原因
	Datetime string `json:"datetime"` // 登录时间
}

type TalkRecordMixed added in v1.0.0 

type TalkRecordMixed struct {
	Items []*MixedMessage `json:"items"` // 消息内容, 可包含图片, 文字, 表情等多种消息
}

图文混合消息

type TalkRecordMixedItem added in v1.0.0 

type TalkRecordMixedItem struct {
	Type    int    `json:"type"`           // 消息类型, 跟msgtype字段一致
	Content string `json:"content"`        // 消息内容, 可包含图片, 文字, 表情等多种消息
	Link    string `json:"link,omitempty"` // 图片跳转地址
}

type TalkRecordReply added in v1.0.0 

type TalkRecordReply struct {
	UserId   int    `json:"user_id,omitempty"`
	Nickname string `json:"nickname,omitempty"`
	MsgType  int    `json:"msg_type,omitempty"` // 1:文字 2:图片
	Content  string `json:"content,omitempty"`  // 文字或图片链接
	MsgId    string `json:"msg_id,omitempty"`
}

type TalkRecordVideo added in v1.0.0 

type TalkRecordVideo struct {
	Name     string `json:"name"`     // 视频名称
	Cover    string `json:"cover"`    // 视频封面
	Suffix   string `json:"suffix"`   // 文件后缀
	Size     int    `json:"size"`     // 视频大小
	Url      string `json:"url"`      // 视频地址
	Duration int    `json:"duration"` // 视频时长
}

type TalkRecordsItem 

type TalkRecordsItem struct {
	Id         int    `json:"id"`
	Sequence   int    `json:"sequence"`
	MsgId      string `json:"msg_id"`
	TalkType   int    `json:"talk_type"`
	MsgType    int    `json:"msg_type"`
	UserId     int    `json:"user_id"`
	ReceiverId int    `json:"receiver_id"`
	Nickname   string `json:"nickname"`
	Avatar     string `json:"avatar"`
	IsRevoke   int    `json:"is_revoke"`
	IsMark     int    `json:"is_mark"`
	IsRead     int    `json:"is_read"`
	Content    string `json:"content"`
	CreatedAt  string `json:"created_at"`
	Extra      any    `json:"extra"` // 额外参数

	Sender   *Sender   `json:"sender,omitempty"`   // 发送者
	Receiver *Receiver `json:"receiver,omitempty"` // 接收者
	Mention  *Mention  `json:"mention,omitempty"`
	Reply    *Reply    `json:"reply,omitempty"`

	Text     *Text     `json:"text,omitempty"`
	Code     *Code     `json:"code,omitempty"`
	Image    *Image    `json:"image,omitempty"`
	Voice    *Voice    `json:"voice,omitempty"`
	Video    *Video    `json:"video,omitempty"`
	File     *File     `json:"file,omitempty"`
	Vote     *Vote     `json:"vote,omitempty"`
	Mixed    *Mixed    `json:"mixed,omitempty"`
	Emoticon *Emoticon `json:"emoticon,omitempty"`
	Card     *Card     `json:"card,omitempty"`
	Location *Location `json:"location,omitempty"`

	GroupCreate            *GroupCreate            `json:"group_create,omitempty"`
	GroupJoin              *GroupJoin              `json:"group_join,omitempty"`
	GroupTransfer          *GroupTransfer          `json:"group_transfer,omitempty"`
	GroupMuted             *GroupMuted             `json:"group_muted,omitempty"`
	GroupCancelMuted       *GroupCancelMuted       `json:"group_cancel_muted,omitempty"`
	GroupMemberMuted       *GroupMemberMuted       `json:"group_member_muted,omitempty"`
	GroupMemberCancelMuted *GroupMemberCancelMuted `json:"group_member_cancel_muted,omitempty"`
	GroupDismissed         *GroupDismissed         `json:"group_dismissed,omitempty"`
	GroupMemberQuit        *GroupMemberQuit        `json:"group_member_quit,omitempty"`
	GroupMemberKicked      *GroupMemberKicked      `json:"group_member_kicked,omitempty"`
	GroupMessageRevoke     *GroupMessageRevoke     `json:"group_message_revoke,omitempty"`
	GroupNotice            *GroupNotice            `json:"group_notice,omitempty"`

	Login *Login `json:"login,omitempty"`
}

type TalkRecordsReq added in v1.0.0 

type TalkRecordsReq struct {
	TalkType   int `json:"talk_type" v:"required|in:1,2"`  // 对话类型
	MsgType    int `json:"msg_type"`                       // 消息类型
	ReceiverId int `json:"receiver_id" v:"required|min:1"` // 接收者ID
	RecordId   int `json:"record_id"`                      // 上次查询的最小消息ID
	Limit      int `json:"limit" v:"required|max:100"`     // 数据行数
}

type TalkRecordsRes added in v1.0.0 

type TalkRecordsRes struct {
	Limit    int                `json:"limit"`
	RecordId int                `json:"record_id"`
	Items    []*TalkRecordsItem `json:"items"`
}

type TalkSession added in v1.0.0 

type TalkSession struct {
	Id            string `json:"id,omitempty"`
	TalkType      int    `json:"talk_type,omitempty"`
	ReceiverId    int    `json:"receiver_id,omitempty"`
	IsTop         int    `json:"is_top,omitempty"`
	IsDisturb     int    `json:"is_disturb,omitempty"`
	IsOnline      int    `json:"is_online,omitempty"`
	IsRobot       int    `json:"is_robot,omitempty"`
	Name          string `json:"name,omitempty"`
	Avatar        string `json:"avatar,omitempty"`
	Remark        string `json:"remark,omitempty"`
	UnreadNum     int    `json:"unread_num,omitempty"`
	MsgText       string `json:"msg_text,omitempty"`
	UpdatedAt     string `json:"updated_at,omitempty"`
	IsTalk        int    `json:"is_talk,omitempty"`
	IsOpenContext int    `json:"is_open_context"`
}

type Text added in v1.0.0 

type Text struct {
	Content string `json:"content,omitempty" bson:"content,omitempty" v:"required"`
}

文本消息

type TextMessageReq 

type TextMessageReq struct {
	Type       string    `json:"type,omitempty"` // 消息类型
	Content    string    `json:"content,omitempty" v:"required"`
	Mention    *Mention  `json:"mention,omitempty"`
	QuoteId    string    `json:"quote_id,omitempty"` // 引用的消息ID
	Receiver   *Receiver `json:"receiver,omitempty"` // 消息接收者
	TalkType   int       `json:"talk_type" v:"required|in:1,2"`
	ReceiverId int       `json:"receiver_id" v:"required"`
	Text       string    `json:"text" v:"required"`
}

文本消息

type UploadAvatarRes 

type UploadAvatarRes struct {
	Avatar string `json:"avatar,omitempty"`
}

头像上传接口响应参数

type UploadImageRes 

type UploadImageRes struct {
	Src string `json:"src,omitempty"`
}

头像上传接口响应参数

type UploadInitiateMultipartReq 

type UploadInitiateMultipartReq struct {
	FileName string `json:"file_name,omitempty" v:"required"`
	FileSize int64  `json:"file_size,omitempty" v:"required"`
}

批量上传文件初始化接口请求参数

type UploadInitiateMultipartRes 

type UploadInitiateMultipartRes struct {
	UploadId    string `json:"upload_id,omitempty"`
	SplitSize   int    `json:"split_size,omitempty"`
	UploadIdMd5 string `json:"upload_id_md5,omitempty"`
}

批量上传文件初始化接口响应参数

type UploadMultipartReq 

type UploadMultipartReq struct {
	UploadId   string `json:"upload_id,omitempty" v:"required"`
	SplitIndex int    `json:"split_index,omitempty" v:"min:0"`
	SplitNum   int    `json:"split_num,omitempty" v:"required|min:1"`
}

批量上传文件接口请求参数

type UploadMultipartRes 

type UploadMultipartRes struct {
	UploadId string `json:"upload_id,omitempty"`
	IsMerge  bool   `json:"is_merge,omitempty"`
}

批量上传文件接口请求参数

type UploadRes added in v1.0.0 

type UploadRes struct {
	MediaId string `json:"media_id,omitempty"`
	Src     string `json:"src,omitempty"`
}

表情包上传接口响应参数

type User 

type User struct {
	Id        string `json:"_id,omitempty"`        // ID
	UserId    int    `json:"user_id,omitempty"`    // 用户ID
	Mobile    string `json:"mobile,omitempty"`     // 手机号
	Nickname  string `json:"nickname,omitempty"`   // 用户昵称
	Avatar    string `json:"avatar,omitempty"`     // 用户头像地址
	Gender    int    `json:"gender,omitempty"`     // 用户性别  0:未知  1:男   2:女
	Password  string `json:"password,omitempty"`   // 用户密码
	Motto     string `json:"motto,omitempty"`      // 用户座右铭
	Email     string `json:"email,omitempty"`      // 用户邮箱
	Birthday  string `json:"birthday,omitempty"`   // 生日
	IsRobot   int    `json:"is_robot,omitempty"`   // 是否机器人[0:否;1:是;]
	CreatedAt int64  `json:"created_at,omitempty"` // 注册时间
	UpdatedAt int64  `json:"updated_at,omitempty"` // 更新时间
}

type UserDetailRes 

type UserDetailRes struct {
	Id       int    `json:"id"`
	Mobile   string `json:"mobile"`
	Email    string `json:"email"`
	Nickname string `json:"nickname"`
	Avatar   string `json:"avatar"`
	Gender   int    `json:"gender"`
	Motto    string `json:"motto"`
	Birthday string `json:"birthday"`
}

登录用户详情接口响应参数

type UserDetailUpdateReq 

type UserDetailUpdateReq struct {
	Avatar   string `json:"avatar,omitempty"`
	Nickname string `json:"nickname,omitempty" v:"required|max-length:30"`
	Gender   int    `json:"gender,omitempty" v:"in:0,1,2"`
	Motto    string `json:"motto,omitempty" v:"max-length:1024"`
	Birthday string `json:"birthday,omitempty" v:"length:0,10"`
}

用户信息更新接口请求参数

type UserEmailUpdateReq 

type UserEmailUpdateReq struct {
	Email    string `json:"email,omitempty" v:"required"`
	Password string `json:"password,omitempty" v:"required"`
	Code     string `json:"code,omitempty" v:"required|length:0,6"`
}

用户邮箱更新接口请求参数

type UserInfo added in v1.0.0 

type UserInfo struct {
	UserId   int    `json:"uid,omitempty"`
	Nickname string `json:"nickname,omitempty"`
	Avatar   string `json:"avatar,omitempty"`
	Motto    string `json:"motto,omitempty"`
	Gender   int    `json:"gender,omitempty"`
	IsQiye   bool   `json:"is_qiye,omitempty"`
	Mobile   string `json:"mobile,omitempty"`
	Email    string `json:"email,omitempty"`
	Birthday string `json:"birthday,omitempty"` // 生日
}

type UserMobileUpdateReq 

type UserMobileUpdateReq struct {
	Mobile   string `json:"mobile,omitempty" v:"required"`
	Password string `json:"password,omitempty" v:"required"`
	Code     string `json:"code,omitempty" v:"required|length:0,6"`
}

用户手机号更新接口请求参数

type UserPasswordUpdateReq 

type UserPasswordUpdateReq struct {
	OldPassword string `json:"old_password,omitempty" v:"required"`
	NewPassword string `json:"new_password,omitempty" v:"required|min-length:6"`
}

用户密码更新接口请求参数

type UserSettingRes 

type UserSettingRes struct {
	UserInfo *UserInfo    `json:"user_info,omitempty"`
	Setting  *SettingInfo `json:"setting,omitempty"`
}

用户配置信息响应参数

type VerifyInfo added in v1.0.0 

type VerifyInfo struct {
	TalkType          int
	UserId            int
	ReceiverId        int
	IsVerifyGroupMute bool
}

type Video added in v1.0.0 

type Video struct {
	Url      string `json:"url,omitempty" bson:"url,omitempty" v:"required"`           // 视频地址
	Duration int    `json:"duration,omitempty" bson:"duration,omitempty" v:"required"` // 视频时长
	Size     int    `json:"size,omitempty" bson:"size,omitempty" v:"required"`         // 视频大小
	Cover    string `json:"cover,omitempty" bson:"cover,omitempty"`                    // 视频封面
	Name     string `json:"name,omitempty" bson:"name,omitempty"`                      // 视频名称
	Suffix   string `json:"suffix,omitempty" bson:"suffix,omitempty"`                  // 文件后缀
}

视频文件消息

type VideoMessageReq 

type VideoMessageReq struct {
	Type     string    `json:"type,omitempty"`
	Url      string    `json:"url,omitempty" v:"required"`
	Duration int       `json:"duration,omitempty" v:"required"`
	Size     int       `json:"size,omitempty" v:"required"` // 视频大小
	Receiver *Receiver `json:"receiver,omitempty"`          // 消息接收者
	Cover    string    `json:"cover,omitempty"`             // 封面图
}

视频文件消息

type Vip added in v1.1.0 

type Vip struct {
	Level       int      `json:"level,omitempty"`        // 等级
	Name        string   `json:"name,omitempty"`         // 名称
	Models      []string `json:"models,omitempty"`       // 模型权限
	FreeTokens  int      `json:"free_tokens,omitempty"`  // 免费额度
	MinuteLimit int      `json:"minute_limit,omitempty"` // 分钟限额
	DailyLimit  int      `json:"daily_limit,omitempty"`  // 每日限额
	Remark      string   `json:"remark,omitempty"`       // 备注
	Status      int      `json:"status,omitempty"`       // 状态[1:正常;2:下线;-1:删除]
	CreatedAt   int64    `json:"created_at,omitempty"`   // 创建时间
	UpdatedAt   int64    `json:"updated_at,omitempty"`   // 更新时间
}

type VipInfo added in v1.1.0 

type VipInfo struct {
	VipName     string `json:"vip_name"`     // 会员等级名称
	UserId      int    `json:"user_id"`      // 用户ID
	Nickname    string `json:"nickname"`     // 昵称
	Avatar      string `json:"avatar"`       // 头像
	SecretKey   string `json:"secret_key"`   // 密钥
	RegTime     string `json:"reg_time"`     // 注册时间
	UsageCount  int    `json:"usage_count"`  // 使用次数
	UsedTokens  int    `json:"used_tokens"`  // 已用Tokens
	TotalTokens int    `json:"total_tokens"` // 总Tokens
}

type VipsRes added in v1.1.0 

type VipsRes struct {
	Items []*Vip `json:"items"`
}

登录用户详情接口响应参数

type Voice added in v1.0.0 

type Voice struct {
	Url      string `json:"url,omitempty" bson:"url,omitempty" v:"required"`           // 语音地址
	Duration int    `json:"duration,omitempty" bson:"duration,omitempty" v:"required"` // 语音时长
	Size     int    `json:"size,omitempty" bson:"size,omitempty" v:"required"`         // 语音大小
	Name     string `json:"name,omitempty" bson:"name,omitempty"`                      // 语音名称
	Suffix   string `json:"suffix,omitempty" bson:"suffix,omitempty"`                  // 文件后缀
}

语音消息

type VoiceMessageReq 

type VoiceMessageReq struct {
	Type     string    `json:"type,omitempty"`
	Url      string    `json:"url,omitempty" v:"required"`
	Duration int       `json:"duration,omitempty" v:"required"`
	Size     int       `json:"size,omitempty" v:"required"` // 语音大小
	Receiver *Receiver `json:"receiver,omitempty"`          // 消息接收者
}

语音消息

type Vote added in v1.0.0 

type Vote struct {
	Title         string          `json:"title,omitempty" bson:"title,omitempty" v:"required"`       // 投票标题
	AnswerMode    int             `json:"answer_mode,omitempty" bson:"answer_mode,omitempty"`        // 答题模式[0:单选;1:多选;]
	Anonymous     int             `json:"anonymous,omitempty" bson:"anonymous,omitempty" v:"in:0,1"` // 匿名投票[0:否;1:是;]
	AnswerOptions []*AnswerOption `json:"answer_options,omitempty" bson:"answer_options,omitempty"`  // 答题选项
	AnswerNum     int             `json:"answer_num,omitempty" bson:"answer_num,omitempty"`          // 应答人数
	AnsweredNum   int             `json:"answered_num,omitempty" bson:"answered_num,omitempty"`      // 已答人数
	Status        int             `json:"status,omitempty" bson:"status,omitempty"`                  // 投票状态[0:投票中;1:已完成;]
}

投票消息接口请求参数

type VoteStatistics added in v1.0.0 

type VoteStatistics struct {
	Count   int            `json:"count"`
	Options map[string]int `json:"options"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.