MessageCenter/api/message.api

syntax = "v1"

info(
	title: // TODO: add title
	desc: // TODO: add description
	author: "jiaojiao7"
	email: "renjiaojiao@topnet.net.cn"
)

type MessageDeleteReq {
	Id    string `form:"id"`
	AppId string `form:"appId"`
}

type response {
	Code    int64  `json:"code"`
	Message string `json:"message"`
}

//查询消息详情
type MessageDetailReq {
	Id string `form:"id"`
}
type MessageDetailResp {
	Code    int64                  `json:"code"`
	Message string                 `json:"message"`
	Data    map[string]interface{} `json:"data"`
}
type MessageGetLastReq {
	UserId  string `form:"userId"`
	AppId   string `form:"appId"`
	MsgType int64  `form:"msgType"`
	IsRead  int64  `form:"isRead"` // 1 0 -1
}
type MessageGetLastRes {
	Code    int64                  `json:"code"`
	Message string                 `json:"message"`
	Data    map[string]interface{} `json:"data"`
}
type MessageFindReq {
	UserId string `form:"userId"`
	AppId  string `form:"appId"`
	//    MsgType int64 `form:"msgType"`
	ReceiveUserId string `form:"receiveUserId"`
	MsgType       int64  `form:"msgType"`  // 是否限制消息类型  -1 不限制
	IsRead        int64  `form:"isRead"`   // 是否限制未读    -1 不限制
	Offset        int64  `form:"offset"`   // 页数
	PageSize      int64  `form:"pageSize"` //
}
type MessageFindRes {
	Code    int64                    `json:"code"`
	Message string                   `json:"message"`
	Data    []map[string]interface{} `json:"data"`
	Total   int64                    `json:"total"`
}
type MessageUnreadClassCountReq {
	UserId string `form:"userId"`
	AppId  string `form:"appId"`
}

type MessageUnreadClassCountRes {
	Code    int64                    `json:"code"`
	Message string                   `json:"message"`
	Data    []map[string]interface{} `json:"data"`
}
type MessageUnreadCountReq {
	UserId string `form:"userId"`
	AppId  string `form:"appId"`
}
type MessageUnreadCountRes {
	Code    int64                  `json:"code"`
	Message string                 `json:"message"`
	Data    map[string]interface{} `json:"data"`
}
type MessageTypeReq {
	UserId string `form:"userId"`
	AppId  string `form:"appId"`
}
type MessageTypeRes {
	Code    int64   `json:"code"`
	Message string  `json:"message"`
	Data    []int64 `json:"data"`
}

//修改指定用户某个分类的消息为已读
type MsgReadStatusReq {
	UserId  string `form:"userId"`
	AppId   string `form:"appId"`
	MsgType int    `form:"msgType"`
}
type MsgReadStatusResp {
	Code    int64  `json:"code"`
	Message string `json:"message"`
	Status  int64  `json:"status"`
}

type MarkReadReq {
	MsgId string `form:"msgId"`
	AppId string `form:"appId"`
}
type MarkReadRes {
	Code    int64  `json:"code"`
	Message string `json:"message"`
	Data    int64  `json:"data"`
}

//给指定用户发送消息
type SendMsgReq {
	ReceiveUserId string `form:"receiveUserId"`        //接收方的用户id
	ReceiveName   string `form:"receiveName,optional"` //接收方的用户名
	SendUserId    string `form:"sendUserId"`           //发送方的用户id
	SendName      string `form:"sendName"`             //发送方的用户名
	Title         string `form:"title"`                //标题
	Content       string `form:"content"`              //内容
	MsgType       int64  `form:"msgType"`              // 消息类型
	Link          string `form:"link,optional"`        //连接
	CiteId        int64  `form:"citeId,optional"`      //应用id
	Appid         string `form:"appid"`
}
type SendMsgResp {
	Code    int64  `json:"code"`
	Message string `json:"message"`
	Status  int64  `json:"status"`
}

//批量保存消息
type MultipleSaveMsgReq {
	MsgInfo     map[string]interface{} `json:"msgInfo"`
	UserIds     string                 `json:"userIds"`
	UserNames   string                 `json:"userNames"`
	PositionIds string                 `json:"positionIds,optional"` // 职位id 如果是多个就逗号分割 和用户id一一对应
}
type MultipleSaveMsgResp {
	Code     int64  `json:"code"`
	Message  string `json:"message"`
	ErrCount int64  `json:"errCount"`
}

type GetBuoyMsgReq {
	UserId string `header:"mgoUserId"`
	AppId  string `header:"appId"`
	Size   int64  `json:"size,optional"`
}

type GetBuoyMsgResp {
	Code    int64                    `json:"error_code"`
	Message string                   `json:"error_msg"`
	Data    []map[string]interface{} `json:"data"`
}

type ClearUnreadMsgReq {
	UserId     string `header:"mgoUserId"`
	AppId      string `header:"appId"`
	EntId      int64  `header:"entId,optional"`
	PositionId int64  `header:"positionId,optional"`
}

type MessageListReq {
	UserId     string `header:"mgoUserId"`
	AppId      string `header:"appId"`
	EntId      int64  `header:"entId,optional"`
	SortSize   int64  `json:"sortSize,optional"` //分类获取数
	Offset     int64  `json:"offset"`            //
	Size       int64  `json:"size,optional"`
	MsgType    int64  `json:"msgType,optional"`
	IsRead     int64  `json:"isRead,optional"`
	IsPc       bool   `json:"isPc"`
	MobileHome bool   `json:"mobileHome"`
}

type MessageListResp {
	Code    int64                    `json:"code"`
	Message string                   `json:"message"`
	Data    []map[string]interface{} `json:"data"`
	Last    map[string]interface{}   `json:"last"`
	Total   int64                    `json:"total"`
	Column  []map[string]interface{} `json:"column"`
}

service message-api {
	//删除消息
	@handler MessageDeleteHandler // TODO: set handler name and delete this comment
	get /messageCenter/messageDelete (MessageDeleteReq) returns (response)
	//查询消息详情
	@handler MessageDetailHandler // TODO: set handler name and delete this comment
	get /messageCenter/messageDetail (MessageDetailReq) returns (MessageDetailResp)
	// 获取指定类型的最新一条未读消息
	@handler MessageGetLastHandler
	post /messageCenter/messageGetLast (MessageGetLastReq) returns (MessageGetLastRes)
	// 获取指定用户的历史消息  条件可选 消息类型 是否未读
	@handler MessageFindHandler
	post /messageCenter/messageFind (MessageFindReq) returns (MessageFindRes)
	// 获取用户收到的消息分类及未读消息数量
	@handler MessageUnreadClassCountHandler
	post /messageCenter/messageUnreadClassCount (MessageUnreadClassCountReq) returns (MessageUnreadClassCountRes)
	// 获取用户未读消息总量
	@handler MessageUnreadCountHandler
	post /messageCenter/messageUnreadCount (MessageUnreadCountReq) returns (MessageUnreadCountRes)
	// 获取用户接收到的消息分类
	@handler MessageTypeHandler
	get /messageCenter/messageType (MessageTypeReq) returns (MessageTypeRes)
	// 修改指定用户的某个分类的消息为已读
	@handler MessageSetReadStatusHandler
	post /messageCenter/messageSetReadStatus (MsgReadStatusReq) returns (MsgReadStatusResp)
	// 标记为已读
	@handler MarkReadHandler
	post /messageCenter/markRead (MarkReadReq) returns (MarkReadRes)
	// 发送消息
	@handler SendMsgHandler
	post /messageCenter/SendMsg (SendMsgReq) returns (SendMsgResp)
	
	// 发送消息
	@handler MultipleSaveMsgHandler
	post /messageCenter/MultipleSaveMsg (MultipleSaveMsgReq) returns (MultipleSaveMsgResp)
	
	// 查询浮标信息
	@handler GetBuoyMsgHandler
	post /messageCenter/GetBuoyMsg (GetBuoyMsgReq) returns (GetBuoyMsgResp)
	
	// 一键清空未读消息
	@handler ClearUnreadMessages
	post /messageCenter/ClearUnreadMsg (ClearUnreadMsgReq) returns (response)
	
	@handler MessageList
	post /messageCenter/MessageList (MessageListReq) returns (MessageListResp)
}