Skip to content

Message Management

Important Note

Message Management enables users to conduct targeted information delivery within the application, suitable for point-to-point communication or specific group notifications. Business messages can be sent through both in-app messaging and email channels.

Key Features

1. Precise Message Delivery

  • Multi-format Support: Send text content, hyperlinks, file attachments, etc.
  • Dual-channel Delivery: Messages are delivered simultaneously via in-app messaging and email.
  • Target Selection: Direct messages to specific users/departments/user groups.

2. Unified Message Reception

  • Aggregated Inbox: In-app messages and emails are consolidated and displayed in one place.
  • Priority Indicators: Unread messages are automatically pinned and marked with a count.
  • Cross-device Sync: Real-time status synchronization between desktop and mobile devices.

3. Interaction Tracking

  • Read Status: Real-time display of read/unread status indicators.
  • Interaction Markers: Flags indicating whether messages have been replied to or forwarded.
  • Timeliness Monitoring: Displays message arrival time and last viewed time.

Message Information

ParameterField NameTypeRequiredLength/Quantity LimitDescription
IDidbigintRead-only/Unique message identifier;
Automatically generated by the system.
TitletitlestringYes≤100Message subject.
ContentcontentstringYes≤8000Message body content.
Receive TypereceiveTypestringYes≤16Delivery Channel:
- SITE: In-app message
- EMAIL: Email message.
Send TypesendTypestringYes≤16Delivery Method:
- SEND_NOW: Send immediately
- TIMED_SEND: Scheduled send.
Send TimetimingDatedatetimeConditional/Scheduled send time; Required when sendType is TIMED_SEND.
Receive Tenant IDreceiveTenantIdbigintNo/Recipient tenant ID.
Receive Tenant NamereceiveTenantNamestringNo≤100Recipient tenant name.
Receive Object TypereceiveObjectTypestringYes≤16Recipient Type:
USER: User, DEPT: Department, GROUP: Group, TENANT: Tenant, ALL_USER: All users.
Receive ObjectreceiveObjectDatajsonNo/Detailed recipient information.
Message StatusstatusstringRead-only/Current Status:
- PENDING: Pending send
- SENT: Sent.
Failure ReasonfailureReasonstringRead-only/Reason for send failure.
Sent CountsentNumintRead-only/Number of recipients the message was sent to.
Read CountreadNumintRead-only/Number of recipients who read the message.
Actual Send TimesendDatedatetimeRead-only/Actual send time.
Sender Tenant IDtenantIdbigintRead-only/Sender tenant ID.
SendercreatedBybigintRead-only/Message creator ID.
Creator NamecreatedByNamestringRead-only/Creator's name.
Creation TimecreatedDatedatetimeRead-only/Message creation time.

Receive Type (receiveType)

Enum ValueDelivery ChannelDescription
SITEIn-app MessageReceived via system inbox.
EMAILEmail MessageDelivered via email.

Send Type (sendType)

Enum ValueDelivery MethodDescription
SEND_NOWImmediate SendSent immediately upon creation.
TIMED_SENDScheduled SendSent automatically at a specified time.

Receive Object Type (receiveObjectType)

Enum ValueRecipient TypeDescription
USERUserSent to specified users.
DEPTDepartmentSent to all department members.
GROUPGroupSent to specific group members.
TENANTTenantSent to all tenant members.
ALL_USERAll UsersSent to all system users.

Released under the GPL-3.0 License.