Skip to content

feat: add supported features guide for all channels #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions config/sidebar/selfhosted.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ module.exports = [
"self-hosted/deployment/architecture",
"self-hosted/deployment/requirements",
{
"Linux": [
Linux: [
"self-hosted/deployment/linux-vm",
"self-hosted/deployment/docker",
],
Expand All @@ -28,7 +28,7 @@ module.exports = [
type: "category",
items: [
{
"AWS": [
AWS: [
"self-hosted/deployment/aws",
"self-hosted/deployment/aws-marketplace",
],
Expand Down Expand Up @@ -57,20 +57,20 @@ module.exports = [
items: [
"self-hosted/configuration/environment-variables",
{
"Performance": [
Performance: [
"self-hosted/deployment/performance/optimizing-configurations",
"self-hosted/deployment/performance/cloudfront-cdn",
]
],
},
{
"Monitoring": [
Monitoring: [
"self-hosted/monitoring/super-admin-sidekiq",
"self-hosted/monitoring/apm-and-error-monitoring",
"self-hosted/monitoring/rate-limiting",
],
},
{
"Storage": [
Storage: [
"self-hosted/deployment/storage/supported-providers",
"self-hosted/deployment/storage/s3-bucket",
"self-hosted/deployment/storage/gcs-bucket",
Expand All @@ -86,11 +86,8 @@ module.exports = [
],
},
{
"Help Center": [
"self-hosted/configuration/help-center",
],
"Help Center": ["self-hosted/configuration/help-center"],
},

],
},
{
Expand All @@ -103,18 +100,14 @@ module.exports = [
"self-hosted/configuration/features/integrations/instagram-via-instagram-business-login",
"self-hosted/configuration/features/integrations/slack-integration-setup",
"self-hosted/configuration/features/integrations/linear-integration-setup",
"self-hosted/configuration/features/integrations/shopify-integration-setup"

"self-hosted/configuration/features/integrations/shopify-integration-setup",
],
},
{
collapsible: true,
label: "Maintenance",
type: "category",
items: [
"self-hosted/deployment/upgrade",
"self-hosted/deployment/backup",
],
items: ["self-hosted/deployment/upgrade", "self-hosted/deployment/backup"],
},
{
type: "category",
Expand All @@ -130,6 +123,12 @@ module.exports = [
{
type: "category",
label: "Others",
items: ["self-hosted/telemetry", "self-hosted/enterprise-edition", "self-hosted/restricted-instances", "self-hosted/faq"],
items: [
"self-hosted/telemetry",
"self-hosted/enterprise-edition",
"self-hosted/supported-features",
"self-hosted/restricted-instances",
"self-hosted/faq",
],
},
];
1 change: 1 addition & 0 deletions docs/self-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,5 +87,6 @@ This guide will help you to install and setup a production ready Chatwoot.

- [Telemetry](/docs/self-hosted/telemetry)
- [Enterprise Edition](/docs/self-hosted/enterprise-edition)
- [Supported features](/docs/self-hosted/supported-features)
- [Restricted Instances](/docs/self-hosted/restricted-instances)
- [FAQ](/docs/self-hosted/faq)
166 changes: 166 additions & 0 deletions docs/self-hosted/supported-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
---
sidebar_label: "Supported features"
title: "Supported features on channels"
---

### Supported message type

<div class="table table-striped">

| Channel | Incoming/Outgoing message | Activity message |
| --------- | ------------------------- | ---------------- |
| Website | Yes | Yes |
| Facebook | Yes | Yes |
| Instagram | Yes | Yes |
| SMS | Yes | Yes |
| Whatsapp | Yes | Yes |
| Email | Yes | Yes |
| Telegram | Yes | Yes |
| Line | Yes | Yes |
| API | Yes | Yes |

</div>

### Maximum message size (number of characters)

<div class="table table-striped">

| Channel | Maximum message size |
| ------------------ | -------------------- |
| Website | 10,000 |
| Facebook | 2000 |
| Instagram | 1000 |
| Twilio SMS | 320 |
| Twilio WhatsApp | 1600 |
| Whatsapp Cloud | 4096 |
| 360Dialog WhatsApp | 1600 |
| Bandwidth SMS | 160 |
| Email | 25,000 |
| Telegram | 4096 |
| Line | 2000 |
| API | 10,000 |

</div>

### Outbound conversation restriction

<div class="table table-striped">

| Channel | Restriction |
| --------- | --------------------------------------------------------------------------------------------------------------- |
| Website | You can create outbound conversations to verified contacts |
| Facebook | Cannot create outbound conversations. First message should be from the contact |
| Instagram | Cannot create outbound conversations. First message should be from the contact |
| SMS | No restriction |
| Whatsapp | Cannot send any message other than Whatsapp approved template messages 24 hours after the last incoming message |
| Email | No restriction |
| Telegram | Cannot create outbound conversations. First message should be from the contact |
| Line | Cannot create outbound conversations. First message should be from the contact |
| API | No restriction |

</div>

### Outgoing message restriction

<div class="table table-striped">

| Channel | Restriction |
| --------- | --------------------------------------------------------------------------------------------------------------- |
| Website | No restriction |
| Facebook | Cannot send promotional messages 24 hours after the last incoming message (7 days if Human agent enabled) |
| Instagram | Cannot send promotional messages 24 hours after the last incoming message (7 days if Human agent enabled) |
| Whatsapp | Cannot send any message other than Whatsapp approved template messages 24 hours after the last incoming message |
| SMS | No restriction |
| Email | No restriction |
| Telegram | No restriction |
| Line | No restriction |
| API | Custom time depends on Agent reply time window |

</div>

### Outgoing message delivery status

<div class="table table-striped">

| Channel | Sent status | Read status | Delivered status | Failed status |
| ------------------ | ----------- | ------------- | ---------------- | ------------- |
| Website | Yes | Yes | Yes | Yes |
| API | Yes | Yes | Yes | Yes |
| Official WhatsApp | Yes | Yes | Yes | Yes |
| Twilio WhatsApp | Yes | Yes | Yes | Yes |
| 360Dialog WhatsApp | Yes | Yes | Yes | Yes |
| Twilio SMS | Yes | Yes | Not supported | Yes |
| Bandwidth SMS | Yes | Yes | Not supported | Yes |
| Facebook | Yes | Yes | Yes | Yes |
| Instagram | Yes | Not supported | Yes | Yes |
| Line | Yes | Not supported | Not supported | Yes |
| Telegram | Yes | Not supported | Not supported | Yes |
| Email | Yes | Not supported | Not supported | Not supported |

</div>

### Reply to message

<div class="table table-striped">

| Channel | Reply to incoming message | Reply to outgoing message |
| --------------- | ------------------------- | ------------------------- |
| Website | Yes | Yes |
| Facebook | Yes | No |
| Instagram | Yes | No |
| SMS | No | No |
| Whatsapp Cloud | Yes | Yes |
| Twilio WhatsApp | No | No |
| Email | No | No |
| Telegram | Yes | Yes |
| Line | No | No |
| API | Yes | Yes |

</div>

### Outgoing attachments supported file types

> Note: The default maximum file size limit is 40MB.

<div class="table table-striped">

| Channel | Audio | Image | Video | Document |
| --------------- | ------------------------- | -------------------- | ------------------------------ | ------------- |
| Website | All | All | All | All |
| Instagram | aac, m4a, wav, mp4 (25mb) | png, jpeg, gif (8mb) | mp4, ogg, avi, mov, web (25mb) | Not supported |
| Facebook | All | All | All | All |
| WhatsApp Cloud | All | All | All | All |
| WhatsApp Twilio | mpeg, opus, ogg, amr(5mb) | png, jpeg (5mb) | mp4 (5mb) | pdf (5mb) |
| Email | All | All | All | All |
| Telegram | All | All | All | All |
| Line | Not supported | png, jpeg | mp4 | Not supported |
| API | All | All | All | All |

> "All" means the channel supports all standard file types listed below:

**Standard File Types**

- **Video:** `ogg`, `mp4`, `mov`, `webm`, `quicktime`, `avi`
- **Audio:** `mpeg`, `opus`, `ogg`, `amr`, `aac`, `m4a`, `wav`
- **Image:** `png`, `jpeg`, `gif`, `bmp`, `webp`
- **Document:** `pdf`, `doc`, `docx`, `xls`, `xlsx`, `ppt`, `pptx`, `zip`, `7z`, `rar`, `tar`, `xml`, `csv`, `json`, `rtf`, `txt`, `plain`, `.3gpp`, `x-7z-compressed`, `vnd.rar`, `x-tar`, `msword`

</div>

### Available features

<div class="table table-striped">

| Channel | Channel greeting | Attachments | Agent Auto assignment | Slack |
| --------- | ---------------- | ----------- | --------------------- | ----- |
| Website | Yes | Yes | Yes | Yes |
| Facebook | Yes | Yes | Yes | Yes |
| Instagram | Yes | Yes | Yes | Yes |
| SMS | Yes | No | Yes | Yes |
| Whatsapp | Yes | Yes | Yes | Yes |
| Email | Yes | Yes | Yes | Yes |
| Telegram | Yes | Yes | Yes | Yes |
| Line | Yes | No | Yes | Yes |
| API | Yes | Yes | Yes | Yes |

</div>