txim/api/param/request.go

package param

import (
	"gitee.ltd/lxh/txim/callback"
	"gitee.ltd/lxh/txim/common"
)

// AccountImportReq 单个账号导入
type AccountImportReq struct {
	Identifier string `json:"Identifier"` // 用户名，长度不超过32字节
	Nick       string `json:"Nick"`       // 用户昵称
	FaceUrl    string `json:"FaceUrl"`    // 用户头像 URL
}

// ========================================================

// AccountCheckReq 账号查询
type AccountCheckReq struct {
	CheckItem []*AccountCheckReqItem `json:"CheckItem"`
}

// AccountCheckReqItem 账号查询条件
type AccountCheckReqItem struct {
	UserID string `json:"UserID"`
}

// ========================================================

// AccountDeleteReq 账号删除
type AccountDeleteReq struct {
	DeleteItem []*AccountDeleteReqItem `json:"DeleteItem"`
}

// AccountDeleteReqItem 账号删除条件
type AccountDeleteReqItem struct {
	UserID string `json:"UserID"`
}

// ========================================================

// GroupCreateReq 建群
type GroupCreateReq struct {
	OwnerAccount string            `json:"Owner_Account"` // 群主的 UserId（选填）
	Type         common.GroupType  `json:"Type"`          // 群组类型(不支持创建直播群)
	Name         string            `json:"Name"`          // 群名称（必填）
	GroupId      string            `json:"GroupId"`       // 自定义的群组Id
	MemberList   []GroupMemberItem `json:"MemberList"`    // 群组成员
	//ApplyJoinOption string            `json:"ApplyJoinOption"` // 申请加群处理方式（选填） -> FreeAccess（自由加入），NeedPermission（需要验证），DisableApply（禁止加群），不填默认为 NeedPermission（需要验证）
}

// GroupMemberItem 群成员
type GroupMemberItem struct {
	MemberAccount string `json:"Member_Account"` // 群成员 UserId（必填）
	//Role          string `json:"Role"`           // 群成员身份（选填）
}

// ========================================================

// ProfileSetReq 资料设置
type ProfileSetReq struct {
	FromAccount string               `json:"From_Account"`
	ProfileItem []*ProfileSetReqItem `json:"ProfileItem"`
}

// ProfileSetReqItem 资料设置条件
type ProfileSetReqItem struct {
	Tag   string      `json:"Tag"`
	Value interface{} `json:"Value"`
}

// ========================================================

// PushOrdinaryMsgToGroupReq 发送普通群聊普通消息参数
type PushOrdinaryMsgToGroupReq struct {
	GroupId     string                `json:"GroupId"`      // 群组Id
	FromAccount string                `json:"From_Account"` // 发信人
	Random      int                   `json:"Random"`       // 随机数
	MsgBody     []callback.TIMMessage `json:"MsgBody"`      // 消息内容
}

// PushMessageToUserReq 给用户发单聊消息参数
type PushMessageToUserReq struct {
	FromAccount string                `json:"From_Account"` // 发信人
	ToAccount   string                `json:"To_Account"`   // 收信人
	Random      int                   `json:"MsgRandom"`    // 随机数
	MsgBody     []callback.TIMMessage `json:"MsgBody"`      // 消息内容
}