tccli 3.0.1328.1__py2.py3-none-any.whl → 3.0.1329.1__py2.py3-none-any.whl

tccli/services/trtc/v20190722/api.json

@@ -49,6 +49,13 @@
       "output": "DeletePictureResponse",
       "status": "online"
     },
+    "DeleteVoicePrint": {
+      "document": "传入声纹ID，删除之前注册的声纹信息",
+      "input": "DeleteVoicePrintRequest",
+      "name": "删除声纹信息",
+      "output": "DeleteVoicePrintResponse",
+      "status": "online"
+    },
     "DescribeAIConversation": {
       "document": "查询AI对话任务状态。",
       "input": "DescribeAIConversationRequest",
@@ -231,6 +238,13 @@
       "output": "DescribeUserInfoResponse",
       "status": "online"
     },
+    "DescribeVoicePrint": {
+      "document": "查询先前注册的声纹信息",
+      "input": "DescribeVoicePrintRequest",
+      "name": "查询声纹信息",
+      "output": "DescribeVoicePrintResponse",
+      "status": "online"
+    },
     "DescribeWebRecord": {
       "document": "查询页面录制任务",
       "input": "DescribeWebRecordRequest",
@@ -266,6 +280,13 @@
       "output": "ModifyPictureResponse",
       "status": "online"
     },
+    "RegisterVoicePrint": {
+      "document": "传入音频base64串，注册声纹信息，返回声纹ID",
+      "input": "RegisterVoicePrintRequest",
+      "name": "注册声纹信息",
+      "output": "RegisterVoicePrintResponse",
+      "status": "online"
+    },
     "RemoveUser": {
       "document": "接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。",
       "input": "RemoveUserRequest",
@@ -398,6 +419,13 @@
       "name": "更新输入在线媒体流",
       "output": "UpdateStreamIngestResponse",
       "status": "online"
+    },
+    "UpdateVoicePrint": {
+      "document": "传入声纹ID以及对应音频信息，更新对应声纹信息",
+      "input": "UpdateVoicePrintRequest",
+      "name": "更新声纹信息",
+      "output": "UpdateVoicePrintResponse",
+      "status": "online"
     }
   },
   "metadata": {
@@ -612,6 +640,28 @@
           "required": false,
           "type": "int",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "环境音设置",
+          "example": "无",
+          "member": "AmbientSound",
+          "name": "AmbientSound",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "声纹配置",
+          "example": "无",
+          "member": "VoicePrint",
+          "name": "VoicePrint",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
         }
       ],
       "usage": "both"
@@ -649,6 +699,34 @@
       ],
       "usage": "in"
     },
+    "AmbientSound": {
+      "document": "背景音设置，将在通话中添加环境音效，使体验更加逼真。目前支持以下选项：\ncoffee_shop: 咖啡店氛围，背景中有人聊天。\nbusy_office: 客服中心\nstreet_traffic: 户外街道\nevening_mountain: 户外山林",
+      "members": [
+        {
+          "disabled": false,
+          "document": "环境场景选择",
+          "example": "coffee_shop",
+          "member": "string",
+          "name": "Scene",
+          "output_required": false,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "控制环境音的音量。取值的范围是 [0,2]。值越低，环境音越小；值越高，环境音越响亮。如果未设置，则使用默认值 1。",
+          "example": "1.0",
+          "member": "float",
+          "name": "Volume",
+          "output_required": false,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "AudioEncode": {
       "document": "音频编码参数。",
       "members": [
@@ -1388,6 +1466,33 @@
       ],
       "type": "object"
     },
+    "DeleteVoicePrintRequest": {
+      "document": "DeleteVoicePrint请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "声纹信息ID",
+          "example": "20250529_xxxxxx",
+          "member": "string",
+          "name": "VoicePrintId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DeleteVoicePrintResponse": {
+      "document": "DeleteVoicePrint返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeAIConversationRequest": {
       "document": "DescribeAIConversation请求参数结构体",
       "members": [
@@ -3242,6 +3347,80 @@
       ],
       "type": "object"
     },
+    "DescribeVoicePrintRequest": {
+      "document": "DescribeVoicePrint请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "查询方式，0表示查询特定VoicePrintId，1表示分页查询",
+          "example": "1",
+          "member": "uint64",
+          "name": "DescribeMode",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "声纹ID",
+          "example": "13000569123-fd91f128-52a6-4692-b94a-c0f9fd3c4287",
+          "member": "string",
+          "name": "VoicePrintIdList",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "当前页码,从1开始,DescribeMode为1时填写",
+          "example": "1",
+          "member": "uint64",
+          "name": "PageIndex",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "每页条数 最少20,DescribeMode为1时填写",
+          "example": "20",
+          "member": "uint64",
+          "name": "PageSize",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeVoicePrintResponse": {
+      "document": "DescribeVoicePrint返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "总的条数",
+          "example": "100",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "声纹信息",
+          "example": "无",
+          "member": "VoicePrintInfo",
+          "name": "Data",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeWebRecordRequest": {
       "document": "DescribeWebRecord请求参数结构体",
       "members": [
@@ -5631,6 +5810,79 @@
       ],
       "usage": "out"
     },
+    "RegisterVoicePrintRequest": {
+      "document": "RegisterVoicePrint请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "整个wav音频文件的base64字符串,其中wav文件限定为16k或8k采样率, 16bit位深, 单声道, 8到18秒有效音频时长,编码数据大小不超过2M",
+          "example": "kAOgA9AEA...",
+          "member": "string",
+          "name": "Audio",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "毫秒时间戳",
+          "example": "1748249540000",
+          "member": "uint64",
+          "name": "ReqTimestamp",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "音频格式,目前只支持0,代表wav",
+          "example": "0",
+          "member": "uint64",
+          "name": "AudioFormat",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "音频名称,长度不要超过32",
+          "example": "jackson",
+          "member": "string",
+          "name": "AudioName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "和声纹绑定的MetaInfo，长度最大不超过512",
+          "example": "metainfo string",
+          "member": "string",
+          "name": "AudioMetaInfo",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "RegisterVoicePrintResponse": {
+      "document": "RegisterVoicePrint返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "声纹信息ID",
+          "example": "声纹信息id",
+          "member": "string",
+          "name": "VoicePrintId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "RemoveUserByStrRoomIdRequest": {
       "document": "RemoveUserByStrRoomId请求参数结构体",
       "members": [
@@ -7866,6 +8118,69 @@
       ],
       "type": "object"
     },
+    "UpdateVoicePrintRequest": {
+      "document": "UpdateVoicePrint请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "声纹信息ID",
+          "example": "20250529_xxxxxx",
+          "member": "string",
+          "name": "VoicePrintId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "毫秒时间戳",
+          "example": "1748249540000",
+          "member": "uint64",
+          "name": "ReqTimestamp",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "音频格式,目前只支持0,代表wav",
+          "example": "0",
+          "member": "uint64",
+          "name": "AudioFormat",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "整个wav音频文件的base64字符串,其中wav文件限定为16k或8k采样率, 16bit位深, 单声道, 8到18秒有效音频时长,编码数据大小不超过2M",
+          "example": "f8AAAMABwAJAAsxxxx",
+          "member": "string",
+          "name": "Audio",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "和声纹绑定的MetaInfo，长度最大不超过512",
+          "example": "metainfo string",
+          "member": "string",
+          "name": "AudioMetaInfo",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "UpdateVoicePrintResponse": {
+      "document": "UpdateVoicePrint返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "UserInformation": {
       "document": "用户信息，包括用户进房时间，退房时间等",
       "members": [
@@ -8134,6 +8449,120 @@
       ],
       "usage": "in"
     },
+    "VoicePrint": {
+      "document": "声纹配置参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "默认为0，表示不启用声纹。1表示使用固定声纹，且需要填写voiceprint id。2表示使用动态声纹，不需要使用voiceprint id，内部动态选择主讲人声纹",
+          "example": "1",
+          "member": "uint64",
+          "name": "Mode",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "只有当VoicePrint Mode为1时需要填写，目前仅支持填写一个声纹id",
+          "example": "[\"your-voiceprint-id\"]",
+          "member": "string",
+          "name": "IdList",
+          "output_required": false,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "VoicePrintInfo": {
+      "document": "声纹查询数据",
+      "members": [
+        {
+          "disabled": false,
+          "document": "声纹ID",
+          "example": "1300056123-fd91f128-52a6-4692-b94a-c0f9fd3c4287",
+          "member": "string",
+          "name": "VoicePrintId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "应用id",
+          "example": "1300056123",
+          "member": "uint64",
+          "name": "AppId",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "和声纹绑定的MetaInfo",
+          "example": "metainfo",
+          "member": "string",
+          "name": "VoicePrintMetaInfo",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "创建时间",
+          "example": "2025-05-21 19:23:54",
+          "member": "string",
+          "name": "CreateTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "更新时间",
+          "example": "2025-05-21 19:23:54",
+          "member": "string",
+          "name": "UpdateTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "音频格式,当前只有0(代表wav)",
+          "example": "0",
+          "member": "uint64",
+          "name": "AudioFormat",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "音频名称",
+          "example": "jackson",
+          "member": "string",
+          "name": "AudioName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "请求毫秒时间戳",
+          "example": "1748249540000",
+          "member": "uint64",
+          "name": "ReqTimestamp",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "WaterMark": {
       "document": "水印布局参数",
       "members": [

tccli/services/trtc/v20190722/examples.json

@@ -56,6 +56,14 @@
         "title": "删除图片"
       }
     ],
+    "DeleteVoicePrint": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteVoicePrint\n<公共请求参数>\n\n{\n    \"VoicePrintId\": \"20250605_9cc525c117ab4545b1ad21543e48412fSz4ZnwTZCW2tyePrHj0Y37WXz4QkUoLvT9P_eRVqiw\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"3facfb37-9ded-4c73-bef7-90a78a0c2936\"\n    }\n}",
+        "title": "删除jackson的声纹信息"
+      }
+    ],
     "DescribeAIConversation": [
       {
         "document": "",
@@ -264,6 +272,14 @@
         "title": "查询用户列表与通话指标"
       }
     ],
+    "DescribeVoicePrint": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeVoicePrint\n<公共请求参数>\n\n{\n    \"DescribeMode\": 1,\n    \"PageIndex\": 1,\n    \"PageSize\": 1\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"AppId\": 1300056921,\n                \"AudioName\": \"jackson\",\n                \"CreateTime\": \"2025-06-05 18:40:27\",\n                \"ReqTimestamp\": 1749119970000,\n                \"UpdateTime\": \"2025-06-05 18:40:27\",\n                \"VoicePrintId\": \"20250605_e3f126cda7ad4196bfb1acfb10642d39fFPqPcCyY6KcccmO9t4CHqn-6qJMBnzaiLzdaeEi2Q\",\n                \"VoicePrintMetaInfo\": \"custom_metainfo\"\n            }\n        ],\n        \"RequestId\": \"10459f57-b3fb-42a3-99c7-0c037967e420\",\n        \"TotalCount\": 14\n    }\n}",
+        "title": "分页查询已经注册过的声纹信息"
+      }
+    ],
     "DescribeWebRecord": [
       {
         "document": "",
@@ -304,6 +320,14 @@
         "title": "修改图片相关参数"
       }
     ],
+    "RegisterVoicePrint": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RegisterVoicePrint\n<公共请求参数>\n\n{\n    \"Audio\": \"The Base64 string of the entire WAV audio file, with valid audio content from 8 to 18 seconds.\",\n    \"ReqTimestamp\": 1749119700000,\n    \"AudioFormat\": 0,\n    \"AudioName\": \"jackson\",\n    \"AudioMetaInfo\": \"custom_metainfo\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"47a8f838-8368-4dc7-a5ce-94b366692f6f\",\n        \"VoicePrintId\": \"20250605_9cc525c117ab4545b1ad21543e48412fSz4ZnwTZCW2tyePrHj0Y37WXz4QkUoLvT9P_eRVqiw\"\n    }\n}",
+        "title": "注册jackson的声纹信息"
+      }
+    ],
     "RemoveUser": [
       {
         "document": "将用户user_1、user_2从房间1001移出。",
@@ -497,6 +521,14 @@
         "output": "{\n    \"Response\": {\n        \"Status\": \"InProgress\",\n        \"RequestId\": \"71993312-6ab8-4768-9124-118e0a20c45f\"\n    }\n}",
         "title": "更新任务"
       }
+    ],
+    "UpdateVoicePrint": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateVoicePrint\n<公共请求参数>\n\n{\n    \"VoicePrintId\": \"20250605_9cc525c117ab4545b1ad21543e48412fSz4ZnwTZCW2tyePrHj0Y37WXz4QkUoLvT9P_eRVqiw\",\n    \"ReqTimestamp\": 1749120210000,\n    \"AudioFormat\": 0,\n    \"Audio\": \"The Base64 string of the entire WAV audio file, with valid audio content from 8 to 18 seconds.\",\n    \"AudioMetaInfo\": \"update_metainfo\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"40e323b2-f0e7-402c-be5d-b02aef40d887\"\n    }\n}",
+        "title": "更新jackson的音频信息"
+      }
     ]
   },
   "version": "1.0"

tccli/services/vm/v20210922/api.json

@@ -888,8 +888,8 @@
       "members": [
         {
           "disabled": false,
-          "document": "该参数表示任务列表每页展示的任务条数，**默认值为10**（每页展示10条任务）。",
-          "example": "无",
+          "document": "该参数表示任务列表每页展示的任务条数，**默认值为10，最大值为100**（每页展示10条任务）。",
+          "example": "10",
           "member": "int64",
           "name": "Limit",
           "required": false,
@@ -907,7 +907,7 @@
         {
           "disabled": false,
           "document": "该参数表示翻页时使用的Token信息，由系统自动生成，并在翻页时向下一个生成的页面传递此参数，以方便快速翻页功能的实现。当到最后一页时，该字段为空。",
-          "example": "无",
+          "example": "aEjUgqOnIv0S1ZxQ.aEJUb42r3tX61Y-a",
           "member": "string",
           "name": "PageToken",
           "required": false,
@@ -916,7 +916,7 @@
         {
           "disabled": false,
           "document": "该参数表示任务列表的开始时间，格式为ISO8601标准的时间戳。**默认值为最近3天**，若传入该参数，则在这一时间到EndTime之间的任务将会被筛选出来。<br>备注：该参数与Filter共同起到任务筛选作用，二者作用无先后顺序。",
-          "example": "无",
+          "example": "2025-06-05T00:00:00+08:00",
           "member": "datetime_iso",
           "name": "StartTime",
           "required": false,
@@ -925,7 +925,7 @@
         {
           "disabled": false,
           "document": "该参数表示任务列表的结束时间，格式为ISO8601标准的时间戳。**默认值为空**，若传入该参数，则在这StartTime到这一时间之间的任务将会被筛选出来。<br>备注：该参数与Filter共同起到任务筛选作用，二者作用无先后顺序。",
-          "example": "无",
+          "example": "2025-06-06T23:59:59+08:00",
           "member": "datetime_iso",
           "name": "EndTime",
           "required": false,
@@ -940,7 +940,7 @@
         {
           "disabled": false,
           "document": "该字段用于返回当前查询的任务总量，格式为int字符串。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "1",
+          "example": "1200",
           "member": "string",
           "name": "Total",
           "output_required": true,
@@ -960,7 +960,7 @@
         {
           "disabled": false,
           "document": "该字段用于返回翻页时使用的Token信息，由系统自动生成，并在翻页时向下一个生成的页面传递此参数，以方便快速翻页功能的实现。当到最后一页时，该字段为空。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "4765-48dXwxJtbkKXW8d3eb",
+          "example": "aEjUgqOnIv0S1ZxQ.aEJUb42r3tX61Y-a",
           "member": "string",
           "name": "PageToken",
           "output_required": true,
@@ -1970,47 +1970,43 @@
       "usage": "out"
     },
     "TaskFilter": {
-      "document": "Cos TaskFilter ",
+      "document": "Cos TaskFilter",
       "members": [
         {
           "disabled": false,
           "document": "任务业务类型",
-          "example": "1",
+          "example": "default",
           "member": "string",
           "name": "BizType",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
           "document": "任务类型，可选：VIDEO，AUDIO， LIVE_VIDEO, LIVE_AUDIO",
-          "example": "1",
+          "example": "VIDEO",
           "member": "string",
           "name": "Type",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
           "document": "建议，可选：Pass, Review,Block",
-          "example": "1",
+          "example": "Pass",
           "member": "string",
           "name": "Suggestion",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
           "document": "状态，可选：PENDING，RUNNING，ERROR，FINISH，CANCELLED",
-          "example": "1",
+          "example": "FINISH",
           "member": "string",
           "name": "TaskStatus",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         }
       ],
       "usage": "in"