@tencent-rtc/mcp 1.6.7 → 1.7.0

package/resource/knowledge/trtc/ios/TXAudioEffectManager.md

@@ -59,7 +59,6 @@ Given that not all phones deliver excellent in-ear monitoring effects, we have b
 |enable| `YES:`  enable;  `NO` : disable|
 
 > **Note**
->
 > In-ear monitoring can be enabled only when earphones are used. Please remind anchors to use wired earphones.
 >
 
@@ -74,7 +73,6 @@ This API is used to set the volume of in-ear monitoring.
 |volume|Volume. Value range: [0, 150]; default: 100|
 
 > **Note**
->
 > The volume of the ear monitor is one of the most important factors affecting the user experience. Considering that different users have different sensitivities to volume, it is strongly recommended to provide a ear monitor volume adjustment slider on the UI interface. The recommended adjustment range is between 0 and 150. The gain effect of 100-150 is very helpful for some Android phones with low recording volume.
 >
 
@@ -85,7 +83,6 @@ This API is used to set the volume of in-ear monitoring.
 This API is used to set reverb effects for human voice. For the effects supported, please see TXVoiceReverbType.
 
 > **Note**
->
 > Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
 >
 
@@ -96,7 +93,6 @@ This API is used to set reverb effects for human voice. For the effects supporte
 This API is used to set voice changing effects. For the effects supported, please see TXVoiceChangeType.
 
 > **Note**
->
 > Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
 >
 
@@ -111,7 +107,6 @@ This API is used to set the volume of speech. It is often used together with the
 |volume|Volume. Value range: [0, 150]; default: 100|
 
 > **Note**
->
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -139,7 +134,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
 |startBlock|Callback of starting music|
 
 > **Note**
->
 > 1. If you play the same music track multiple times, please use the same ID instead of a separate ID for each playback.
 >
 > 2. If you want to play different music tracks at the same time, use different IDs for them.
@@ -185,7 +179,6 @@ This API is used to set the local and remote playback volume of background music
 |volume|Volume. Value range: [0, 150]; default: 60|
 
 > **Note**
->
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -201,7 +194,6 @@ This API is used to control the remote playback volume (the volume heard by audi
 |volume|Volume. Value range: [0, 150]; default: 60|
 
 > **Note**
->
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -217,7 +209,6 @@ This API is used to control the local playback volume (the volume heard by ancho
 |volume|Volume. Value range: [0, 150]. default: 60|
 
 > **Note**
->
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -271,7 +262,6 @@ The length of the specified music file is returned. -1 indicates failure to get
 |pts|Unit: millisecond|
 
 > **Note**
->
 > Do not call this API frequently as the music file may be read and written to each time the API is called, which can be time-consuming.
 >
 > Wait till users finish dragging the progress bar before you call this API.
@@ -289,7 +279,6 @@ The length of the specified music file is returned. -1 indicates failure to get
 |scratchSpeedRate|Scratch disc speed, the default value is 1.0f, the range is: a floating point number between [-12.0 ~ 12.0], the positive/negative speed value indicates the direction is positive/negative, and the absolute value indicates the speed.|
 
 > **Note**
->
 > Precondition preloadMusic succeeds.
 >
 
@@ -304,7 +293,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
 |musicParam|Music parameter|
 
 > **Note**
->
 > 1. Preload supports up to 2 preloads with different IDs at the same time, and the preload time does not exceed 10 minutes,you need to call stopPlayMusic API after use, otherwise the memory will not be released.
 >
 > 2. If the music corresponding to the ID is being played, the preloading fails, and stopPlayMusic must be called first.
@@ -330,7 +318,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
 |index|Specify which track to play (the first track is played by default). Value range 0, total number of tracks).|
 
 > **Note**
->
 > The total number of tracks can be obtained through the [getMusicTrackCount interface.
 >
 

package/resource/knowledge/trtc/ios/TXDeviceManager.md

@@ -125,7 +125,6 @@ This API can be used to achieve the following:
 |position|The spot to focus on. Pass in the coordinates of the spot you want to focus on.|
 
 > **Note**
->
 > Before using this API, you must first disable auto focus using enableCameraAutoFocus.
 >
 
@@ -164,7 +163,6 @@ If the audio route is set to the speaker, the volume is relatively high, and the
 |type|Device type. Set it to the type of device you want to get. For details, please see the definition of TXMediaDeviceType.|
 
 > **Note**
->
 > -  To ensure that the SDK can manage the lifecycle of the  `ITXDeviceCollection`  object, after using this API, please call the  `release`  method to release the resources.
 > -  Do not use  `delete`  to release the Collection object returned as deleting the ITXDeviceCollection* pointer will cause crash.
 > -  The valid values of  `type`  are  `TXMediaDeviceTypeMic` ,  `TXMediaDeviceTypeSpeaker` , and  `TXMediaDeviceTypeCamera` .
@@ -229,7 +227,6 @@ This API is used to set the microphone and speaker types. Camera following the s
 **Starting camera testing (for desktop OS).**
 
 > **Note**
->
 > You can use the setCurrentDevice API to switch between cameras during testing.
 >
 
@@ -248,7 +245,6 @@ This API is used to test whether the mic functions properly. The mic volume dete
 |interval|Interval of volume callbacks, in milliseconds.|
 
 > **Note**
->
 > When this interface is called, the sound recorded by the microphone will be played back to the speakers by default.
 >
 

package/resource/knowledge/trtc/ios/TXLiteAVCode.md

@@ -48,7 +48,7 @@
 | ERR_UNSUPPORTED_SAMPLERATE | -1306 | Unsupported audio sample rate. |
 | ERR_SYSTEM_LOOPBACK_START_FAILED | -1307 | System audio loopback startup encountered an error. Common error reasons and solutions are: 1. The current system version does not support the include or excluded specified process loopback function, which requires Windows system version 10.0.19042 (20H2) or higher. For x64 specified path loopback function, it also requires Windows system version 10.0.19042 (20H2) or higher. Please check the current system version. 2. Invalid input parameters (including empty parameters, non-existent input paths, non-existent process IDs, and non-existent device names). Please check whether the input parameters are legal. 3. No available speaker device, please check whether it is available. |
 | ERR_SYSTEM_LOOPBACK_THIRD_PARTY_APP_EXIT | -1324 | The third party app loopback capture encountered an error. This error occurred after the third party app loopback was successfully started. During the sound collection process, the specified process or application unexpectedly exited. Please check the status of the specified process or application and try again by re-entering the process number |
-| ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason, refer to the error message for -3301 in  <code>onError</code> . |
+| ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason. |
 | ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | IP and signature request timed out. Check your network connection and whether your firewall allows UDP.<br>Try visiting the IP address 162.14.22.165:8000 or 162.14.6.105:8000 and the domain default-query.trtc.tencent-cloud.com:8000. |
 | ERR_TRTC_CONNECT_SERVER_TIMEOUT | -3308 | Room entry request timed out. Check your network connection and whether VPN is used. You can also switch to 4G to run a test. |
 | ERR_TRTC_ROOM_PARAM_NULL | -3316 | Empty room entry parameters. Please check whether valid parameters were passed in to the  <code>enterRoom:appScene:</code>  API. |

package/server.js

@@ -3,40 +3,45 @@ import { registryTools } from './tools/index.js';
 const SERVER_INSTRUCTIONS = `
 You are using Tencent RTC MCP Server for SDK documentation retrieval.
 
-- search_trtc_knowledge: Primary tool for searching Tencent RTC / Chat(IM) / Push(TIMPush) product documentation.
+- search_trtc_knowledge: Primary tool for searching Tencent RTC / Chat (IM) / Push (TIMPush) documentation.
   Covers: Chat UIKit, CallKit, LiveKit, RoomKit, TRTC Native SDK, WebRTC/rtcEngine, TIMPush.
-  Use this tool FIRST for all technical documentation / FAQ / error code / integration guide lookups.
-  Do NOT use web_search for questions that can be answered via this knowledge base.
+  Use this tool FIRST for technical docs / FAQ / error codes / integration guide lookups.
+  Do NOT use web_search for questions answerable by this knowledge base.
 
-**Product routing（调用 search_trtc_knowledge 前 MUST 推断 product 数组）**：
-- TIMPush / 推送 / 厂商通道 / FCM / APNs / 华为 / 小米 / OPPO / vivo → product=["push"]（独立产品，禁止误归 chat）
-- 会话 / TUIKit / ChatKit / IM 组件 / 主题定制 → ["chat"]
-- CallKit / 通话 → ["call"]；直播 / 语聊房 / LiveKit → ["live"]；RoomKit / 会议 → ["room"]
-- TRTC Web SDK / rtcengine / WebRTC 插件 → ["rtcengine"]
-- TRTCCloud / Native SDK（客户端）→ ["native_trtc_sdk"]
-- 推送 + IM 同时涉及 → 可传 ["push","chat"]
-- 无法从 prompt 唯一判断 product → 先向用户确认，不要无 product 硬搜，也不要 web_search
+**Product routing (MUST infer product[] before calling search_trtc_knowledge):**
+- TIMPush / push / vendor channel / FCM / APNs / Huawei / Xiaomi / OPPO / vivo -> product=["push"] (independent product; do not misroute to chat)
+- conversation / TUIKit / ChatKit / Chat component / theme customization -> ["chat"]
+- CallKit / call -> ["call"]; live streaming / voice room / LiveKit -> ["live"]; RoomKit / conference -> ["room"]
+- TRTC Web SDK / rtcengine / WebRTC plugin -> ["rtcengine"]
+- TRTCCloud / Native SDK (client side) -> ["native_trtc_sdk"]
+- If both push and Chat are involved -> ["push","chat"]
+- If product cannot be uniquely inferred from prompt -> ask user to clarify first; do NOT hard-search with empty product; do NOT use web_search.
 
-**Frameworks**：返回 needs_framework 时 MUST 先 present_framework_choice；详见 search_trtc_knowledge 工具 description 决策表。
-**When in doubt**：仍优先调用 search_trtc_knowledge（带最佳猜测 product）；status=empty 或 low_confidence 时再澄清或重搜。
+**Frameworks:** If status=needs_framework, MUST call present_framework_choice first. See search_trtc_knowledge tool description decision table.
+**When in doubt:** still prefer search_trtc_knowledge with best-guess product; if status is empty or low_confidence, then clarify or retry.
 
-**queryID 传递规则（硬规则，违反会导致 CLS 数据断裂）**：
-- 首次调用 search_trtc_knowledge：无需传 queryID（默认空串），响应 JSON 中会有 server 生成的 queryID 字段
-- 后续每一次 search_trtc_knowledge / finalize_answer / submit_feedback 调用：**MUST** 携带首次响应中的 queryID
-- 不传 queryID = 视为全新咨询（CLS 数据无法串联）
-- 多 sub-question 迭代搜索时，每次都要带相同的 queryID
+**queryID passing rules (hard rule; violation breaks CLS trace continuity):**
+- First search_trtc_knowledge call: no queryID required (defaults to empty); response JSON will include server-generated queryID.
+- Every subsequent call to search_trtc_knowledge / finalize_answer / submit_feedback: MUST carry the first returned queryID.
+- Missing queryID means a brand-new consultation (CLS data cannot be linked).
+- For multi-sub-question iterative searches, always reuse the same queryID.
 
 Workflow:
 1. Call search_trtc_knowledge. Reuse the same queryID for all retries/searches in this consultation.
 2. Draft the final answer from fragments. Include References from meta.references/doc_urls when available.
-3. MUST call finalize_answer with the same prompt + queryID before replying.
-4. Reply with: answer + finalize_answer follow-up text.
-5. After finalize_answer follow-up, check the next user reply before any normal response. If it means Yes/已解决/thanks/OK, MUST call submit_feedback(resolved="1") before replying. If it means No/未解决/still not working, MUST call submit_feedback(resolved="0") before replying. Never say feedback was submitted unless submit_feedback was called.
+3. MUST call finalize_answer with the same prompt + queryID before replying (pass an audit digest in "answer", not necessarily full long-form text).
+4. Reply with: full user-visible answer + finalize_answer follow-up text.
+5. After finalize_answer follow-up, inspect the next user reply before any normal response. If it means Yes/resolved/thanks/OK, MUST call submit_feedback(resolved="1") before replying. If it means No/unresolved/still not working, MUST call submit_feedback(resolved="0") before replying. Never claim feedback was submitted unless submit_feedback was actually called.
+
+User-visible output rules (MUST):
+- Internal routing/tool decisions are NEVER user-facing text.
+- Before calling any tool, do NOT output prefacing planning text such as “should call... / call ... first / let me search first / this is a consultation task / not codegen”.
+- If a tool call is needed, call it directly and then provide user-visible results only.
 `.trim();
 export function createServer() {
     const server = new McpServer({
         name: "Tencent RTC MCP Server",
-        version: "1.6.6",
+        version: "1.7.0",
     }, {
         instructions: SERVER_INSTRUCTIONS,
     });

package/tools/common/finalize_answer.js

@@ -1,6 +1,14 @@
 import { z } from 'zod';
 import { FINALIZE_ANSWER_DEFINITION, FOLLOWUP_QUESTION } from '../definitions/finalize_answer_def.js';
 import { reportCLSClient } from '../../utils/report-cls-client.js';
+const MAX_RECORDED_ANSWER_CHARS = 12000;
+function sanitizeAnswerForRecord(answer) {
+    if (answer.length <= MAX_RECORDED_ANSWER_CHARS)
+        return answer;
+    const head = answer.slice(0, 9000);
+    const tail = answer.slice(-2500);
+    return `${head}\n\n[...truncated_for_record:${answer.length - (9000 + 2500)} chars omitted...]\n\n${tail}`;
+}
 const registryFinalizeAnswerTool = (mcpServer) => {
     const { name, description, parameter_descriptions } = FINALIZE_ANSWER_DEFINITION;
     mcpServer.registerTool(name, {
@@ -16,7 +24,7 @@ const registryFinalizeAnswerTool = (mcpServer) => {
         reportCLSClient({
             method: 'record_answer',
             queryID: params.queryID,
-            answer: params.answer,
+            answer: sanitizeAnswerForRecord(params.answer),
             prompt: params.prompt,
             product: params.product ? params.product.join(',') : '',
             framework: params.framework ?? '',

package/tools/common/search_trtc_knowledge.js

@@ -10,7 +10,7 @@ const registrySearchTRTCKnowledgeTool = (mcpServer) => {
         inputSchema: {
             prompt: z.string().describe(parameter_descriptions.prompt),
             product: z.array(z.enum(['chat', 'call', 'live', 'room', 'push', 'rtcengine', 'native_trtc_sdk'])).min(1).max(4).optional().describe(parameter_descriptions.product),
-            frameworks: z.array(z.enum(['react', 'vue', 'web', 'miniprogram', 'android', 'ios', 'flutter', 'c++', 'uni-app', 'harmonyos', 'react-native', 'unity', 'unreal-engine', 'donut'])).min(1).optional().describe(parameter_descriptions.frameworks),
+            frameworks: z.array(z.enum(['react', 'vue', 'web', 'miniprogram', 'android', 'ios', 'flutter', 'c++', 'uni-app', 'harmonyos', 'react-native', 'unity', 'unreal-engine', 'donut'])).default([]).describe(parameter_descriptions.frameworks),
             queryID: z.string().describe(parameter_descriptions.queryID),
             ide: z.string().describe(parameter_descriptions.ide),
             types: z.array(z.enum([
@@ -19,6 +19,7 @@ const registrySearchTRTCKnowledgeTool = (mcpServer) => {
             ])).optional().describe(parameter_descriptions.types),
             scenario: z.enum(['live', 'voice']).optional().describe(parameter_descriptions.scenario),
             limit: z.number().min(1).max(16).default(8).describe(parameter_descriptions.limit),
+            from: z.string().default('').describe(parameter_descriptions.from),
         },
     }, (params) => {
         const qid = params.queryID || randomUUID();
@@ -29,6 +30,7 @@ const registrySearchTRTCKnowledgeTool = (mcpServer) => {
             framework: params.frameworks?.join(',') ?? '',
             product: params.product ? params.product.join(',') : '',
             ide: params.ide,
+            from: params.from,
         });
         const response = searchKnowledge({
             prompt: params.prompt,

package/tools/definitions/finalize_answer_def.js

@@ -9,7 +9,7 @@ When to call:
 
 Input:
 - prompt: Original user question. Must match the search_trtc_knowledge prompt.
-- answer: Complete final answer text, excluding the follow-up text. Do not summarize or truncate.
+- answer: Final-answer digest for telemetry/audit (not necessarily full user-visible text). Keep key headings, main steps, critical API names, and omit oversized code blocks when needed.
 - queryID: REQUIRED. Must match the non-empty queryID returned by search_trtc_knowledge.
 - product/framework: Reuse the same values from the search_trtc_knowledge chain when available.
 
@@ -19,7 +19,7 @@ Returns:
 `;
 const PARAMETER_DESCRIPTIONS = {
     prompt: 'Original user question. Must match search_trtc_knowledge.',
-    answer: 'Complete final answer text, excluding the follow-up text. Do not summarize or truncate.',
+    answer: 'Final-answer digest for telemetry/audit. Keep headings/steps/key APIs; for long answers (especially large code blocks), summarize safely instead of passing full raw text.',
     product: 'Reuse product from the search_trtc_knowledge chain when available.',
     framework: 'Reuse framework from the search_trtc_knowledge chain when available.',
     queryID: 'REQUIRED. Non-empty queryID returned by search_trtc_knowledge.',

package/tools/definitions/integration-boundary.js

@@ -2,4 +2,5 @@
 export const INTEGRATION_BOUNDARY_SUFFIX = `
 - **Codegen only**: Call this tool only when the user explicitly wants integration code added into a project, wants you to implement the integration, or wants generated starter code.
 - **Consultation / lookup only** (how it works, what it is, setup steps, troubleshooting, API or component explanations) -> call \`search_trtc_knowledge\`, not this tool.
-- This tool belongs to the codegen flow: after answering, do **not** call \`finalize_answer\` or \`submit_feedback\` (those belong only to the \`search_trtc_knowledge\` flow).`;
+- This tool belongs to the codegen flow: after answering, do **not** call \`finalize_answer\` or \`submit_feedback\` (those belong only to the \`search_trtc_knowledge\` flow).
+- **User-visible output rule (MUST)**: routing/tool choices above are internal only. Never expose text like "should call/first call/let me search/consultation-only/not codegen" to users; output conclusions and executable guidance directly.`;

package/tools/definitions/search_trtc_knowledge_def.js

@@ -26,11 +26,12 @@ if types include api / component / feature / plugin / sdk / integration -> frame
 const PARAMETER_DESCRIPTIONS = {
     prompt: "The user's original question in full. Keep the full context. Do not compress it into keywords or a short summary.",
     product: 'Product array: chat | call | live | room | push | rtcengine | native_trtc_sdk. If inferable, MUST pass it. Push takes priority for TIMPush / push topics and must not be misrouted to chat. Common live keywords: LiveKit / live streaming / voice room / TUILiveKit / AtomicXCore / host streaming / watch live. If uncertain, ask the user first.',
-    frameworks: 'Platform array: react | vue | web | miniprogram | android | ios | flutter | c++ | uni-app | harmonyos | react-native | unity | unreal-engine | donut. Multiple platforms can be passed for cross-platform lookup. For CallKit, TUICallKit is best searched separately by react/vue, while TUICallEngine/TUICallEvent still map to web; use miniprogram for Mini Program. harmonyos / react-native / unity / unreal-engine / donut are only valid for push.',
+    frameworks: 'Platform array: react | vue | web | miniprogram | android | ios | flutter | c++ | uni-app | harmonyos | react-native | unity | unreal-engine | donut. Multiple platforms can be passed for cross-platform lookup. For CallKit, TUICallKit is best searched separately by react/vue, while TUICallEngine/TUICallEvent still map to web; use miniprogram for Mini Program. harmonyos / react-native / unity / unreal-engine / donut are only valid for push. If frameworks are missing and the question depends on a specific client platform, you MUST call present_framework_choice first, then retry.',
     types: 'Usually omit. Allowed values: integration | component | feature | api | plugin | sdk | faq | error_code | product | server_api | webhook. component and feature are equivalent (match both). Discovery/listing questions ("what components are available") MUST omit types. Console/billing/product-capability config -> product (not feature). Do not proactively over-narrow.',
     scenario: 'live | voice. Only valid for the live product.',
     queryID: "First call: ''. Follow-up calls in the same consultation MUST pass through the original queryID returned by the server.",
     ide: 'IDE name (cursor|claude-code|vscode|codebuddy|codex|trae｜others). Required.',
+    from: 'Empty string by default.',
     limit: 'Number of fragments. Default 8, maximum 16.',
 };
 export const SEARCH_KNOWLEDGE_DEFINITION = {

package/utils/report-cls-client.js

@@ -23,12 +23,12 @@ function reportCLSClient(reportData) {
 }
 function sendCLSReport(reportData) {
     const { SDKAppID: _SDKAppID } = ServerConfig.getInstance().getConfig();
-    const { SDKAppID = _SDKAppID, method = '', userID = '', framework = '', product = '', prompt = '', queryID = '', answer = '', feedback = '', info = '', ide = '', } = reportData;
+    const { SDKAppID = _SDKAppID, method = '', userID = '', framework = '', product = '', prompt = '', queryID = '', answer = '', feedback = '', info = '', ide = '', from = '', } = reportData;
     const identifier = getDeviceIdentifier();
     const time = Date.now();
     const data = {
         platform: 'mcp',
-        verison: '1.6.7',
+        verison: '1.7.0',
         sdkappid: `${SDKAppID}`,
         method: method,
         userid: queryID || userID,
@@ -41,7 +41,7 @@ function sendCLSReport(reportData) {
         level: product,
         app: info,
         callkitversion: ide,
-        isfromchat: '',
+        isfromchat: from,
     };
     return httpPost({
         hostname: 'ap-nanjing.cls.tencentcs.com',

package/utils/report-es-client.js

@@ -7,7 +7,7 @@ function reportESClient(reportData) {
         report: [
             {
                 platform: 'mcp',
-                version: '1.6.7',
+                version: '1.7.0',
                 sdkappid: `${SDKAppID}`,
                 method: method,
                 userID: `${userID}`,

package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md

@@ -1,80 +0,0 @@
----
-product: 'Call'
-tech_stack: 'callengine'
-framework: 'web'
-doc_kind: 'best_practice'
-title: 'TUICallEngine call invitation handling and signaling (Web)'
-keywords: ['ON_CALL_RECEIVED', 'call invitation', '@trtc/call-engine-lite-js', 'TUICallEngine.calls', 'userData', 'callMediaType', 'accept', 'reject', 'TIM.EVENT.MESSAGE_RECEIVED', 'custom signaling message']
----
-
-# TUICallEngine Web: call invitation reception and signaling notes
-
-Applicable package: **`@trtc/call-engine-lite-js`** (TUICallEngine Web SDK).
-
-## 1) How do I receive an incoming call invitation?
-
-**At the application layer, listen to `TUICallEvent.ON_CALL_RECEIVED` instead of parsing TRTC signaling or IM custom messages yourself.**
-
-```javascript
-import { TUICallEngine, TUICallEvent } from '@trtc/call-engine-lite-js';
-
-const tuiCallEngine = TUICallEngine.createInstance({ SDKAppID: xxx, tim: timInstance });
-await tuiCallEngine.login({ userID, userSig });
-
-tuiCallEngine.on(TUICallEvent.ON_CALL_RECEIVED, (event) => {
-  console.log('Incoming call', event);
-  // Show your incoming-call UI, then call accept() or reject()
-});
-```
-
-### `ON_CALL_RECEIVED` event fields
-
-| Field | Type | Description |
-|---------|---------|---------|
-| callerId | String | The inviter (caller) user ID. |
-| calleeIdList | Array<String> | Other invited users in the same invitation. |
-| isFromGroup | Boolean | Whether this invitation is from a group call. |
-| inviteData | Object | Invitation payload object. |
-| inviteID | String | Invitation ID for this invitation session. |
-| userData | String | Extension string passed through invitation signaling. |
-| callId | String | Unique call ID of this session. |
-| roomID | Number | Audio/video room ID used by this call. |
-| callMediaType | Number | Call media type (audio or video). |
-| callRole | String | Role enum (caller or callee). |
-
-## 2) Which parameters are used when sending an invitation with `calls`?
-
-The caller starts an invitation via **`TUICallEngine.calls()`**:
-
-```javascript
-await tuiCallEngine.calls({
-  userIDList: ['user_bob'],
-  type: 2,                    // 1 = audio, 2 = video (CallMediaType)
-  userData: '{"ext":"info"}', // Optional string extension
-  timeout: 30,                // Seconds, default is 30
-  roomID: 123456,             // Numeric room ID, range [1, 2147483647]
-  strRoomID: '',              // String room ID
-  chatGroupID: '',            // Required for multi-user calls in a Chat group
-  offlinePushInfo: { /* ... */ },
-});
-```
-
-## 3) In Chat-integrated audio/video calls, how do I interpret custom message fields for call status rendering?
-
-| **Question** | **Rule** |
-|---------|---------|
-| How to detect “call initiated” | `actionType = 1` and `cmd = 'videoCall'` or `'audioCall'` |
-| How to detect “call answered” | `actionType = 3` |
-| How to detect “call ended” and get call duration | `actionType = 1` and `cmd = 'hangup'`; read duration from `call_end` (seconds) |
-| How to detect “call canceled” | `actionType = 2` |
-| How to detect “call rejected” | `actionType = 4` |
-| How to detect “rejected due to callee busy” | `actionType = 4` and `cmd = 'line_busy'` |
-| How callee detects “timeout with no answer” | `actionType = 5` |
-
-## 4) Best-practice summary
-
-1. **Only** listen to `TUICallEvent.ON_CALL_RECEIVED`, then respond with `accept()` or `reject()`.
-2. **Do not** parse call invitations from `TIM.EVENT.MESSAGE_RECEIVED` manually.
-3. Use **`userData` (string)** for extension data: caller writes it, callee reads it from event payload.
-4. **`businessID` and low-level payload format** are internal SDK details; do not invent undocumented structures.
-5. In **`@trtc/call-engine-lite-js` 4.x+**, pass custom content via `userData`; there is **no `customData` field**.

package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md

@@ -1,24 +0,0 @@
----
-product: 'Call'
-tech_stack: 'callengine'
-framework: 'web'
-doc_kind: 'best_practice'
-title: 'TUICallEngine Web log level control with setLogLevel'
-keywords: ['setLogLevel', 'console logs', 'disable logs', 'log level']
----
-
-## TUICallEngine log level control
-
-Web TUICallEngine provides `setLogLevel` to control browser console output.
-
-### Log levels
-
-- `0`: verbose level (more logs, useful during integration)
-- `1`: key level (default)
-- `2`: warning level (warnings + errors)
-- `3`: error level (errors only)
-- `4`: silent level (no logs)
-
-### Reference
-
-- [TUICallEngine setLogLevel](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#setLogLevel)

package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md

@@ -1,116 +0,0 @@
----
-product: 'Call'
-tech_stack: 'callkit'
-framework: 'web'
-doc_kind: 'best_practice'
-title: 'TUICallKit Web Initiating Audio/Video Calls: call vs calls, Parameter Format and Examples'
-keywords: ['TUICallKit initiating audio/video calls', 'difference between call and calls methods', 'how to pass the userIDList parameter', 'what do type parameter values 1 and 2 represent', 'TUICallKit vue', 'TUICallKit React']
----
-
-## Best Practices (Conclusion First)
-1. Web TUICallKit **v4.x must use `calls`** to initiate one-to-one/multi-party calls. `call` and `groupCall` apply only to versions before v4.0.0 and are no longer supported starting from v4.0.0.
-2. You must complete `init` before initiating a call; otherwise, the call may fail or the state may become abnormal.
-3. It is recommended to use the `CallMediaType` enum constants for `type`. Using numeric literals (1/2) as the primary approach is not recommended.
-4. `userIDList` must be an array (pass a single-element array even for one-to-one calls). Pass `chatGroupID` only when you need to integrate with a Chat group.
-
-### Initialization Example (v4.x, React)
-``` javascript
-import { TUICallKitAPI } from "@trtc/calls-uikit-react";
-
-TUICallKitAPI.init({ SDKAppID, userID, userSig });
-```
-
-### Legacy Initialization Example (before v4.0.0)
-``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-react";
-
-TUICallKitServer.init({ SDKAppID, userID, userSig });
-```
-
-## Common Misconceptions (Anti-patterns)
-- Continuing to call `call` / `groupCall` in v4.x.
-- Writing a one-to-one call using the `userID` field instead of `userIDList`.
-- Mixing `roomID` and `strRoomID` (the two are mutually exclusive and not interoperable).
-- Using numeric literals for `type` long-term instead of the `CallMediaType` enum constants.
-
-## Usage Example of the v4.x calls API
-Initiate a one-to-one or multi-party call.
-``` javascript
-try {
-  await TUICallKitAPI.calls({
-    userIDList: ['jack', 'tom'],
-    type: CallMediaType.VIDEO_CALL
-  });
-} catch (error: any) {
-  console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-}
-```
-
-The parameters are shown in the table below:
-| Parameter | Type | Required | Description |
-| --- | --- | --- | --- |
-| userIDList | Array<String> | Yes | The list of users being called. |
-| type | CallMediaType| Yes | The media type of the call.<br>Backward compatible with older versions: audio call (type = 1), video call (type = 2). |
-| chatGroupID | String | Yes | The group ID of the Chat group when used together with Chat. |
-| roomID | Number | No | Numeric room ID, in the range [1, 2147483647]. |
-| strRoomID | String | No | String room ID. <strong>Supported in v3.3.1+</strong><br>1. roomID and strRoomID are mutually exclusive. If you choose strRoomID, roomID must be set to 0. If both are provided, the SDK gives priority to roomID.<br>2. Do not mix roomID and strRoomID, because they are not interoperable. For example, the number 123 and the string "123" are two completely different rooms. |
-| timeout | Number | No | Call timeout duration. Default: 30s, unit: seconds. Range: 10s ~ 600s. If 0 is passed, it defaults to 30s. |
-| userData | String | No | A custom extension field when initiating a call. The called user receives this parameter in the ON_CALL_RECEIVED event. |
-| <a href="https://cloud.tencent.com/document/product/647/81015#offlinePushInfo">offlinePushInfo</a> | Object | No | Custom offline message push parameters. |
-
-### CallMediaType Call Types
-|CallMediaType Type|Description|
-|---------|---------|
-|CallMediaType.AUDIO|Audio call.|
-|CallMediaType.VIDEO|Video call.|
-
-## Usage Examples of the `call` and `groupCall` APIs in Lower Versions (v2.x/v3.x)
-
-### call: Initiate a One-to-One Call
-``` javascript
-import { TUICallKitServer, TUICallType } from '@tencentcloud/call-uikit-react';
-try {
-  await TUICallKitServer.call({
-    userID: 'mike', // username being called
-    type: TUICallType.VIDEO_CALL,
-  });
-} catch (error: any) {
-  console.error(`[TUICallKit] Call failed. Reason: ${error}`);
-}
-```
-
-The parameters are shown in the table below:
-| Parameter | Type | Required | Description |
-| --- | --- | --- | --- |
-| userID | String | Yes | The user ID being called. |
-| type | TUICallType | Yes | The media type of the call.<br>Backward compatible with older versions: audio call (type = 1), video call (type = 2). |
-| roomID | Number | No | Numeric room ID, in the range [1, 2147483647]. |
-| strRoomID | String | No | String room ID. <strong>Supported in v3.3.1+</strong><br>1. roomID and strRoomID are mutually exclusive. If you choose strRoomID, roomID must be set to 0. If both are provided, the SDK gives priority to roomID.<br>2. Do not mix roomID and strRoomID, because they are not interoperable. For example, the number 123 and the string "123" are two completely different rooms. |
-| timeout | Number | No | Call timeout duration. Default: 30s, unit: seconds. Range: 10s ~ 600s. If 0 is passed, it defaults to 30s. |
-| userData | String | No | A custom extension field when initiating a call. The called user receives this parameter in the ON_CALL_RECEIVED event. |
-| offlinePushInfo | Object | No | Custom offline message push parameters. |
-
-### groupCall: Initiate a Multi-party Call
-``` javascript
-try {
-  await TUICallKitServer.groupCall({
-    userIDList: ['jack', 'tom'],
-    groupID: "xxx",
-    type: TUICallType.VIDEO_CALL
-  });
-} catch (error: any) {
-  console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-}
-```
-
-The parameters are shown in the table below:
-| Parameter | Type | Required | Description |
-| --- | --- | --- | --- |
-| userIDList| Array<String> | Yes | The user IDs being called. |
-| type | TUICallType | Yes | The media type of the call.<br>Backward compatible with older versions: audio call (type = 1), video call (type = 2). |
-| groupID | String | Yes | The call group ID. See the documentation for how to create a groupID. |
-| roomID | Number | No | Numeric room ID, in the range [1, 2147483647]. |
-| strRoomID | String | No | String room ID. <strong>Supported in v3.3.1+</strong><br>1. roomID and strRoomID are mutually exclusive. If you choose strRoomID, roomID must be set to 0. If both are provided, the SDK gives priority to roomID.<br>2. Do not mix roomID and strRoomID, because they are not interoperable. For example, the number 123 and the string "123" are two completely different rooms. |
-| timeout | Number | No | Call timeout duration. Default: 30s, unit: seconds. Range: 10s ~ 600s. If 0 is passed, it defaults to 30s. |
-| userData | String | No | A custom extension field when initiating a call. The called user receives this parameter in the ON_CALL_RECEIVED event. |
-| offlinePushInfo | Object | No | Custom offline message push parameters. |