@tencentcloud/sdk-mcp 1.6.8 → 1.7.0

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 通话处理'
-keywords: ['ON_CALL_RECEIVED', '通话邀请', '@trtc/call-engine-lite-js', 'calls', 'businessID', 'userData', 'callMediaType', 'calls', 'accept', 'onReceiveNewInvitation', 'onRecvNewMessage 自定义消息']
----
-
-# TUICallEngine Web 通话邀请接收与信令说明
-
-适用包：**@trtc/call-engine-lite-js**（TUICallEngine Web SDK）。
-
-## 一、如何接收通话邀请？
-
-**应用层应监听 `TUICallEvent.ON_CALL_RECEIVED`，而不是 TRTC Signaling 或 IM 自定义消息。**
-
-```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('来电', event);
-  // 展示接听 UI，随后 accept() 或 reject()
-});
-```
-
-### ON_CALL_RECEIVED 事件字段
-
-|参数|类型|含义|
-|---------|---------|---------|
-|callerId|String|邀请者。|
-|calleeIdList|Array<String>|同时还被邀请的人。|
-|isFromGroup|Boolean|是否是群组通话。|
-|inviteData|Object|呼叫数据。|
-|inviteID|String|邀请 ID，标识一次邀请。|
-|userData|String|扩展字段：用于在邀请信令中增加扩展信息。|
-|callId|String|本次通话的唯一 ID。|
-|roomID|Number|此次通话的音视频房间 ID。|
-|callMediaType|Number|通话的媒体类型，视频通话、语音通话。|
-|callRole|String|角色，枚举类型：主叫、被叫。|
-
-## 二、calls API 发送邀请时的参数有哪些？
-
-主叫通过 **`TUICallEngine.calls()`** 发起邀请：
-
-```javascript
-await tuiCallEngine.calls({
-  userIDList: ['user_bob'],
-  type: 2,                    // 1=语音 2=视频（CallMediaType）
-  userData: '{"ext":"info"}', // 可选，字符串
-  timeout: 30,                // 秒，默认 30
-  roomID: 123456,             // 数字房间号, 范围 [1, 2147483647]
-  strRoomID: '',              // 字符串房间号
-  chatGroupID: '',            // 在 Chat 群聊中多人通话时填写
-  offlinePushInfo: { /* … */ },
-});
-```
-
-## 三、在 Chat 中集成音视频通话时，如果需要处理通话消息上屏，自定义消息中的字段含义？
-
-|**问题**|**说明**|
-|---------|---------|
-|如何判断 “发起通话”|actionType = 1 且 cmd = 'videoCall' 或 'audioCall'|
-|如何判断 “已接听”|actionType = 3 |
-|如何判断 “通话已结束”，“通话时长是多少”|actionType = 1 且 cmd = 'hangup'，通话时长取 call_end 字段，单位：秒|
-|如何判断 “取消通话”|actionType = 2|
-|如何判断 “拒绝通话”|actionType = 4|
-|如何判断对端忙线产生的 “拒绝通话”|actionType = 4 且 cmd = "line_busy"|
-|如何被叫判断 “超时未接听”|actionType = 5|
-
-## 四、最佳实践摘要
-
-1. **只监听** `TUICallEvent.ON_CALL_RECEIVED`，用 `accept()` / `reject()` 响应。
-2. **不要**监听 `TIM.EVENT.MESSAGE_RECEIVED` 自行解析通话邀请。
-3. 扩展信息用 **`userData` 字符串**，主叫传入、被叫从事件读取。
-4. **`businessID` / 底层 payload 格式**属 SDK 内部实现；无官方公开文档前不要编造。
-5. **`@trtc/call-engine-lite-js` 4.x 起发起通话时需要传递自定义内容可以通过 `userData` 传递给被叫，不存在 `customData` 字段。

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

@@ -1,20 +0,0 @@
----
-product: 'Call'
-tech_stack: 'callengine'
-framework: 'web'
-doc_kind: 'best_practice'
-title: 'TUICallengine 设置日志输出级别'
-keywords: ['控制台日志', '关闭 log', 'log level']
----
-
-# TUICallEngine 设置日志输出级别
-
-Web TUICallEngine 提供浏览器控制台日志输出控制接口 setLogLevel。
-日志级别分为以下几种：
-0 普通级别，日志量较多，接入时建议使用
-1 主要级别，SDK 输出关键信息，默认日志等级
-2 告警级别，SDK 只输出告警和错误级别的日志
-3 错误级别，SDK 只输出错误级别的日志
-4 无日志级别，SDK 将不打印任何日志
-
-文档：[setLogLevel](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/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 发起音视频通话：call 与 calls、参数格式与示例'
-keywords: ['TUICallKit 发起音视频通', 'call 和 calls 方法的区别', 'userIDList 参数应该怎么传', 'type 参数 1 和 2 分别代表什么', 'TUICallKit vue', 'TUICallKit React']
----
-
-## 最佳实践（结论优先）
-1. Web TUICallKit **v4.x 必须使用 `calls`** 发起单聊/多人通话；`call`、`groupCall` 仅适用于 v4.0.0 以前版本， v4.0.0 起已不支持。
-2. 发起通话前必须先完成 `init`，否则会出现调用失败或状态异常。
-3. `type` 推荐使用 `CallMediaType` 枚举常量，不建议继续使用数字字面量（1/2）作为主写法。
-4. `userIDList` 必须传数组（单聊也传单元素数组）；需要和 Chat 群联动时再传 `chatGroupID`。
-
-### 初始化示例（v4.x，React）
-``` javascript
-import { TUICallKitAPI } from "@trtc/calls-uikit-react";
-
-TUICallKitAPI.init({ SDKAppID, userID, userSig });
-```
-
-### 旧版本初始化示例（v4.0.0 以前）
-``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-react";
-
-TUICallKitServer.init({ SDKAppID, userID, userSig });
-```
-
-## 常见误区（反例）
-- 在 v4.x 里继续调用 `call` / `groupCall`。
-- 把单聊写成 `userID` 字段而不是 `userIDList`。
-- `roomID` 与 `strRoomID` 混用（两者互斥，且不互通）。
-- `type` 长期使用数字字面量而非 `CallMediaType` 枚举常量。
-
-## v4.x calls 接口的使用示例
-发起单人或多人通话。
-``` 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}`);
-}
-```
-
-参数如下表所示：
-| 参数 | 类型 | 是否必填 | 含义 |
-| --- | --- | --- | --- |
-| userIDList | Array<String> | 是 | 被呼叫的用户列表。 |
-| type | CallMediaType| 是 | 通话的媒体类型。<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)。 |
-| chatGroupID | String | 是 | 与 Chat 结合使用时， Chat 群组的群 ID。 |
-| roomID | Number | 否 | 数字房间号，范围 [1, 2147483647]。 |
-| strRoomID | String | 否 | 字符串房间号。<strong>v3.3.1+ 支持</strong><br>1. roomID 与 strRoomID 是互斥的，若您选用 strRoomID，则 roomID 需要填写为 0。若两者都填，SDK 将优先选用 roomID。<br>2. 不要混用 roomID 和 strRoomID，因为它们之间是不互通的，例如数字 123 和字符串 "123" 是两个完全不同的房间。 |
-| timeout | Number | 否 | 通话超时时间，默认：30s，单位：秒。设置范围：10s ~ 600s。如果传入0，默认30s。 |
-| userData | String | 否 | 发起通话时自定义扩展字段，被呼叫用户在 ON_CALL_RECEIVED 事件中有该参数。 |
-| <a href="https://cloud.tencent.com/document/product/647/81015#offlinePushInfo">offlinePushInfo</a> | Object | 否 | 自定义离线消息推送参数。 |
-
-### CallMediaType 通话类型
-|CallMediaType 类型|描述|
-|---------|---------|
-|CallMediaType.AUDIO|语音通话。|
-|CallMediaType.VIDEO|视频通话。|
-
-## 低版本（v2.x/v3.x）`call` 和 `groupCall` 接口使用示例
-
-### 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}`);
-}
-```
-
-参数如下表所示：
-| 参数 | 类型 | 是否必填 | 含义 |
-| --- | --- | --- | --- |
-| userID | String | 是 | 被呼叫的用户 ID。 |
-| type | TUICallType | 是 | 通话的媒体类型。<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)。 |
-| roomID | Number | 否 | 数字房间号，范围 [1, 2147483647]。 |
-| strRoomID | String | 否 | 字符串房间号。<strong>v3.3.1+ 支持</strong><br>1. roomID 与 strRoomID 是互斥的，若您选用 strRoomID，则 roomID 需要填写为 0。若两者都填，SDK 将优先选用 roomID。<br>2. 不要混用 roomID 和 strRoomID，因为它们之间是不互通的，例如数字 123 和字符串 "123" 是两个完全不同的房间。 |
-| timeout | Number | 否 | 通话超时时间，默认：30s，单位：秒。设置范围：10s ~ 600s。如果传入0，默认30s。 |
-| userData | String | 否 | 发起通话时自定义扩展字段，被呼叫用户在 ON_CALL_RECEIVED 事件中有该参数。 |
-| offlinePushInfo | Object | 否 | 自定义离线消息推送参数。 |
-
-### groupCall 发起多人通话
-``` 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}`);
-}
-```
-
-参数如下表所示：
-| 参数 | 类型 | 是否必填 | 含义 |
-| --- | --- | --- | --- |
-| userIDList| Array<String> | 是 | 被呼叫的用户 ID。 |
-| type | TUICallType | 是 | 通话的媒体类型。<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)。 |
-| groupID | String | 是 | 通话群组 ID，groupID 的创建可参见。 |
-| roomID | Number | 否 | 数字房间号，范围 [1, 2147483647]。 |
-| strRoomID | String | 否 | 字符串房间号。<strong>v3.3.1+ 支持</strong><br>1. roomID 与 strRoomID 是互斥的，若您选用 strRoomID，则 roomID 需要填写为 0。若两者都填，SDK 将优先选用 roomID。<br>2. 不要混用 roomID 和 strRoomID，因为它们之间是不互通的，例如数字 123 和字符串 "123" 是两个完全不同的房间。 |
-| timeout | Number | 否 | 通话超时时间，默认：30s，单位：秒。设置范围：10s ~ 600s。如果传入0，默认30s。 |
-| userData | String | 否 | 发起通话时自定义扩展字段，被呼叫用户在 ON_CALL_RECEIVED 事件中有该参数。 |
-| offlinePushInfo | Object | 否 | 自定义离线消息推送参数。 |