📄️ Visitor Client
Introduction
📄️ Customer Service Client
Introduction
📄️ Admin Backend
Introduction
📄️ Server
📄️ Login
📄️ Login Visitor
📄️ Mobile Client
📄️ User System
📄️ Registered User API
This page describes backend registered user APIs for UserEntity, not frontend visitor session APIs.
📄️ Business User To Visitor Mapping
Clarify Two Concepts First
📄️ Personalized Service
This page explains how to implement personalized service experiences for different user levels by using the vipLevel parameter to display different customer service content for different user levels.
📄️ Visitor API
This page describes backend visitor management APIs. It is not the same as frontend SDK parameter passing when anonymous visitors open chat sessions.
📄️ Order Information
This page explains how to pass order information from your business system to the customer service system, especially suitable for e-commerce, logistics, and other scenarios that require order consultation services, helping customer service quickly understand the order details that users are inquiring about.
📄️ unread count
📄️ Visitor Identity
This page explains the visitor concept in Bytedesk and the difference between visitor identity and backend registered users.
📄️ Product Information
This page explains how to pass product information from your business system to the customer service system, especially suitable for e-commerce websites, helping customer service quickly understand the product details that users are inquiring about.
📄️ Admin Goods API
This feature is not available in the community edition. Please upgrade to Enterprise or Platform edition and replace the licenseKey.
📄️ SaaS
- This feature is only supported in Platform Edition. If needed, please scan QR code to contact WeChat
📄️ Historical Messages
This page explains how to control whether to automatically load historical chat records through the loadHistory parameter, helping users view historical session content.
📄️ Thread History
This page explains how to retrieve and display historical conversation threads (ThreadList) in the visitor side, and how to integrate it through page parameters or direct API calls.
📄️ Chat Messages
The Weiyu system supports multiple message types to meet communication needs in different scenarios. Each message type has its specific data structure and display method.
📄️ Message Api
📄️ UnreadCount
📄️ Unread Messages
This page introduces how to integrate the unread message count functionality of the Weiyu customer service system into your application, displaying the number of unread customer service messages for users in real-time, helping to improve user experience and message read rates.
📄️ Quick Reply
Quick Replies are pre-built message templates (canned responses). Agents can insert or send them in one click to reply faster and keep messaging consistent.
📄️ Quick Button
Quick Buttons let you pin frequently-used actions into the chat toolbar. Agents can click once to send a structured message or trigger an action, avoiding repetitive typing.
📄️ Text to Speech
📄️ Speech Recognition
📄️ Sensitive Word Filtering
📄️ Data Statistics
Session Statistics
📄️ Session Transfer
📄️ Session Invitation
📄️ Transfer bot
📄️ Invite Visitor
📄️ Satisfaction Rating
📄️ Conversation Quality Check
Manual Quality Check
📄️ Auto Reply
📄️ Blacklist
📄️ Message Translation
📄️ Queue Logic
📄️ Leave Message Processing
Overview
📄️ License
Any user who wants to use the Weiyu system, whether Community Edition, Enterprise Edition or Platform Edition (except Source Code Edition), needs to apply for a licenseKey. This document will provide detailed instructions on how to obtain and configure the licenseKey.
📄️ SSO
📄️ Token Api
📄️ Token
- Only Enterprise Edition and Platform Edition support this feature. If needed, please scan QR code to contact WeChat
📄️ Webhook
- This feature is only supported in Enterprise and Platform editions. If needed, please scan QR code to contact WeChat
📄️ Kbase
📄️ Kbase faq
📄️ Kbase Feishu
📄️ Kbase file
📄️ Kbase text
📄️ Kbase webpage
📄️ Kbase website
📄️ Session
📄️ Thread Api
📄️ Ticket
📄️ Ticket Visitor
📄️ Offline
📄️ Routing
📄️ Robot
📄️ Internationalization
H5 Visitor Client Internationalization Configuration
📄️ File Upload
The Weiyu system supports two file storage methods: Local File System and MinIO Object Storage. The system uses local file system storage by default, and only uses MinIO object storage when bytedesk.minio.enabled=true. You can choose the appropriate storage method based on your actual needs.
📄️ MQTT
📄️ Assistant
📄️ gRPC
📄️ Screen
📄️ Stomp
📄️ Ip
📄️ Admin Order API
This feature is not available in the community edition. Please upgrade to Enterprise or Platform edition and replace the licenseKey.
📄️ Sip Audio
📄️ Sip Video
📄️ Sensitive
📄️ Sip Call
📄️ Crm
📄️ Summary
📄️ Third-party Integration
This page explains how to embed your business system pages into the Weiyu agent console via an Iframe, so agents can view CRM, orders, tickets, etc. without leaving the workspace.
📄️ Router
📄️ Trigger
📄️ OCR
📄️ Message Forwarding
Use this feature to forward one or multiple messages to another conversation (DM / group / support ticket, depending on your setup). Two forwarding modes are available:
📄️ Card
📄️ Organization Api
📄️ Organization
In Bytedesk, an “Organization” is an independent workspace for a company/team. An organization is used to manage:
📄️ Monitor
This page introduces Bytedesk Desktop’s Session Monitor / Join / Takeover features.
📄️ Role Api
📄️ Role
This page explains Bytedesk Admin Console’s Roles & Permissions feature.
📄️ City
📄️ Feedback
📄️ Schedule
工作日&假期安排
📄️ Admin Shop API
This feature is not available in the community edition. Please upgrade to Enterprise or Platform edition and replace the licenseKey.
📄️ Shop Info
This page describes the current ShopEntity (bytedeskcoreshop) field model and recommended values.
📄️ Speech Input
📄️ Speech Tts
📄️ Metion Faq
📄️ Metion Member
📄️ Workgroup Api
📄️ Workgroup Info
📄️ Agent Api
📄️ Agent Info
📄️ Force Logout
Force logout is an administrator-facing account control feature used to temporarily prevent a support agent account or member account from continuing to sign in to the agent workspace.
📄️ Allow Platform
Restricting member login platforms is an account access control feature for administrators.