System constants provide the canonical values used by YS Desk APIs, Web Chat, real-time events, billing, and permission systems.
Conversation Status
| Value | Meaning |
| OPEN | Active Conversation. |
| RESOLVED | Resolved Conversation. |
| REOPENED | Conversation reopened by new Visitor activity. |
| CLOSED | Legacy/internal persistence value only. |
Message Status
| Value | Meaning |
| PENDING | Client-side optimistic state. |
| SENT | Persisted successfully. |
| DELIVERED | Delivered through the messaging transport. |
| SEEN | Read by the recipient. |
| FAILED | Delivery or validation failed. |
Message Type
| Value | Meaning |
| REGULAR | Standard message. |
| SYSTEM_PROMPT | System-generated event or notice. |
| AUTOMATED_RESPONSE | Automated response. |
Roles
| Value | Meaning |
| OWNER | Workspace owner with full administrative control. |
| ADMIN | Workspace administrator. |
| AGENT | Team Member who handles Conversations. |
| GUEST | External Visitor. |
| SYSTEM | Internal automated actor. |
Channel Types
WEB, WHATSAPP, MOBILE, WORDPRESS, SHOPIFY
Channel Statuses
ACTIVE, PAUSED, TRASH, PURGED
Workspace Statuses
ACTIVE, SUSPENDED, PENDING_DELETION, PURGED
Visibility
| Value | Meaning |
| PUBLIC | Available according to the associated Workspace access rules. |
| PRIVATE | Restricted to the creator or supported private scope. |
CSAT Scale
CSAT ratings use integer values from:
1 through 5
Assignment Action
ASSIGNED, UNASSIGNED
Notification Frequency
IMMEDIATE, SIX_HOURS, TWELVE_HOURS, TWENTY_FOUR_HOURS, NONE
Subscription Plans
FREE, STARTER, GROWTH, ENTERPRISE
Subscription Statuses
active, pending, trialing, past_due, cancelled
Payment Providers
razorpay, paypal, mock
Payment Statuses
created, authorized, captured, failed, refunded
Billing Cycles
monthly, annual
Refund Statuses
NONE, REQUESTED, PROCESSING, REFUNDED, EXPIRED
Refund Window
The verified refund eligibility window is 14 days where applicable.
Billing Grace Period
The verified past_due subscription grace period is 7 days.
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk