ca5e112a8c
fixes: #11834 This pull request introduces TikTok channel integration, enabling users to connect and manage TikTok business accounts similarly to other supported social channels. The changes span backend API endpoints, authentication helpers, webhook handling, configuration, and frontend components to support TikTok as a first-class channel. **Key Notes** * This integration is only compatible with TikTok Business Accounts * Special permissions are required to access the TikTok [Business Messaging API](https://business-api.tiktok.com/portal/docs?id=1832183871604753). * The Business Messaging API is region-restricted and is currently unavailable to users in the EU. * Only TEXT, IMAGE, and POST_SHARE messages are currently supported due to limitations in the TikTok Business Messaging API * A message will be successfully sent only if it contains text alone or one image attachment. Messages with multiple attachments or those combining text and attachments will fail and receive a descriptive error status. * Messages sent directly from the TikTok App will be synced into the system * Initiating a new conversation from the system is not permitted due to limitations from the TikTok Business Messaging API. **Backend: TikTok Channel Integration** * Added `Api::V1::Accounts::Tiktok::AuthorizationsController` to handle TikTok OAuth authorization initiation, returning the TikTok authorization URL. * Implemented `Tiktok::CallbacksController` to handle TikTok OAuth callback, process authorization results, create or update channel/inbox, and handle errors or denied scopes. * Added `Webhooks::TiktokController` to receive and verify TikTok webhook events, including signature verification and event dispatching. * Created `Tiktok::IntegrationHelper` module for JWT-based token generation and verification for secure TikTok OAuth state management. **Configuration and Feature Flags** * Added TikTok app credentials (`TIKTOK_APP_ID`, `TIKTOK_APP_SECRET`) to allowed configs and app config, and registered TikTok as a feature in the super admin features YAML. [[1]](diffhunk://#diff-5e46e1d248631a1147521477d84a54f8ba6846ea21c61eca5f70042d960467f4R43) [[2]](diffhunk://#diff-8bf37a019cab1dedea458c437bd93e34af1d6e22b1672b1d43ef6eaa4dcb7732R69) [[3]](diffhunk://#diff-123164bea29f3c096b0d018702b090d5ae670760c729141bd4169a36f5f5c1caR74-R79) **Frontend: TikTok Channel UI and Messaging Support** * Added `TiktokChannel` API client for frontend TikTok authorization requests. * Updated channel icon mappings and tests to include TikTok (`Channel::Tiktok`). [[1]](diffhunk://#diff-b852739ed45def61218d581d0de1ba73f213f55570aa5eec52aaa08f380d0e16R16) [[2]](diffhunk://#diff-3cd3ae32e94ef85f1f2c4435abf0775cc0614fb37ee25d97945cd51573ef199eR64-R69) * Enabled TikTok as a supported channel in contact forms, channel widgets, and feature toggles. [[1]](diffhunk://#diff-ec59c85e1403aaed1a7de35971fe16b7033d5cd763be590903ebf8f1ca25a010R47) [[2]](diffhunk://#diff-ec59c85e1403aaed1a7de35971fe16b7033d5cd763be590903ebf8f1ca25a010R69) [[3]](diffhunk://#diff-725b90ca7e3a6837ec8291e9f57094f6a46b3ee00e598d16564f77f32cf354b0R26-R29) [[4]](diffhunk://#diff-725b90ca7e3a6837ec8291e9f57094f6a46b3ee00e598d16564f77f32cf354b0R51-R54) [[5]](diffhunk://#diff-725b90ca7e3a6837ec8291e9f57094f6a46b3ee00e598d16564f77f32cf354b0R68) * Updated message meta logic to support TikTok-specific message statuses (sent, delivered, read). [[1]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696R23) [[2]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696L63-R65) [[3]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696L81-R84) [[4]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696L103-R107) * Added support for embedded message attachments (e.g., TikTok embeds) with a new `EmbedBubble` component and updated message rendering logic. [[1]](diffhunk://#diff-c3d701caf27d9c31e200c6143c11a11b9d8826f78aa2ce5aa107470e6fdb9d7fR31) [[2]](diffhunk://#diff-047859f9368a46d6d20177df7d6d623768488ecc38a5b1e284f958fad49add68R1-R19) [[3]](diffhunk://#diff-c3d701caf27d9c31e200c6143c11a11b9d8826f78aa2ce5aa107470e6fdb9d7fR316) [[4]](diffhunk://#diff-cbc85e7c4c8d56f2a847d0b01cd48ef36e5f87b43023bff0520fdfc707283085R52) * Adjusted reply policy and UI messaging for TikTok's 48-hour reply window. [[1]](diffhunk://#diff-0d691f6a983bd89502f91253ecf22e871314545d1e3d3b106fbfc76bf6d8e1c7R208-R210) [[2]](diffhunk://#diff-0d691f6a983bd89502f91253ecf22e871314545d1e3d3b106fbfc76bf6d8e1c7R224-R226) These changes collectively enable end-to-end TikTok channel support, from configuration and OAuth flow to webhook processing and frontend message handling. ------------ # TikTok App Setup & Configuration 1. Grant access to the Business Messaging API ([Documentation](https://business-api.tiktok.com/portal/docs?id=1832184145137922)) 2. Set the app authorization redirect URL to `https://FRONTEND_URL/tiktok/callback` 3. Update the installation config with TikTok App ID and Secret 4. Create a Business Messaging Webhook configuration and set the callback url to `https://FRONTEND_URL/webhooks/tiktok` ([Documentation](https://business-api.tiktok.com/portal/docs?id=1832190670631937)) . You can do this by calling `Tiktok::AuthClient.update_webhook_callback` from rails console once you finish Tiktok channel configuration in super admin ( will be automated in future ) 5. Enable TikTok channel feature in an account --------- Co-authored-by: Sojan Jose <sojan@pepalo.com> Co-authored-by: iamsivin <iamsivin@gmail.com>
148 lines
4.3 KiB
YAML
148 lines
4.3 KiB
YAML
# TODO: Move this values to features.yml itself
|
|
# No need to replicate the same values in two places
|
|
|
|
# ------- Premium Features ------- #
|
|
captain:
|
|
name: 'Captain'
|
|
description: 'Enable AI-powered conversations with your customers.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-captain'
|
|
config_key: 'captain'
|
|
enterprise: true
|
|
saml:
|
|
name: 'SAML SSO'
|
|
description: 'Configuration for controlling SAML Single Sign-On availability'
|
|
enabled: <%= ChatwootApp.enterprise? %>
|
|
icon: 'icon-lock-line'
|
|
config_key: 'saml'
|
|
enterprise: true
|
|
custom_branding:
|
|
name: 'Custom Branding'
|
|
description: 'Apply your own branding to this installation.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-paint-brush-line'
|
|
config_key: 'custom_branding'
|
|
enterprise: true
|
|
agent_capacity:
|
|
name: 'Agent Capacity'
|
|
description: 'Set limits to auto-assigning conversations to your agents.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-hourglass-line'
|
|
enterprise: true
|
|
audit_logs:
|
|
name: 'Audit Logs'
|
|
description: 'Track and trace account activities with ease with detailed audit logs.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-menu-search-line'
|
|
enterprise: true
|
|
disable_branding:
|
|
name: 'Disable Branding'
|
|
description: 'Disable branding on live-chat widget and external emails.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-sailbot-fill'
|
|
enterprise: true
|
|
|
|
# ------- Product Features ------- #
|
|
help_center:
|
|
name: 'Help Center'
|
|
description: 'Allow agents to create help center articles and publish them in a portal.'
|
|
enabled: true
|
|
icon: 'icon-book-2-line'
|
|
|
|
# ------- Communication Channels ------- #
|
|
live_chat:
|
|
name: 'Live Chat'
|
|
description: 'Improve your customer experience using a live chat on your website.'
|
|
enabled: true
|
|
icon: 'icon-chat-smile-3-line'
|
|
email:
|
|
name: 'Email'
|
|
description: 'Manage your email customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-mail-send-fill'
|
|
config_key: 'email'
|
|
sms:
|
|
name: 'SMS'
|
|
description: 'Manage your SMS customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-message-line'
|
|
messenger:
|
|
name: 'Messenger'
|
|
description: 'Stay connected with your customers on Facebook & Instagram.'
|
|
enabled: true
|
|
icon: 'icon-messenger-line'
|
|
config_key: 'facebook'
|
|
instagram:
|
|
name: 'Instagram'
|
|
description: 'Stay connected with your customers on Instagram'
|
|
enabled: true
|
|
icon: 'icon-instagram'
|
|
config_key: 'instagram'
|
|
tiktok:
|
|
name: 'TikTok'
|
|
description: 'Stay connected with your customers on TikTok'
|
|
enabled: true
|
|
icon: 'icon-tiktok'
|
|
config_key: 'tiktok'
|
|
whatsapp:
|
|
name: 'WhatsApp'
|
|
description: 'Manage your WhatsApp business interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-whatsapp-line'
|
|
telegram:
|
|
name: 'Telegram'
|
|
description: 'Manage your Telegram customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-telegram-line'
|
|
line:
|
|
name: 'Line'
|
|
description: 'Manage your Line customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-line-line'
|
|
|
|
# ------- OAuth & Authentication ------- #
|
|
google:
|
|
name: 'Google'
|
|
description: 'Configuration for setting up Google OAuth Integration'
|
|
enabled: true
|
|
icon: 'icon-google'
|
|
config_key: 'google'
|
|
microsoft:
|
|
name: 'Microsoft'
|
|
description: 'Configuration for setting up Microsoft Email'
|
|
enabled: true
|
|
icon: 'icon-microsoft'
|
|
config_key: 'microsoft'
|
|
|
|
# ------- Third-party Integrations ------- #
|
|
linear:
|
|
name: 'Linear'
|
|
description: 'Configuration for setting up Linear Integration'
|
|
enabled: true
|
|
icon: 'icon-linear'
|
|
config_key: 'linear'
|
|
notion:
|
|
name: 'Notion'
|
|
description: 'Configuration for setting up Notion Integration'
|
|
enabled: true
|
|
icon: 'icon-notion'
|
|
config_key: 'notion'
|
|
slack:
|
|
name: 'Slack'
|
|
description: 'Configuration for setting up Slack Integration'
|
|
enabled: true
|
|
icon: 'icon-slack'
|
|
config_key: 'slack'
|
|
whatsapp_embedded:
|
|
name: 'WhatsApp Embedded'
|
|
description: 'Configuration for setting up WhatsApp Embedded Integration'
|
|
enabled: true
|
|
icon: 'icon-whatsapp-line'
|
|
config_key: 'whatsapp_embedded'
|
|
shopify:
|
|
name: 'Shopify'
|
|
description: 'Configuration for setting up Shopify Integration'
|
|
enabled: true
|
|
icon: 'icon-shopify'
|
|
config_key: 'shopify'
|