{
  "name": "gme",
  "display_name": "游戏多媒体引擎",
  "description": "本文介绍如何使用 API 对游戏多媒体引擎进行操作，包括语音分析、用量等。",
  "domain": "other",
  "api_version": "2018-07-11",
  "endpoint": "gme.tencentcloudapi.com",
  "actions": [
    {
      "name": "ControlAIConversation",
      "description": "提供服务端控制机器人的功能",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务唯一标识",
          "example": "v2*****test"
        },
        {
          "name": "Command",
          "type": "string",
          "required": true,
          "description": "控制命令，目前支持命令如下：- ServerPushText，服务端发送文本给AI机器人，AI机器人会播报该文本. - InvokeLLM，服务端发送文本给大模型，触发对话",
          "example": "ServerPushText"
        },
        {
          "name": "ServerPushText",
          "type": "object",
          "required": false,
          "description": "服务端发送播报文本命令，当Command为ServerPushText时必填",
          "example": "无",
          "children": [
            {
              "name": "Text",
              "type": "string",
              "required": false,
              "description": "服务端推送播报文本",
              "example": "无"
            },
            {
              "name": "Interrupt",
              "type": "boolean",
              "required": false,
              "description": "是否允许该文本打断机器人说话",
              "example": "无"
            },
            {
              "name": "StopAfterPlay",
              "type": "boolean",
              "required": false,
              "description": "播报完文本后，是否自动关闭对话任务",
              "example": "无"
            },
            {
              "name": "Audio",
              "type": "string",
              "required": false,
              "description": "服务端推送播报音频 格式说明：音频必须为单声道，采样率必须跟对应TTS的采样率保持一致，编码为Base64字符串。 输入规则：当提供Audio字段时，将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。",
              "example": "无"
            },
            {
              "name": "DropMode",
              "type": "integer",
              "required": false,
              "description": "默认为0，仅在Interrupt为false时有效 - 0表示当前有交互发生时，会丢弃Interrupt为false的消息 - 1表示当前有交互发生时，不会丢弃Interrupt为false的消息，而是缓存下来，等待当前交互结束后，再去处理 注意：DropMode为1时，允许缓存多个消息，如果后续出现了打断，缓存的消息会被清空",
              "example": "0"
            },
            {
              "name": "Priority",
              "type": "integer",
              "required": false,
              "description": "ServerPushText消息的优先级，0表示可被打断，1表示不会被打断。**目前仅支持传入0，如果需要传入1，请提工单联系我们添加权限。** 注意：在接收到Priority=1的消息后，后续其他任何消息都会被忽略（包括Priority=1的消息），直到Priority=1的消息处理结束。该字段可与Interrupt、DropMode字段配合使用。 例子： - Priority=1、Interrupt=true，会打断现有交互，立刻播报，播报过程中不会被打断...",
              "example": "0"
            }
          ]
        },
        {
          "name": "InvokeLLM",
          "type": "object",
          "required": false,
          "description": "服务端发送命令主动请求大模型,当Command为InvokeLLM时会把content请求到大模型,头部增加X-Invoke-LLM=\"1\"",
          "example": "无",
          "children": [
            {
              "name": "Content",
              "type": "string",
              "required": false,
              "description": "请求LLM的内容",
              "example": "今天天气怎么样"
            },
            {
              "name": "Interrupt",
              "type": "boolean",
              "required": false,
              "description": "是否允许该文本打断机器人说话",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "TaskId",
        "Command"
      ]
    },
    {
      "name": "CreateAgeDetectTask",
      "description": "目前该功能底层能力已不具备，不对外提供，目前需要下线，走预下线流程。 用于创建年龄语音识别任务的接口，请求频率10次/秒。该接口目前通过白名单开放试用，如有需求，请提交工单申请。 接口功能说明： 支持对语音文件进行检测，判断是否为未成年人。 支持批量提交检测子任务。检测子任务列表最多支持100个。 音频文件限制说明： 音频文件大小限制：10 M 音频文件...",
      "status": "deprecated",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用id",
          "example": "123456"
        },
        {
          "name": "Tasks",
          "type": "array",
          "required": true,
          "description": "语音检测子任务列表，列表最多支持100个检测子任务。结构体中包含： DataId：数据的唯一ID Url：数据文件的url，为 urlencode 编码，流式则为拉流地址",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "DataId",
              "type": "string",
              "required": true,
              "description": "数据唯一ID",
              "example": "abcd"
            },
            {
              "name": "Url",
              "type": "string",
              "required": true,
              "description": "数据文件的url，为 urlencode 编码,音频文件格式支持的类型：.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg",
              "example": "https://xxx.com/yy.wav"
            }
          ]
        },
        {
          "name": "Callback",
          "type": "string",
          "required": false,
          "description": "任务结束时gme后台会自动触发回调",
          "example": "https://xxx.com/callback"
        }
      ],
      "required": [
        "BizId",
        "Tasks"
      ]
    },
    {
      "name": "CreateApp",
      "description": "本接口(CreateApp)用于创建一个GME应用。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称",
          "example": "simple_gme_application"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "腾讯云项目ID，默认为0，表示默认项目",
          "example": "0"
        },
        {
          "name": "EngineList",
          "type": "array",
          "required": false,
          "description": "需要支持的引擎列表，默认全选。 取值：android/ios/unity/cocos/unreal/windows",
          "example": "[\"0\",\"1\"]",
          "item_type": "string"
        },
        {
          "name": "RegionList",
          "type": "array",
          "required": false,
          "description": "服务区域列表，默认全选。 取值：mainland-大陆地区，hmt-港澳台，sea-东南亚，na-北美，eu-欧洲，jpkr-日韩亚太，sa-南美，oc-澳洲，me-中东",
          "example": "[\"mainland\",\"na\"]",
          "item_type": "string"
        },
        {
          "name": "RealtimeSpeechConf",
          "type": "object",
          "required": false,
          "description": "实时语音服务配置数据",
          "example": "无",
          "children": [
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "实时语音服务开关，取值：open/close",
              "example": "open"
            },
            {
              "name": "Quality",
              "type": "string",
              "required": false,
              "description": "实时语音音质类型，取值：high-高音质 ordinary-普通音质",
              "example": "high"
            }
          ]
        },
        {
          "name": "VoiceMessageConf",
          "type": "object",
          "required": false,
          "description": "语音消息服务配置数据",
          "example": "无",
          "children": [
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "离线语音服务开关，取值：open/close",
              "example": "open"
            },
            {
              "name": "Language",
              "type": "string",
              "required": false,
              "description": "离线语音支持语种，取值： all-全部，cnen-中英文。默认为中英文",
              "example": "all"
            }
          ]
        },
        {
          "name": "VoiceFilterConf",
          "type": "object",
          "required": false,
          "description": "语音分析服务配置数据",
          "example": "无",
          "children": [
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "语音过滤服务开关，取值：open/close",
              "example": "open"
            },
            {
              "name": "SceneInfos",
              "type": "array",
              "required": false,
              "description": "场景配置信息，如开关状态，回调地址。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "SceneId",
                  "type": "string",
                  "required": true,
                  "description": "'RealTime','实时语音分析', 'VoiceMessage','语音消息', 'GMECloudApi':'GME云API接口'",
                  "example": "RealTime"
                },
                {
                  "name": "Status",
                  "type": "boolean",
                  "required": true,
                  "description": "开关状态，true开启/false关闭",
                  "example": "false"
                },
                {
                  "name": "CallbackUrl",
                  "type": "string",
                  "required": false,
                  "description": "用户回调地址",
                  "example": "https://0.0.0.0/user_callback"
                }
              ]
            }
          ]
        },
        {
          "name": "AsrConf",
          "type": "object",
          "required": false,
          "description": "语音转文本配置数据",
          "example": "无",
          "children": [
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "语音转文本服务开关，取值：open/close",
              "example": "open"
            }
          ]
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "需要添加的标签列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键",
              "example": "tag_key1"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签值",
              "example": "tag_value1"
            }
          ]
        }
      ],
      "required": [
        "AppName"
      ]
    },
    {
      "name": "CreateCustomization",
      "description": "用户使用该接口可以创建语音消息转文本热句模型，以供识别调用",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID，登录控制台创建应用得到的AppID",
          "example": "1400000000"
        },
        {
          "name": "TextUrl",
          "type": "string",
          "required": true,
          "description": "文本文件的下载地址，服务会从该地址下载文件，目前仅支持腾讯云cos",
          "example": "https://gme-xxx.cos.xxx.com/customization/1400000000/1400000000_customization"
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": false,
          "description": "模型名称，名称长度不超过36，默认为BizId。",
          "example": "ModelName"
        }
      ],
      "required": [
        "BizId",
        "TextUrl"
      ]
    },
    {
      "name": "CreateScanUser",
      "description": "新增自定义送检用户。**接口使用前提**：目前 CreateScanUser 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438\u0026level2_id=445\u0026source=0\u0026data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME\u0026step=1)。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID，登录控制台 - 服务管理创建应用得到的AppID",
          "example": "1"
        },
        {
          "name": "UserId",
          "type": "integer",
          "required": false,
          "description": "需要新增送检的用户号。示例：1234 (若UserId不填，则UserIdString必填；两者选其一；两者都填以UserIdString为准)",
          "example": "1"
        },
        {
          "name": "UserIdString",
          "type": "string",
          "required": false,
          "description": "需要新增送检的用户号，长度不超过1024字符。示例：\"1234\"(若UserIdString不填，则UserId必填；两者选其一；两者都填以UserIdString为准)",
          "example": "\"1\""
        },
        {
          "name": "ExpirationTime",
          "type": "integer",
          "required": false,
          "description": "当前用户送检过期时间，单位：秒。 若参数不为0，则在过期时间之后，用户不会被送检。 若参数为0，则送检配置不会自动失效。",
          "example": "30"
        }
      ],
      "required": [
        "BizId"
      ]
    },
    {
      "name": "DeleteCustomization",
      "description": "用户通过该接口可以删除语音消息转文本热句模型",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "删除的模型ID",
          "example": "f440dfa77ae411eda5d3564a2eb5fd49"
        },
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID，登录控制台创建应用得到的AppID",
          "example": "1400000000"
        }
      ],
      "required": [
        "ModelId",
        "BizId"
      ]
    },
    {
      "name": "DeleteRoomMember",
      "description": "本接口(DeleteRoomMember)用户删除房间或者剔除房间内用户",
      "status": "online",
      "parameters": [
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "要操作的房间id",
          "example": "100"
        },
        {
          "name": "DeleteType",
          "type": "integer",
          "required": true,
          "description": "剔除类型 1-删除房间 2-剔除用户",
          "example": "2"
        },
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用id",
          "example": "1400000000"
        },
        {
          "name": "Uids",
          "type": "array",
          "required": false,
          "description": "要剔除的用户列表（整型）",
          "example": "[\"1\\r\\n\",\"2\\r\\n\"]",
          "item_type": "string"
        },
        {
          "name": "StrUids",
          "type": "array",
          "required": false,
          "description": "要剔除的用户列表（字符串类型）",
          "example": "[\"Andy\",\"John\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "RoomId",
        "DeleteType",
        "BizId"
      ]
    },
    {
      "name": "DeleteScanUser",
      "description": "删除自定义送检用户。**接口使用前提**：目前 DeleteScanUser 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438\u0026level2_id=445\u0026source=0\u0026data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME\u0026step=1)。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID，登录控制台 - 服务管理创建应用得到的AppID",
          "example": "1400000000"
        },
        {
          "name": "UserId",
          "type": "integer",
          "required": false,
          "description": "需要删除送检的用户号。示例：1234 (若UserId不填，则UserIdString必填；两者选其一；两者都填以UserIdString为准)",
          "example": "1"
        },
        {
          "name": "UserIdString",
          "type": "string",
          "required": false,
          "description": "需要删除送检的用户号，长度不超过1024字符。示例：\"1234\"(若UserIdString不填，则UserId必填；两者选其一；两者都填以UserIdString为准)",
          "example": "“1”"
        }
      ],
      "required": [
        "BizId"
      ]
    },
    {
      "name": "DeleteVoicePrint",
      "description": "传入声纹ID，删除之前注册的声纹信息",
      "status": "online",
      "parameters": [
        {
          "name": "VoicePrintId",
          "type": "string",
          "required": true,
          "description": "声纹信息ID",
          "example": "20250529_xxxxxx"
        }
      ],
      "required": [
        "VoicePrintId"
      ]
    },
    {
      "name": "DescribeAIConversation",
      "description": "查询AI对话任务状态。",
      "status": "online",
      "parameters": [
        {
          "name": "SdkAppId",
          "type": "integer",
          "required": false,
          "description": "GME的SdkAppId，和开启转录任务的房间使用的SdkAppId相同。",
          "example": "1400000000"
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "唯一标识一次任务。",
          "example": "SV1FR+XTtvzAjRxZZ+aof1DfJF00VSBBNE0zR9W-PEpgCPBmt402BbnqMCdom79LtZO-VbLyV1nhVY1pFauWgrW12BevPvJ5Zn010nD6vj3hgfbVH0."
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgeDetectTask",
      "description": "目前该功能底层能力已不具备，不对外提供，目前需要下线，走预下线流程。 查询年龄语音识别任务结果，请求频率10次/秒。该接口目前通过白名单开放试用，如有需求，请提交工单申请。",
      "status": "deprecated",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用id",
          "example": "123456"
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "[创建年龄语音识别任务](https://cloud.tencent.com/document/product/607/60620)时返回的taskid",
          "example": "6330xxxx-9xx7-11ed-98e3-52xxxxe4ac3b"
        }
      ],
      "required": [
        "BizId",
        "TaskId"
      ]
    },
    {
      "name": "DescribeAppStatistics",
      "description": "本接口(DescribeAppStatistics)用于获取某个GME应用的用量数据。包括实时语音，语音消息及转文本，语音分析等。最长查询周期为最近60天。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "GME应用ID",
          "example": "140000001"
        },
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "数据开始时间，东八区时间，格式: 年-月-日，如: 2018-07-13",
          "example": "2019-08-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "数据结束时间，东八区时间，格式: 年-月-日，如: 2018-07-13",
          "example": "2019-08-03"
        },
        {
          "name": "Services",
          "type": "array",
          "required": true,
          "description": "要查询的服务列表，取值：RealTimeSpeech/VoiceMessage/VoiceFilter/SpeechToText",
          "example": "[\"RealTimeSpeech\\r\\n\",\"VoiceMessage\\r\\n\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "BizId",
        "StartDate",
        "EndDate",
        "Services"
      ]
    },
    {
      "name": "DescribeApplicationData",
      "description": "本接口(DescribeApplicationData)用于获取数据详情信息，最多可拉取最近90天的数据。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID",
          "example": "140000001"
        },
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "数据开始时间，格式为 年-月-日，如: 2018-07-13",
          "example": "2018-07-13"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "数据结束时间，格式为 年-月-日，如: 2018-07-13",
          "example": "2018-08-13"
        }
      ],
      "required": [
        "BizId",
        "StartDate",
        "EndDate"
      ]
    },
    {
      "name": "DescribeApplicationList",
      "description": "本接口(DescribeApplicationList)用于查询自己账号下的应用列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目ID，0表示默认项目，-1表示所有项目，如果需要查找具体项目下的应用列表，请填入具体项目ID，项目ID在项目管理中查看 https://console.cloud.tencent.com/project",
          "example": "0"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": true,
          "description": "页码ID，0表示第一页，以此后推。默认填0",
          "example": "0"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每页展示应用数量。默认填200",
          "example": "10"
        },
        {
          "name": "SearchText",
          "type": "string",
          "required": true,
          "description": "所查找应用名称的关键字，支持模糊匹配查找。空串表示查询所有应用",
          "example": "app_game"
        },
        {
          "name": "TagSet",
          "type": "array",
          "required": false,
          "description": "标签列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键",
              "example": "tag_key1"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签值",
              "example": "tag_value1"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查找过滤关键字列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "要过滤的字段名, 比如\"AppName\"",
              "example": "AppName"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "多个关键字",
              "example": "app_game",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "ProjectId",
        "PageNo",
        "PageSize",
        "SearchText"
      ]
    },
    {
      "name": "DescribeAuditResultExternal",
      "description": "获审核结果明细（外部API）",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID",
          "example": "15000000000"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": true,
          "description": "页数 取值范围：\u003e=1",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每页大小",
          "example": "10"
        },
        {
          "name": "BeginTime",
          "type": "integer",
          "required": true,
          "description": "起始时间戳（秒）",
          "example": "1761224396"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "截止时间戳（秒）",
          "example": "1761224570"
        },
        {
          "name": "MinRate",
          "type": "integer",
          "required": true,
          "description": "最小恶意分数",
          "example": "50"
        },
        {
          "name": "MaxRate",
          "type": "integer",
          "required": true,
          "description": "最大恶意分数",
          "example": "100"
        },
        {
          "name": "OpenId",
          "type": "string",
          "required": true,
          "description": "UserID",
          "example": "10086"
        },
        {
          "name": "Label",
          "type": "string",
          "required": false,
          "description": "恶意分类",
          "example": "Normal"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": false,
          "description": "房间 ID",
          "example": "200"
        }
      ],
      "required": [
        "BizId",
        "PageNo",
        "PageSize",
        "BeginTime",
        "EndTime",
        "MinRate",
        "MaxRate",
        "OpenId"
      ]
    },
    {
      "name": "DescribeRealtimeScanConfig",
      "description": "获取用户自定义送检信息。**接口使用前提**：目前 DescribeRealtimeScanConfig 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438\u0026level2_id=445\u0026source=0\u0026data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME\u0026step=1)。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID。",
          "example": "1"
        }
      ],
      "required": [
        "BizId"
      ]
    },
    {
      "name": "DescribeRecordInfo",
      "description": "查询录制任务信息。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "进行中的任务taskid（StartRecord接口返回）。",
          "example": "446192236330927912"
        },
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID。",
          "example": "3400352518"
        }
      ],
      "required": [
        "TaskId",
        "BizId"
      ]
    },
    {
      "name": "DescribeRoomInfo",
      "description": "获取房间内用户信息",
      "status": "online",
      "parameters": [
        {
          "name": "SdkAppId",
          "type": "integer",
          "required": true,
          "description": "应用ID，登录控制台 - 服务管理创建应用得到的AppID",
          "example": "1400000000"
        },
        {
          "name": "RoomIds",
          "type": "array",
          "required": false,
          "description": "房间号列表，最大不能超过10个（RoomIds、StrRoomIds必须填一个）",
          "example": "[1234, 2345]",
          "item_type": "integer"
        },
        {
          "name": "StrRoomIds",
          "type": "array",
          "required": false,
          "description": "字符串类型房间号列表，最大不能超过10个（RoomIds、StrRoomIds必须填一个）",
          "example": "[\"100982048\", \"100982049\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "SdkAppId"
      ]
    },
    {
      "name": "DescribeScanResultList",
      "description": "本接口(DescribeScanResultList)用于查询语音检测结果，查询任务列表最多支持100个。 如果在提交语音检测任务时未设置 Callback 字段，则需要通过本接口获取检测结果",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID，登录[控制台](https://console.cloud.tencent.com/gamegme)创建应用得到的AppID",
          "example": "1400000000"
        },
        {
          "name": "TaskIdList",
          "type": "array",
          "required": true,
          "description": "查询的任务 ID 列表，任务 ID 列表最多支持 100 个。",
          "example": "[\"xxx\\r\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "任务返回结果数量，默认10，上限500。大文件任务忽略此参数，返回全量结果",
          "example": "20"
        }
      ],
      "required": [
        "BizId",
        "TaskIdList"
      ]
    },
    {
      "name": "DescribeTaskInfo",
      "description": "查询房间录制的详细信息",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID。",
          "example": "3400352518"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "房间ID。",
          "example": "9832"
        }
      ],
      "required": [
        "BizId",
        "RoomId"
      ]
    },
    {
      "name": "DescribeUserInAndOutTime",
      "description": "拉取用户在房间得进出时间",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID",
          "example": "1400440313"
        },
        {
          "name": "RoomId",
          "type": "integer",
          "required": true,
          "description": "房间ID",
          "example": "12675079"
        },
        {
          "name": "UserId",
          "type": "integer",
          "required": true,
          "description": "用户ID",
          "example": "112675079"
        },
        {
          "name": "UserIdStr",
          "type": "string",
          "required": false,
          "description": "字符串类型用户ID",
          "example": "112675079"
        },
        {
          "name": "RoomIdStr",
          "type": "string",
          "required": false,
          "description": "字符串类型房间ID",
          "example": "12675079"
        }
      ],
      "required": [
        "BizId",
        "RoomId",
        "UserId"
      ]
    },
    {
      "name": "DescribeVoicePrint",
      "description": "查询先前注册的声纹信息",
      "status": "online",
      "parameters": [
        {
          "name": "DescribeMode",
          "type": "integer",
          "required": true,
          "description": "查询方式，0表示查询特定VoicePrintId，1表示分页查询",
          "example": "1"
        },
        {
          "name": "VoicePrintIdList",
          "type": "array",
          "required": false,
          "description": "声纹ID",
          "example": "[\"13000569124-fd91f128-52a6-4692-b94a-c0f9fd3c4287\"]",
          "item_type": "string"
        },
        {
          "name": "PageIndex",
          "type": "integer",
          "required": false,
          "description": "当前页码,从1开始,DescribeMode为1时填写",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页条数 最少20,DescribeMode为1时填写",
          "example": "20"
        }
      ],
      "required": [
        "DescribeMode"
      ]
    },
    {
      "name": "GetCustomizationList",
      "description": "查询语音消息转文本热句模型列表",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID，登录控制台创建应用得到的AppID",
          "example": "1400000000"
        }
      ],
      "required": [
        "BizId"
      ]
    },
    {
      "name": "ModifyAppStatus",
      "description": "本接口(ModifyAppStatus)用于修改应用总开关状态。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID，创建应用后由后台生成并返回。",
          "example": "140000001"
        },
        {
          "name": "Status",
          "type": "string",
          "required": true,
          "description": "应用状态，取值：open/close",
          "example": "close"
        }
      ],
      "required": [
        "BizId",
        "Status"
      ]
    },
    {
      "name": "ModifyCustomization",
      "description": "用户通过该接口可以更新语音消息转文本热句模型。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID，登录控制台创建应用得到的AppID",
          "example": "1400000000"
        },
        {
          "name": "TextUrl",
          "type": "string",
          "required": true,
          "description": "文本文件的下载地址，服务会从该地址下载文件，目前仅支持腾讯云cos",
          "example": "https://gme-xxx.cos.xxx.com/customization/1400000000/1400000000_customization"
        },
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "修改的模型ID",
          "example": "f440dfa77ae411eda5d3564a2eb5fd49"
        }
      ],
      "required": [
        "BizId",
        "TextUrl",
        "ModelId"
      ]
    },
    {
      "name": "ModifyCustomizationState",
      "description": "通过该接口，用户可以修改语音消息转文本热句模型状态，上下线热句模型",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "模型ID",
          "example": "f440dfa77ae411eda5d3564a2eb5fd49"
        },
        {
          "name": "ToState",
          "type": "integer",
          "required": true,
          "description": "想要变换的模型状态，-1代表下线，1代表上线",
          "example": "1"
        },
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用 ID，登录控制台创建应用得到的AppID",
          "example": "1400000000"
        }
      ],
      "required": [
        "ModelId",
        "ToState",
        "BizId"
      ]
    },
    {
      "name": "ModifyRecordInfo",
      "description": "修改录制配置信息",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "进行中的任务taskid（StartRecord接口返回）。",
          "example": "446192236330927912"
        },
        {
          "name": "RecordMode",
          "type": "integer",
          "required": true,
          "description": "录制类型：1代表单流 2代表混流 3代表单流和混流。",
          "example": "1"
        },
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID。",
          "example": "3400352518"
        },
        {
          "name": "SubscribeRecordUserIds",
          "type": "object",
          "required": false,
          "description": "指定订阅流白名单或者黑名单。",
          "example": "无",
          "children": [
            {
              "name": "UnSubscribeUserIds",
              "type": "array",
              "required": false,
              "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。 注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数",
              "example": "7619",
              "item_type": "string"
            },
            {
              "name": "SubscribeUserIds",
              "type": "array",
              "required": false,
              "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。 注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数。",
              "example": "3342",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "TaskId",
        "RecordMode",
        "BizId"
      ]
    },
    {
      "name": "ModifyUserMicStatus",
      "description": "**接口作用**：此接口用于修改房间用户的麦克风状态，例如房间内用户麦克风为打开状态，可调用此接口将该用户麦克风进行关闭，关闭后即使该用户使用客户端接口 EnableMic 打开麦克风，依然无法与房间内成员通话，属于被禁言状态。该状态持续到此用户退房后失效，或者调用该接口重新打开此用户麦克风状态。 **接口应用场景**：此接口多用于游戏业务中台或者风控后台，...",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "来自 [腾讯云控制台](https://console.cloud.tencent.com/gamegme) 的 GME 服务提供的 AppID，获取请参考 [语音服务开通指引](https://cloud.tencent.com/document/product/607/10782#.E9.87.8D.E7.82.B9.E5.8F.82.E6.95.B0)。",
          "example": "1400000000"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "实时语音房间号。",
          "example": "261974"
        },
        {
          "name": "Users",
          "type": "array",
          "required": true,
          "description": "需要操作的房间内用户以及该用户的目标麦克风状态。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "EnableMic",
              "type": "integer",
              "required": true,
              "description": "开麦状态。1表示关闭麦克风，2表示打开麦克风。",
              "example": "1"
            },
            {
              "name": "Uid",
              "type": "integer",
              "required": false,
              "description": "客户端用于标识用户的Openid。（Uid、StrUid必须填一个，优先处理StrUid。）",
              "example": "9798"
            },
            {
              "name": "StrUid",
              "type": "string",
              "required": false,
              "description": "客户端用于标识字符串型用户的Openid。（Uid、StrUid必须填一个，优先处理StrUid。）",
              "example": "jelly"
            }
          ]
        }
      ],
      "required": [
        "BizId",
        "RoomId",
        "Users"
      ]
    },
    {
      "name": "RegisterVoicePrint",
      "description": "传入音频base64串，注册声纹信息，返回声纹ID",
      "status": "online",
      "parameters": [
        {
          "name": "Audio",
          "type": "string",
          "required": true,
          "description": "整个wav音频文件的base64字符串,其中wav文件限定为16k采样率, 16bit位深, 单声道, 4到18秒音频时长,有效音频不小于3秒(不能有太多静音段), 编码数据大小不超过2M, 为了识别准确率，建议音频长度为8秒",
          "example": "kAOgA9AEA..."
        },
        {
          "name": "ReqTimestamp",
          "type": "integer",
          "required": true,
          "description": "毫秒时间戳",
          "example": "1748249540000"
        },
        {
          "name": "AudioFormat",
          "type": "integer",
          "required": true,
          "description": "音频格式,目前只支持0,代表wav",
          "example": "0"
        },
        {
          "name": "AudioName",
          "type": "string",
          "required": true,
          "description": "音频名称,长度不要超过32",
          "example": "jackson"
        },
        {
          "name": "AudioMetaInfo",
          "type": "string",
          "required": false,
          "description": "和声纹绑定的MetaInfo，长度最大不超过512",
          "example": "metainfo string"
        }
      ],
      "required": [
        "Audio",
        "ReqTimestamp",
        "AudioFormat",
        "AudioName"
      ]
    },
    {
      "name": "ScanVoice",
      "description": "本接口(ScanVoice)用于提交语音检测任务，检测任务列表最多支持100个。使用前请您登录[控制台 - 服务配置](https://console.cloud.tencent.com/gamegme/conf)开启语音内容安全服务。 接口功能说明： 支持对语音流或语音文件进行检测，判断其中是否包含违规内容。 支持设置回调地址 Callback 获取检测结果，同时支持通过接口(查询语音检测结果)主动轮询获取检测结果。 支持场景输入，包括：...",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID，登录控制台 - 服务管理创建应用得到的AppID",
          "example": "1400000000"
        },
        {
          "name": "Scenes",
          "type": "array",
          "required": true,
          "description": "语音检测场景，参数值目前要求为 default。 预留场景设置： 谩骂、色情、广告、违禁等场景，具体取值见上述 Label 说明。",
          "example": "[\"default\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Live",
          "type": "boolean",
          "required": true,
          "description": "是否为直播流。值为 false 时表示普通语音文件检测；为 true 时表示语音流检测。",
          "example": "false"
        },
        {
          "name": "Tasks",
          "type": "array",
          "required": true,
          "description": "语音检测任务列表，列表最多支持100个检测任务。结构体中包含：DataId：数据的唯一IDUrl：数据文件的url，为 urlencode 编码，流式则为拉流地址",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "DataId",
              "type": "string",
              "required": true,
              "description": "数据的唯一ID",
              "example": "1400000000_test_data_id"
            },
            {
              "name": "Url",
              "type": "string",
              "required": true,
              "description": "数据文件的url，为 urlencode 编码，流式则为拉流地址",
              "example": "http:\\/\\/xxxx\\/audio_store\\/xxxx.mp3"
            },
            {
              "name": "RoomId",
              "type": "string",
              "required": false,
              "description": "gme实时语音房间ID，通过gme实时语音进行语音分析时输入",
              "example": "261974"
            },
            {
              "name": "OpenId",
              "type": "string",
              "required": false,
              "description": "gme实时语音用户ID，通过gme实时语音进行语音分析时输入",
              "example": "100261"
            }
          ]
        },
        {
          "name": "Callback",
          "type": "string",
          "required": false,
          "description": "异步检测结果回调地址，具体见上述回调相关说明。（说明：该字段为空时，必须通过接口(查询语音检测结果)获取检测结果）。",
          "example": "https://0.0.0.0/user_callback"
        },
        {
          "name": "Lang",
          "type": "string",
          "required": false,
          "description": "语种，不传默认中文",
          "example": "jp"
        }
      ],
      "required": [
        "BizId",
        "Scenes",
        "Live",
        "Tasks"
      ]
    },
    {
      "name": "StartAIConversation",
      "description": "启动AI对话任务，AI通道机器人进入GME房间，与房间内指定的成员进行AI对话，适用于智能客服，AI口语教师等场景 GME AI对话功能内置语音转文本能力，同时提供通道服务，即客户可灵活指定第三方AI模型（LLM）服务和文本转音频（TTS）服务，更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。",
      "status": "online",
      "parameters": [
        {
          "name": "SdkAppId",
          "type": "integer",
          "required": true,
          "description": "GME的SdkAppId和开启转录任务的房间使用的SdkAppId相同。",
          "example": "14000000000"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "GME的RoomId表示开启对话任务的房间号。",
          "example": "10000"
        },
        {
          "name": "AgentConfig",
          "type": "object",
          "required": true,
          "description": "机器人参数",
          "example": "无",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": true,
              "description": "机器人的UserId，用于进房发起任务。【注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个任务时，机器人的UserId也不能相互重复，否则会中断前一个任务。需要保证机器人UserId在房间内唯一。",
              "example": "user_124"
            },
            {
              "name": "UserSig",
              "type": "string",
              "required": true,
              "description": "机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码。",
              "example": "ehbciOiJS"
            },
            {
              "name": "TargetUserId",
              "type": "string",
              "required": true,
              "description": "机器人拉流的UserId, 填写后，机器人会拉取该UserId的流进行实时处理",
              "example": "user_124"
            },
            {
              "name": "MaxIdleTime",
              "type": "integer",
              "required": false,
              "description": "房间内超过MaxIdleTime 没有推流，后台自动关闭任务，默认值是60s。",
              "example": "60"
            },
            {
              "name": "WelcomeMessage",
              "type": "string",
              "required": false,
              "description": "机器人的欢迎语",
              "example": "你好呀"
            },
            {
              "name": "InterruptMode",
              "type": "integer",
              "required": false,
              "description": "智能打断模式，默认为0，0表示服务端自动打断，1表示服务端不打断，由端上发送打断信令进行打断",
              "example": "0"
            },
            {
              "name": "InterruptSpeechDuration",
              "type": "integer",
              "required": false,
              "description": "InterruptMode为0时使用，单位为毫秒，默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断。",
              "example": "500"
            },
            {
              "name": "TurnDetectionMode",
              "type": "integer",
              "required": false,
              "description": "控制新一轮对话的触发方式，默认为0。 - 0表示当服务端语音识别检测出的完整一句话后，自动触发一轮新的对话。 - 1表示客户端在收到字幕消息后，自行决定是否手动发送聊天信令触发一轮新的对话。",
              "example": "0"
            },
            {
              "name": "FilterOneWord",
              "type": "boolean",
              "required": false,
              "description": "是否过滤掉用户只说了一个字的句子，true表示过滤，false表示不过滤，默认值为true",
              "example": "true"
            },
            {
              "name": "WelcomeMessagePriority",
              "type": "integer",
              "required": false,
              "description": "欢迎消息优先级，0默认，1高优，高优不能被打断。",
              "example": "0"
            },
            {
              "name": "FilterBracketsContent",
              "type": "integer",
              "required": false,
              "description": "用于过滤LLM返回内容，不播放括号中的内容。 1：中文括号（） 2：英文括号() 3：中文方括号【】 4：英文方括号[] 5：英文花括号{} 默认值为空，表示不进行过滤。",
              "example": "1"
            },
            {
              "name": "AmbientSound",
              "type": "object",
              "required": false,
              "description": "环境音设置",
              "example": "无",
              "children": [
                {
                  "name": "Scene",
                  "type": "string",
                  "required": true,
                  "description": "环境场景选择",
                  "example": "coffee_shops"
                },
                {
                  "name": "Volume",
                  "type": "float",
                  "required": false,
                  "description": "控制环境音的音量。取值的范围是 [0,2]。值越低，环境音越小；值越高，环境音越响亮。如果未设置，则使用默认值 1。",
                  "example": "1.0"
                }
              ]
            },
            {
              "name": "VoicePrint",
              "type": "object",
              "required": false,
              "description": "声纹配置",
              "example": "无",
              "children": [
                {
                  "name": "Mode",
                  "type": "integer",
                  "required": false,
                  "description": "默认为0，表示不启用声纹。1表示启用声纹，此时需要填写voiceprint id。",
                  "example": "1"
                },
                {
                  "name": "IdList",
                  "type": "array",
                  "required": false,
                  "description": "VoicePrint Mode为1时需要填写，目前仅支持填写一个声纹id",
                  "example": "[\"your-voiceprint-id\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "InitLLMMessage",
              "type": "string",
              "required": false,
              "description": "与WelcomeMessage参数互斥，当该参数有值时，WelcomeMessage将失效。\\n在对话开始后把该消息送到大模型来获取欢迎语。",
              "example": "你好呀\t"
            },
            {
              "name": "TurnDetection",
              "type": "object",
              "required": false,
              "description": "语义断句检测",
              "example": "无",
              "children": [
                {
                  "name": "SemanticEagerness",
                  "type": "string",
                  "required": false,
                  "description": "TurnDetectionMode为3时生效，语义断句的灵敏程度 功能简介：根据用户所说的话来判断其已完成发言来分割音频 可选: \"low\" | \"medium\" | \"high\" | \"auto\" auto 是默认值，与 medium 相同。 low 将让用户有足够的时间说话。 high 将尽快对音频进行分块。 如果您希望模型在对话模式下更频繁地响应，可以将 SemanticEagerness 设置为 high 如果您希望在用户停顿时，AI能够等待片刻，可以将 SemanticEagerness ...",
                  "example": "auto"
                }
              ]
            },
            {
              "name": "SubtitleMode",
              "type": "integer",
              "required": false,
              "description": "机器人字幕显示模式。 - 0表示尽快显示，不会和音频播放进行同步。此时字幕全量下发，后面的字幕会包含前面的字幕。 - 1表示句子级别的实时显示，会和音频播放进行同步，只有当前句子对应的音频播放完后，下一条字幕才会下发。此时字幕增量下发，端上需要把前后的字幕进行拼接才是完整字幕。",
              "example": "1"
            }
          ]
        },
        {
          "name": "STTConfig",
          "type": "object",
          "required": false,
          "description": "语音识别配置。",
          "example": "无",
          "children": [
            {
              "name": "Language",
              "type": "string",
              "required": false,
              "description": "语音转文字支持识别的语言，默认是\"zh\" 中文 可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 语音转文本不同套餐版本支持的语言如下： **基础版**： - \"zh\": 中文（简体） - \"zh-TW\": 中文（繁体） - \"en\": 英语 **标准版：** - \"8k_zh_large\": 普方大模型引擎. 当前模型同时支持中文等语言的识别，模型参数量极大，语言模型性能增强，针对电话音频中各类场景\ufffd...",
              "example": "zh"
            },
            {
              "name": "AlternativeLanguage",
              "type": "array",
              "required": false,
              "description": "**发起模糊识别为高级版能力,默认按照高级版收费,仅支持填写基础版和高级版语言.** 注意：不支持填写\"zh-dialect\"",
              "example": "[\"AlternativeLanguage\"]",
              "item_type": "string"
            },
            {
              "name": "CustomParam",
              "type": "string",
              "required": false,
              "description": "自定义参数，联系后台使用",
              "example": "CustomParam"
            },
            {
              "name": "VadSilenceTime",
              "type": "integer",
              "required": false,
              "description": "语音识别vad的时间，范围为240-2000，默认为1000，单位为ms。更小的值会让语音识别分句更快。",
              "example": "1000"
            },
            {
              "name": "HotWordList",
              "type": "string",
              "required": false,
              "description": "热词表：该参数用于提升识别准确率。 单个热词限制：\"热词|权重\"，单个热词不超过30个字符（最多10个汉字），权重[1-11]或者100，如：“腾讯云|5” 或 “ASR|11”； 热词表限制：多个热词用英文逗号分割，最多支持128个热词，如：“腾讯云|10,语音识别|5,ASR|11”；",
              "example": "腾讯云|10,语音识别|5,ASR|11"
            },
            {
              "name": "VadLevel",
              "type": "integer",
              "required": false,
              "description": "vad的远场人声抑制能力（不会对asr识别效果造成影响），范围为[0, 3]，默认为0。推荐设置为2，有较好的远场人声抑制能力。",
              "example": "1"
            }
          ]
        },
        {
          "name": "LLMConfig",
          "type": "string",
          "required": false,
          "description": "LLM配置。需符合openai规范，为JSON字符串，示例如下： { \u0026emsp; \"LLMType\": \"大模型类型\", // String 必填，如：\"openai\" \u0026emsp; \"Model\": \"您的模型名称\", // String 必填，指定使用的模型 \"APIKey\": \"您的LLM API密钥\", // String 必填 \u0026emsp; \"APIUrl\": \"https://api.xxx.com/chat/completions\", // String 必填，LLM API访问的URL \u0026emsp; \"Streaming\": true // Boolean 非必填，指定是否使用流式传输 \u0026emsp;}",
          "example": "{\\\"LLMType\\\": \\\"openai\\\", \\\"Model\\\": \\\"gpt-xxx\", \\\"APIKey\\\": \\\"xxxxxxxx\\\", \\\"APIUrl\\\": \\\"https://api.xxx.com/v1/chat/completions\\\", \\\"Streaming\\\": true}"
        },
        {
          "name": "TTSConfig",
          "type": "string",
          "required": false,
          "description": "\"description\": \"TTS配置，为JSON字符串，腾讯云TTS示例如下： { \u0026emsp; \\\"AppId\\\": 您的应用ID, // Integer 必填 \u0026emsp; \\\"TTSType\\\": \\\"TTS类型\\\", // String TTS类型, 固定为\\\"tencent\\\" \u0026emsp; \\\"SecretId\\\": \\\"您的密钥ID\\\", // String 必填 \u0026emsp; \\\"SecretKey\\\": \\\"您的密钥Key\\\", // String 必填 \u0026emsp; \\\"VoiceType\\\": 101001, // Integer 必填，音色 ID，包括标准音色与精品音色，精品音色拟真度更高，价格不同于标准音色。 \u0026emsp; \\\"Speed\\\":...",
          "example": "{\\\"TTSType\\\": \\\"tencent\\\", \\\"AppId\\\": 136666666, \\\"SecretId\\\": \\\"xxxxxxx\\\", \\\"SecretKey\\\": \\\"xxxxxxx\\\", \\\"VoiceType\\\": 1008, \\\"Speed\\\": 1}"
        },
        {
          "name": "AvatarConfig",
          "type": "string",
          "required": false,
          "description": "数字人配置，为JSON字符串。**数字人配置需要提工单加白后才能使用**",
          "example": "{\\\"AvatarType\\\": \\\"tencent\\\", \\\"Appkey\\\": \\\"数字人的appkey\\\", \\\"AccessToken\\\": \\\"token\\\",\\\"AssetVirtualmanKey\\\": \\\"2d64a32c02604b8db35d457ba0db0d75\\\", \\\"AvatarUserID\\\": \\\"robot_xiaowei\\\", \\\"DriverType\\\": 1, \\\"AvatarUserSig\\\": \\\"user_sign\\\"}"
        },
        {
          "name": "ExperimentalParams",
          "type": "string",
          "required": false,
          "description": "实验性参数,联系后台使用",
          "example": "{\"internal\": \"xxx\"}"
        }
      ],
      "required": [
        "SdkAppId",
        "RoomId",
        "AgentConfig"
      ]
    },
    {
      "name": "StartRecord",
      "description": "开启录制",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID。",
          "example": "3400352518"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "房间ID。",
          "example": "1987"
        },
        {
          "name": "RecordMode",
          "type": "integer",
          "required": true,
          "description": "录制类型：1代表单流 2代表混流 3代表单流和混流。",
          "example": "1"
        },
        {
          "name": "SubscribeRecordUserIds",
          "type": "object",
          "required": false,
          "description": "指定订阅流白名单或者黑名单（不传默认订阅房间内所有音频流）。",
          "example": "无",
          "children": [
            {
              "name": "UnSubscribeUserIds",
              "type": "array",
              "required": false,
              "description": "订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表不订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。 注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数",
              "example": "7619",
              "item_type": "string"
            },
            {
              "name": "SubscribeUserIds",
              "type": "array",
              "required": false,
              "description": "订阅音频流白名单，指定订阅哪几个UserId的音频流，例如[\"1\", \"2\", \"3\"], 代表订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。 注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数。",
              "example": "3342",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "BizId",
        "RoomId",
        "RecordMode"
      ]
    },
    {
      "name": "StopAIConversation",
      "description": "停止AI对话任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "唯一标识任务。",
          "example": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ.."
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "StopRecord",
      "description": "停止录制",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID。",
          "example": "446192236330927912"
        },
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID。",
          "example": "3400352518"
        }
      ],
      "required": [
        "TaskId",
        "BizId"
      ]
    },
    {
      "name": "UpdateAIConversation",
      "description": "更新AIConversation参数",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "唯一标识一个任务",
          "example": "your-taskid"
        },
        {
          "name": "WelcomeMessage",
          "type": "string",
          "required": false,
          "description": "不填写则不进行更新，机器人的欢迎语",
          "example": "你好呀"
        },
        {
          "name": "InterruptMode",
          "type": "integer",
          "required": false,
          "description": "不填写则不进行更新。智能打断模式，0表示服务端自动打断，1表示服务端不打断，由端上发送打断信令进行打断",
          "example": "0"
        },
        {
          "name": "InterruptSpeechDuration",
          "type": "integer",
          "required": false,
          "description": "不填写则不进行更新。InterruptMode为0时使用，单位为毫秒，默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断",
          "example": "500"
        },
        {
          "name": "LLMConfig",
          "type": "string",
          "required": false,
          "description": "不填写则不进行更新，LLM配置，详情见StartAIConversation接口",
          "example": "{\\\\\\\"LLMType\\\\\\\": \\\\\\\"openai\\\\\\\", \\\\\\\"Model\\\\\\\": \\\\\\\"gpt-xxx\\\", \\\\\\\"APIKey\\\\\\\": \\\\\\\"xxxxxxxx\\\\\\\", \\\\\\\"APIUrl\\\\\\\": \\\\\\\"https://api.xxx.com/v1/chat/completions\\\\\\\", \\\\\\\"Streaming\\\\\\\": true}"
        },
        {
          "name": "TTSConfig",
          "type": "string",
          "required": false,
          "description": "不填写则不进行更新，TTS配置，详情见StartAIConversation接口",
          "example": "{\\\\\\\"TTSType\\\\\\\": \\\\\\\"tencent\\\\\\\", \\\\\\\"AppId\\\\\\\": 136666666, \\\\\\\"SecretId\\\\\\\": \\\\\\\"xxxxxxx\\\\\\\", \\\\\\\"SecretKey\\\\\\\": \\\\\\\"xxxxxxx\\\\\\\", \\\\\\\"VoiceType\\\\\\\": 1008, \\\\\\\"Speed\\\\\\\": 1}"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "UpdateScanRooms",
      "description": "更新自定义送检房间号。**接口使用前提**：目前 UpdateScanRooms 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438\u0026level2_id=445\u0026source=0\u0026data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME\u0026step=1)。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID",
          "example": "1"
        },
        {
          "name": "RoomIdString",
          "type": "string",
          "required": false,
          "description": "需要送检的所有房间号。多个房间号之间用\",\"分隔，长度不超过1024字符。示例：\"0001,0002,0003\"",
          "example": "\"1\""
        },
        {
          "name": "RoomIdRegex",
          "type": "array",
          "required": false,
          "description": "符合此正则表达式规则的房间号将被送检，最大不能超过10个。示例：^6.*（表示所有以6开头的房间号将被送检）",
          "example": "[\"1\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "BizId"
      ]
    },
    {
      "name": "UpdateScanUsers",
      "description": "更新自定义送检用户号。 **接口使用前提**：目前 UpdateScanUsers 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438\u0026level2_id=445\u0026source=0\u0026data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME\u0026step=1)。",
      "status": "online",
      "parameters": [
        {
          "name": "BizId",
          "type": "integer",
          "required": true,
          "description": "应用ID",
          "example": "1"
        },
        {
          "name": "UserIdString",
          "type": "string",
          "required": false,
          "description": "需要送检的所有用户号。多个用户号之间用\",\"分隔，长度不超过1024字符。示例：\"0001,0002,0003\"",
          "example": "\"1\""
        },
        {
          "name": "UserIdRegex",
          "type": "array",
          "required": false,
          "description": "符合此正则表达式规则的用户号将被送检，最大不能超过10个。示例：[\"^6.*\"] 表示所有以6开头的用户号将被送检",
          "example": "[\"1\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "BizId"
      ]
    },
    {
      "name": "UpdateVoicePrint",
      "description": "传入声纹ID以及对应音频信息，更新对应声纹信息",
      "status": "online",
      "parameters": [
        {
          "name": "VoicePrintId",
          "type": "string",
          "required": true,
          "description": "声纹信息ID",
          "example": "20250529_xxxxxx"
        },
        {
          "name": "ReqTimestamp",
          "type": "integer",
          "required": true,
          "description": "毫秒时间戳",
          "example": "1748249540000"
        },
        {
          "name": "AudioFormat",
          "type": "integer",
          "required": false,
          "description": "音频格式,目前只支持0,代表wav",
          "example": "0"
        },
        {
          "name": "Audio",
          "type": "string",
          "required": false,
          "description": "整个wav音频文件的base64字符串,其中wav文件限定为16k采样率, 16bit位深, 单声道, 8到18秒音频时长,有效音频不小于6秒(不能有太多静音段),编码数据大小不超过2M",
          "example": "f8AAAMABwAJAAsxxxx"
        },
        {
          "name": "AudioMetaInfo",
          "type": "string",
          "required": false,
          "description": "和声纹绑定的MetaInfo，长度最大不超过512",
          "example": "metainfo string"
        }
      ],
      "required": [
        "VoicePrintId",
        "ReqTimestamp"
      ]
    }
  ]
}