| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Social Marketing (social)
• Discuss (mail) |
| Community Apps Dependencies | Show |
| Lines of code | 6800 |
| Technical Name |
d_ee_social_tiktok_messaging |
| License | OPL-1 |
| Website | http://messiduong2709@gmail.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Social Marketing (social)
• Discuss (mail) |
| Community Apps Dependencies | Show |
| Lines of code | 6800 |
| Technical Name |
d_ee_social_tiktok_messaging |
| License | OPL-1 |
| Website | http://messiduong2709@gmail.com |
EE Social TikTok Messaging
Manage TikTok Business conversations directly in Odoo Enterprise
Connect your TikTok Business inbox to Odoo Discuss. Reply to customer direct messages from the same workspace your team already uses, and keep every conversation tracked in Odoo â with real-time delivery and read receipts.
Two-Way TikTok Direct Messaging
Handle TikTok Business DMs from Odoo without switching between tools.
- Receive TikTok direct messages in real time via TikTok Business webhooks.
- Reply from Odoo Discuss channels using your connected TikTok Business identity.
- Track outbound message states: sent, delivered, and read â with tick icons in the chat thread.
- Receive images, videos, stickers, emoji, shared posts, and text â all rendered in Discuss.
- Send text replies and image attachments directly from Odoo.
TikTok Auto Messages
Configure TikTok's native automatic messages from Odoo â no need to visit TikTok Business Center.
- Welcome Message â sent automatically when a user starts a new conversation.
- Suggested Questions â Q&A pairs shown to users at the start of a conversation (up to 3).
- Chat Prompts â quick-reply prompts displayed in the chat input area (up to 6).
- Enable, disable, and sync each auto message directly from the Odoo form.
- Reorder Chat Prompts with one click using the "Push Sort Order" button.
- Deleting a synced record calls the TikTok API to remove it remotely â no orphaned entries on TikTok's side.
Conversation History Sync
Import your existing TikTok Business conversation history in background jobs.
- One-click sync from the Social Account configuration page.
- Two-phase background processing: conversation list first, then message import per conversation.
- Cursor-based pagination handles large inboxes safely.
- Monitor progress and inspect errors from the Sync Jobs view.
- Participant profiles resolved automatically from message content.
Simple Account Configuration
Get started in minutes directly from the Odoo Social Account form.
- Enable TikTok Messaging with a single toggle on the Social Account.
- The webhook callback URL and verify token are generated and displayed in Odoo â paste them into TikTok for Developers.
- HMAC-SHA256 signature verification on every incoming webhook event.
- Assign messaging operators from the Social Account form.
Documentation
See the Documentation tab on this page for a step-by-step setup guide covering TikTok for Developers app configuration, webhook setup, and auto-message management.
Support
For support, feature requests, or custom development, contact messiduong2709@gmail.com.
EE Social TikTok Messaging Setup
This guide will walk you through the process of setting up TikTok Business integration with your Odoo Enterprise instance using the d_ee_social_tiktok_business module.
1. Installation and Configuration
Note
THE EASIEST SETUP ON ODOO APPS STORE!
Forget about the nightmare of creating a developer account, waiting for partner approval, or configuring complex API scopes. This module operates via our centralized Proxy Server (IAP) to save you hours of setup.
How to get started in 2 minutes:
- Purchase the module on the Odoo Apps Store.
- Send an email to messiduong2709@gmail.com containing your Sales Order (SO) number.
- We will reply with your License Key.
- In your Odoo, go to Settings → Technical → Parameters → System Parameters.
- Create (or update) the key duong_platform.license_key and set its value to your License Key.
- Save. Done — you can now connect your TikTok Business account immediately.
Note
TODO (Odoo 20): Add a dedicated License Key field directly in the Settings UI so users no longer need to navigate to System Parameters.
That's it! You can now jump straight to Section 3.1 - Connecting TikTok Business Account without doing any of the complex TikTok Developer Portal setup described below.
(The manual App creation guide below is purely optional and only required if you explicitly want to use your own private Custom Developer App instead of our ready-to-use Proxy system.)
1.1. Install Module
- Go to Apps in your Odoo instance
- Search for "d_ee_social_tiktok_messaging"
- Click Install
- Note: This module requires Odoo Enterprise Edition
2. (Optional) Setup Your Own TikTok Developer App
Skip this entire section if you are using the IAP Proxy with a License Key.
2.1. (Optional) Create a TikTok for Business Account
- Visit the TikTok for Business https://business-api.tiktok.com/ website
- Click Register for TikTok for Business and follow the registration process
- Complete your business profile information
- For detailed instructions, refer to the official documentation https://business-api.tiktok.com/portal/docs?id=1738855242728450
2.2. (Optional) Register as a Developer
- Log in to your TikTok for Business account
- Visit the TikTok Business API https://business-api.tiktok.com/ portal
- Click Become a developer and complete the registration form
- For detailed instructions, refer to the developer registration guide https://business-api.tiktok.com/portal/docs?id=1738855176671234
2.3. (Optional) Submit TikTok Partner Application
- Go to https://partners.tiktok.com/sign-up/pc/en?rid=us2viqcqtk
- Fill in your business information to become a TikTok Official Partner
- This is required to obtain the TikTok Accounts scope in the next step
- Note: the application can take up to 10 days to be reviewed by the TikTok team
2.4. (Optional) Create a Developer App
- In the TikTok Business API portal, go to My Apps
- Click Create App and fill in the required information:
- App Name: Choose a descriptive name for your integration
- App Description: Briefly describe your integration with Odoo
- App Type: Select Business
- Configure the OAuth redirect URL:
- Set the URL to: https://{your-odoo-domain}/tiktok_business/authentication
- Replace {your-odoo-domain} with your actual Odoo domain
- Under Scope of permission, enable the required scopes (see Section 1.3)
2.4. (Optional) Obtain business messaging API access
- Mare sure you have read https://business-api.tiktok.com/portal/docs/access-to-business-messaging-api/v1.3 to start getting access to tiktok business messaging platform
- You will need to fill in this form and submit https://bytedance.sg.larkoffice.com/share/base/form/shrlg7vFArGhg9V20neYCEwIKrb
- Aslo you need to make sure your tiktok account is business one not personal , see https://ads.tiktok.com/business/en/solutions/business-account
2.6. (Optional) Configure Custom Credentials in Odoo
- Go to Settings → Social Media
- Scroll to the TikTok Business Integration section
- Enter your TikTok app credentials:
- Client Key: the Client ID from the TikTok Business API portal
- Client Secret: the Client Secret from the TikTok Business API portal
- Click Save
3. Subscribe to Webhook Events Directly In Odoo
- In Odoo, go to Social Marketing > Configuration > Social Accounts , open correct tiktok business account and click.
4. Enable Messaging on the Odoo Social Account
- In Odoo, go to Social Marketing > Configuration > Social Accounts.
- Open the TikTok Business Account.
- In the TikTok Messaging section:
- Enable Messaging Enabled.
- Confirm the Webhook Verify Token field is filled (auto-generated on first save).
- Copy the displayed Webhook Callback URL — this is what you pasted in Step 2.
- Add one or more Messaging Operators.
- Save the record.
After saving, Odoo is ready to receive and send TikTok direct messages for this account.
5. Test Two-Way Conversations
- From a personal TikTok account (or a sandbox test account), send a direct message to the connected TikTok Business Account.
- In Odoo, open TikTok Messaging > Conversations or the Discuss sidebar.
- Confirm the incoming message appears in a TikTok channel.
- Reply from Odoo.
- Observe the message status icons in the chat thread:
- Sent — message accepted by TikTok API.
- Delivered — confirmed via im_send_msg echo webhook.
- Read — confirmed via im_mark_read_msg webhook.
6. Download Conversation History
- Open the TikTok Business Social Account in Odoo.
- In the Conversation History section, click Download Conversation History.
- Odoo creates background sync jobs — one per existing conversation.
- Click View Sync Jobs to monitor progress and inspect any errors.
History sync is cursor-paginated and safe to run on large inboxes. Re-running it skips messages already imported (deduplicated by TikTok message ID).
7. Configure Auto Messages
7.1 Enable tiktok auto message in tiktok mobile app
If you do not enable these option in your business setting of your tiktok account, it will not work even you have config in Odoo
- Go to setting in you tiktok app in your mobile phone
- Go message center
- Enable chat prompt
- Enable welcome message
- Enable suggest question
7.2 Config Auto Message in Odoo
Auto messages are TikTok-native features managed from TikTok Messaging > Configuration > Auto Messages.
Three types are supported:
Welcome Message
Sent automatically when a user starts a new conversation.
- Create a record, set Type to Welcome Message, and fill in Content.
- Click Sync to TikTok — status changes to Synced.
- Click Enable — status changes to Active.
- To turn it off, click Disable — status changes to Paused.
Note
TikTok does not allow deleting a Welcome Message via API. Use Disable to deactivate it instead. Attempting to delete a synced Welcome Message from the gear menu will raise an error to prevent accidental removal.
Suggested Questions
Q&A pairs displayed to users at the start of a conversation (maximum 3 per Business Account).
- Create a record, set Type to Suggested Question.
- Fill in Question and Answer.
- Click Sync to TikTok, then Enable.
- To remove, click Delete (gear menu or Delete button) — the record is removed from both Odoo and TikTok in one step.
Chat Prompts
Quick-reply prompts shown in the chat input area (maximum 6 per Business Account).
- Create a record, set Type to Chat Prompt.
- Fill in Title and Content.
- Click Sync to TikTok, then Enable.
- To reorder prompts: open any synced Chat Prompt and click Push Sort Order. This sends the current sequence ordering of all synced Chat Prompts to TikTok. You need at least 2 synced Chat Prompts to use this feature.
Troubleshooting
- Webhook verification fails
- Confirm the Odoo URL is public HTTPS and the verify token in TikTok for Developers exactly matches the value in the Odoo Social Account form.
- Messages arrive but replies fail
- Check that the TikTok access token is valid and has dm.conversation permission. Re-authenticate the TikTok Business Account in Odoo if necessary.
- Inbound images not downloading (HTTP 403)
- The module passes the Access-Token header when downloading TikTok media. Confirm the access token has not expired and has media download permission.
- Conversation history sync shows errors
- Open View Sync Jobs and read the error message on failed jobs. Common causes: expired access token, TikTok rate limit, or a conversation containing no messages.
- Auto message sync fails
- Confirm the TikTok Business Account has Direct Message permission approved. Auto-message API endpoints may require production-level access for some account types.
- Status not updating in real time
- Confirm the im_send_msg and im_mark_read_msg webhook events are subscribed in TikTok for Developers (see Step 3 above).
Support
For support, feature requests, or custom development, contact messiduong2709@gmail.com.
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module