Overview
The Chat API provides functionality for managing:
- Real-time messaging
- Conversation tracking
- Message delivery
- Read receipts
- Attachments
Core Concepts
Chat Types
| Type | Description | Features |
|---|
direct | One-on-one chat | Private messaging |
group | Multi-user chat | Group messaging |
Message Types
| Type | Description | Supported Formats |
|---|
text | Text message | Plain text |
image | Image message | JPEG, PNG |
file | File attachment | PDF, DOC |
system | System message | Notifications |
Message Status
| Status | Description | Next States |
|---|
sent | Message sent | delivered, failed |
delivered | Reached recipient | read |
read | Seen by recipient | - |
failed | Delivery failed | sent |
Chat Settings
| Setting | Description | Default |
|---|
notifications | Enable notifications | true |
muted | Mute all messages | false |
mute_until | Temporary mute | null |
| Field | Description | Example |
|---|
title | Chat title | ”Project Chat” |
description | Chat description | ”Team discussion” |
reply_to | Referenced message | message_uuid |
mentions | @mentioned users | [user_uuid] |
Validation Rules
Message Rules
- Max length: 4000 chars
- File size: ≤ 10MB
- Valid content type
- Active participants
Chat Rules
- Min 2 participants
- Valid user IDs
- Active users only
- Unique participants
Security Requirements
- User authentication
- Message encryption
- File scanning
- Rate limiting
- Audit logging
See individual endpoint documentation for detailed request/response formats and examples.
