Files
EdgeCommon/pkg/rpc/protos/service_message_recipient.proto
2023-10-14 17:15:52 +08:00

96 lines
2.7 KiB
Protocol Buffer

syntax = "proto3";
option go_package = "./pb";
package pb;
import "models/model_message_recipient.proto";
import "models/rpc_messages.proto";
// 消息接收人
service MessageRecipientService {
// 创建接收人
rpc createMessageRecipient (CreateMessageRecipientRequest) returns (CreateMessageRecipientResponse);
// 修改接收人
rpc updateMessageRecipient (UpdateMessageRecipientRequest) returns (RPCSuccess);
// 删除接收人
rpc deleteMessageRecipient (DeleteMessageRecipientRequest) returns (RPCSuccess);
// 计算接收人数量
rpc countAllEnabledMessageRecipients (CountAllEnabledMessageRecipientsRequest) returns (RPCCountResponse);
// 列出单页接收人
rpc listEnabledMessageRecipients (ListEnabledMessageRecipientsRequest) returns (ListEnabledMessageRecipientsResponse);
// 查找单个接收人信息
rpc findEnabledMessageRecipient (FindEnabledMessageRecipientRequest) returns (FindEnabledMessageRecipientResponse);
}
// 创建接收人
message CreateMessageRecipientRequest {
int64 adminId = 1; // 关联的管理员ID
int64 messageMediaInstanceId = 2; // 媒介实例ID
repeated int64 messageRecipientGroupIds = 3; // 所属分组ID列表
string description = 4; // 可选项,备注描述
string user = 5; // 用户标识
string timeFrom = 6; // 可选项,接收消息的,开始时间
string timeTo = 7; // 可选项,接收消息的,结束时间
repeated int64 nodeClusterIds = 8; // 关联的CDN边缘节点集群ID列表
}
message CreateMessageRecipientResponse {
int64 messageRecipientId = 1;
}
// 修改接收人
message UpdateMessageRecipientRequest {
int64 messageRecipientId = 1;
int64 adminId = 2;
int64 messageMediaInstanceId = 3;
repeated int64 messageRecipientGroupIds = 4;
string description = 5;
bool isOn = 6;
string user = 7;
string timeFrom = 8;
string timeTo = 9;
repeated int64 nodeClusterIds = 10; // 关联的CDN边缘节点集群ID列表
}
// 删除接收人
message DeleteMessageRecipientRequest {
int64 messageRecipientId = 1;
}
// 计算接收人数量
message CountAllEnabledMessageRecipientsRequest {
int64 adminId = 1;
string mediaType = 2;
int64 messageRecipientGroupId = 3;
string keyword = 4;
}
// 列出单页接收人
message ListEnabledMessageRecipientsRequest {
int64 adminId = 1;
string mediaType = 2;
int64 messageRecipientGroupId = 3;
string keyword = 4;
int64 offset = 5;
int64 size = 6;
}
message ListEnabledMessageRecipientsResponse {
repeated MessageRecipient messageRecipients = 1;
}
// 查找单个接收人信息
message FindEnabledMessageRecipientRequest {
int64 messageRecipientId = 1;
}
message FindEnabledMessageRecipientResponse {
MessageRecipient messageRecipient = 1;
}