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
| Parameter | Field Name | Type | Required | Length/Quantity Limit | Description |
|---|---|---|---|---|---|
| ID | id | bigint | Read-only | / | Unique message identifier; Automatically generated by the system. |
| Title | title | string | Yes | ≤100 | Message subject. |
| Content | content | string | Yes | ≤8000 | Message body content. |
| Receive Type | receiveType | string | Yes | ≤16 | Delivery Channel: - SITE: In-app message - EMAIL: Email message. |
| Send Type | sendType | string | Yes | ≤16 | Delivery Method: - SEND_NOW: Send immediately - TIMED_SEND: Scheduled send. |
| Send Time | timingDate | datetime | Conditional | / | Scheduled send time; Required when sendType is TIMED_SEND. |
| Receive Tenant ID | receiveTenantId | bigint | No | / | Recipient tenant ID. |
| Receive Tenant Name | receiveTenantName | string | No | ≤100 | Recipient tenant name. |
| Receive Object Type | receiveObjectType | string | Yes | ≤16 | Recipient Type: USER: User, DEPT: Department, GROUP: Group, TENANT: Tenant, ALL_USER: All users. |
| Receive Object | receiveObjectData | json | No | / | Detailed recipient information. |
| Message Status | status | string | Read-only | / | Current Status: - PENDING: Pending send - SENT: Sent. |
| Failure Reason | failureReason | string | Read-only | / | Reason for send failure. |
| Sent Count | sentNum | int | Read-only | / | Number of recipients the message was sent to. |
| Read Count | readNum | int | Read-only | / | Number of recipients who read the message. |
| Actual Send Time | sendDate | datetime | Read-only | / | Actual send time. |
| Sender Tenant ID | tenantId | bigint | Read-only | / | Sender tenant ID. |
| Sender | createdBy | bigint | Read-only | / | Message creator ID. |
| Creator Name | createdByName | string | Read-only | / | Creator's name. |
| Creation Time | createdDate | datetime | Read-only | / | Message creation time. |
Receive Type (receiveType)
| Enum Value | Delivery Channel | Description |
|---|---|---|
SITE | In-app Message | Received via system inbox. |
EMAIL | Email Message | Delivered via email. |
Send Type (sendType)
| Enum Value | Delivery Method | Description |
|---|---|---|
SEND_NOW | Immediate Send | Sent immediately upon creation. |
TIMED_SEND | Scheduled Send | Sent automatically at a specified time. |
Receive Object Type (receiveObjectType)
| Enum Value | Recipient Type | Description |
|---|---|---|
USER | User | Sent to specified users. |
DEPT | Department | Sent to all department members. |
GROUP | Group | Sent to specific group members. |
TENANT | Tenant | Sent to all tenant members. |
ALL_USER | All Users | Sent to all system users. |