import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; import { ModifyAppStatusRequest, ModifyRecordInfoRequest, ModifyCustomizationStateRequest, StartAIConversationResponse, CreateScanUserRequest, StartAIConversationRequest, DescribeScanResultListRequest, StartRecordRequest, GetCustomizationListResponse, DeleteScanUserRequest, ModifyUserMicStatusRequest, UpdateScanUsersResponse, ControlAIConversationResponse, DescribeAgeDetectTaskRequest, DeleteCustomizationResponse, DescribeApplicationListRequest, GetCustomizationListRequest, RegisterVoicePrintResponse, DescribeRecordInfoResponse, CreateAppResponse, StopRecordResponse, DeleteVoicePrintRequest, DescribeUserInAndOutTimeRequest, StartRecordResponse, DescribeScanResultListResponse, DescribeApplicationListResponse, DescribeRecordInfoRequest, DescribeRoomInfoRequest, DescribeAuditResultExternalRequest, ModifyCustomizationResponse, DeleteCustomizationRequest, CreateAgeDetectTaskRequest, DescribeAppStatisticsResponse, DescribeVoicePrintResponse, DeleteScanUserResponse, DescribeRoomInfoResponse, DescribeAIConversationResponse, DescribeVoicePrintRequest, DescribeTaskInfoRequest, DescribeAuditResultExternalResponse, ScanVoiceRequest, RegisterVoicePrintRequest, UpdateVoicePrintRequest, DescribeApplicationDataRequest, CreateScanUserResponse, DeleteVoicePrintResponse, ModifyUserMicStatusResponse, DescribeTaskInfoResponse, DeleteRoomMemberResponse, ModifyCustomizationRequest, StopAIConversationResponse, DescribeAIConversationRequest, DescribeUserInAndOutTimeResponse, DescribeAppStatisticsRequest, StopRecordRequest, CreateAppRequest, ControlAIConversationRequest, ScanVoiceResponse, CreateAgeDetectTaskResponse, DescribeRealtimeScanConfigResponse, DeleteRoomMemberRequest, CreateCustomizationRequest, UpdateScanRoomsRequest, DescribeRealtimeScanConfigRequest, DescribeAgeDetectTaskResponse, StopAIConversationRequest, UpdateAIConversationRequest, UpdateScanRoomsResponse, DescribeApplicationDataResponse, UpdateAIConversationResponse, UpdateVoicePrintResponse, UpdateScanUsersRequest, ModifyAppStatusResponse, CreateCustomizationResponse, ModifyCustomizationStateResponse, ModifyRecordInfoResponse } from "./gme_models"; /** * gme client * @class */ export declare class Client extends AbstractClient { constructor(clientConfig: ClientConfig); /** * 获取房间内用户信息 */ DescribeRoomInfo(req: DescribeRoomInfoRequest, cb?: (error: string, rep: DescribeRoomInfoResponse) => void): Promise; /** * 停止录制 */ StopRecord(req: StopRecordRequest, cb?: (error: string, rep: StopRecordResponse) => void): Promise; /** * 获审核结果明细(外部API) */ DescribeAuditResultExternal(req: DescribeAuditResultExternalRequest, cb?: (error: string, rep: DescribeAuditResultExternalResponse) => void): Promise; /** * 更新AIConversation参数 */ UpdateAIConversation(req: UpdateAIConversationRequest, cb?: (error: string, rep: UpdateAIConversationResponse) => void): Promise; /** * 停止AI对话任务 */ StopAIConversation(req: StopAIConversationRequest, cb?: (error: string, rep: StopAIConversationResponse) => void): Promise; /** * 删除自定义送检用户。**接口使用前提**:目前 DeleteScanUser 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。 */ DeleteScanUser(req: DeleteScanUserRequest, cb?: (error: string, rep: DeleteScanUserResponse) => void): Promise; /** * 更新自定义送检用户号。 **接口使用前提**:目前 UpdateScanUsers 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。 */ UpdateScanUsers(req: UpdateScanUsersRequest, cb?: (error: string, rep: UpdateScanUsersResponse) => void): Promise; /** * 查询语音消息转文本热句模型列表 */ GetCustomizationList(req: GetCustomizationListRequest, cb?: (error: string, rep: GetCustomizationListResponse) => void): Promise; /** * 拉取用户在房间得进出时间 */ DescribeUserInAndOutTime(req: DescribeUserInAndOutTimeRequest, cb?: (error: string, rep: DescribeUserInAndOutTimeResponse) => void): Promise; /** * 传入声纹ID,删除之前注册的声纹信息 */ DeleteVoicePrint(req: DeleteVoicePrintRequest, cb?: (error: string, rep: DeleteVoicePrintResponse) => void): Promise; /** * 更新自定义送检房间号。**接口使用前提**:目前 UpdateScanRooms 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。 */ UpdateScanRooms(req: UpdateScanRoomsRequest, cb?: (error: string, rep: UpdateScanRoomsResponse) => void): Promise; /** * 启动AI对话任务,AI通道机器人进入GME房间,与房间内指定的成员进行AI对话,适用于智能客服,AI口语教师等场景 GME AI对话功能内置语音转文本能力,同时提供通道服务,即客户可灵活指定第三方AI模型(LLM)服务和文本转音频(TTS)服务,更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。 */ StartAIConversation(req: StartAIConversationRequest, cb?: (error: string, rep: StartAIConversationResponse) => void): Promise; /** * 用户使用该接口可以创建语音消息转文本热句模型,以供识别调用 */ CreateCustomization(req: CreateCustomizationRequest, cb?: (error: string, rep: CreateCustomizationResponse) => void): Promise; /** * 查询房间录制的详细信息 */ DescribeTaskInfo(req: DescribeTaskInfoRequest, cb?: (error: string, rep: DescribeTaskInfoResponse) => void): Promise; /** * 传入音频base64串,注册声纹信息,返回声纹ID */ RegisterVoicePrint(req: RegisterVoicePrintRequest, cb?: (error: string, rep: RegisterVoicePrintResponse) => void): Promise; /** * 目前该功能底层能力已不具备,不对外提供,目前需要下线,走预下线流程。 用于创建年龄语音识别任务的接口,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。

接口功能说明:

  • 支持对语音文件进行检测,判断是否为未成年人。
  • 支持批量提交检测子任务。检测子任务列表最多支持100个。

  • 音频文件限制说明:

  • 音频文件大小限制:10 M
  • 音频文件时长限制:3分钟
  • 音频文件格式支持的类型:.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg

  • */ CreateAgeDetectTask(req: CreateAgeDetectTaskRequest, cb?: (error: string, rep: CreateAgeDetectTaskResponse) => void): Promise; /** * 传入声纹ID以及对应音频信息,更新对应声纹信息 */ UpdateVoicePrint(req: UpdateVoicePrintRequest, cb?: (error: string, rep: UpdateVoicePrintResponse) => void): Promise; /** * 本接口(DeleteRoomMember)用户删除房间或者剔除房间内用户 */ DeleteRoomMember(req: DeleteRoomMemberRequest, cb?: (error: string, rep: DeleteRoomMemberResponse) => void): Promise; /** * 本接口(DescribeApplicationData)用于获取数据详情信息,最多可拉取最近90天的数据。 */ DescribeApplicationData(req: DescribeApplicationDataRequest, cb?: (error: string, rep: DescribeApplicationDataResponse) => void): Promise; /** * 查询AI对话任务状态。 */ DescribeAIConversation(req: DescribeAIConversationRequest, cb?: (error: string, rep: DescribeAIConversationResponse) => void): Promise; /** * 本接口(ScanVoice)用于提交语音检测任务,检测任务列表最多支持100个。使用前请您登录[控制台 - 服务配置](https://console.cloud.tencent.com/gamegme/conf)开启语音内容安全服务。

    接口功能说明:

  • 支持对语音流或语音文件进行检测,判断其中是否包含违规内容。
  • 支持设置回调地址 Callback 获取检测结果,同时支持通过接口(查询语音检测结果)主动轮询获取检测结果。
  • 支持场景输入,包括:谩骂、色情等场景
  • 支持批量提交检测任务。检测任务列表最多支持100个。

  • 音频文件限制说明:

  • 音频文件大小限制:100 M
  • 音频文件时长限制:30分钟
  • 音频文件格式支持的类型:.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg

  • 语音流限制说明:

  • 语音流格式支持的类型:.m3u8、.flv
  • 语音流支持的传输协议:RTMP、HTTP、HTTPS
  • 语音流时长限制:4小时
  • 支持音视频流分离并对音频流进行分析

  • Scenes 与 Label 参数说明:

    提交语音检测任务时,需要指定 Scenes 场景参数,目前要求您设置 Scenes 参数值为:["default"];而在检测结果中,则包含请求时指定的场景,以及对应类型的检测结果。

    场景 描述 Label
    语音检测 语音检测的检测类型

    normal:正常文本

    porn:色情

    abuse:谩骂

    ad :广告

    illegal :违法

    moan :呻吟

    customized:自定义词库


    回调相关说明:

  • 如果在请求参数中指定了回调地址参数 Callback,即一个 HTTP(S) 协议接口的 URL,则需要支持 POST 方法,传输数据编码采用 UTF-8。
  • 在推送回调数据后,接收到的 HTTP 状态码为 200 时,表示推送成功。
  • HTTP 请求参数(query)说明:
  • 名称 类型 是否必需 描述
    Signatue string 签名,具体见签名生成说明
    • 签名生成说明:
      • 使用 HMAC-SH1 算法, 最终结果做 BASE64 编码;
      • 签名原文串为 POST+body 的整个json内容(长度以 Content-Length 为准);
      • 签名key为应用的 SecretKey,可以通过控制台查看。
  • 回调示例如下(详细字段说明见结构: DescribeScanResult
  • {
        "Code": 0,
        "DataId": "1400000000_test_data_id",
        "ScanFinishTime": 1566720906,
        "HitFlag": true,
        "Live": false,
        "Msg": "",
        "ScanPiece": [{
            "DumpUrl": "",
            "HitFlag": true,
            "MainType": "abuse",
            "RoomId": "123",
            "OpenId": "111",
            "Info":"",
            "Offset": 0,
            "Duration": 3400,
            "PieceStartTime":1574684231,
            "ScanDetail": [{
                "EndTime": 1110,
                "KeyWord": "违规字",
                "Label": "abuse",
                "Rate": "90.00",
                "StartTime": 1110
            }, {
                "EndTime": 1380,
                "KeyWord": "违规字",
                "Label": "abuse",
                "Rate": "90.00",
                "StartTime": 930
            }, {
                "EndTime": 1560,
                "KeyWord": "违规字",
                "Label": "abuse",
                "Rate": "90.00",
                "StartTime": 930
            }, {
                "EndTime": 2820,
                "KeyWord": "违规字",
                "Label": "abuse",
                "Rate": "90.00",
                "StartTime": 2490
            }]
        }],
        "ScanStartTime": 1566720905,
        "Scenes": [
            "default"
        ],
        "Status": "Success",
        "TaskId": "6330xxxx-9xx7-11ed-98e3-52xxxxe4ac3b",
        "Url": "https://xxx/xxx.m4a"
    }
    
    */ ScanVoice(req: ScanVoiceRequest, cb?: (error: string, rep: ScanVoiceResponse) => void): Promise; /** * 新增自定义送检用户。**接口使用前提**:目前 CreateScanUser 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。 */ CreateScanUser(req: CreateScanUserRequest, cb?: (error: string, rep: CreateScanUserResponse) => void): Promise; /** * 本接口(DescribeAppStatistics)用于获取某个GME应用的用量数据。包括实时语音,语音消息及转文本,语音分析等。最长查询周期为最近60天。 */ DescribeAppStatistics(req: DescribeAppStatisticsRequest, cb?: (error: string, rep: DescribeAppStatisticsResponse) => void): Promise; /** * 用户通过该接口可以更新语音消息转文本热句模型。 */ ModifyCustomization(req: ModifyCustomizationRequest, cb?: (error: string, rep: ModifyCustomizationResponse) => void): Promise; /** * 获取用户自定义送检信息。**接口使用前提**:目前 DescribeRealtimeScanConfig 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。 */ DescribeRealtimeScanConfig(req: DescribeRealtimeScanConfigRequest, cb?: (error: string, rep: DescribeRealtimeScanConfigResponse) => void): Promise; /** * 修改录制配置信息 */ ModifyRecordInfo(req: ModifyRecordInfoRequest, cb?: (error: string, rep: ModifyRecordInfoResponse) => void): Promise; /** * 查询先前注册的声纹信息 */ DescribeVoicePrint(req: DescribeVoicePrintRequest, cb?: (error: string, rep: DescribeVoicePrintResponse) => void): Promise; /** * 本接口(CreateApp)用于创建一个GME应用。 */ CreateApp(req: CreateAppRequest, cb?: (error: string, rep: CreateAppResponse) => void): Promise; /** * 本接口(DescribeScanResultList)用于查询语音检测结果,查询任务列表最多支持100个。

    如果在提交语音检测任务时未设置 Callback 字段,则需要通过本接口获取检测结果

    */ DescribeScanResultList(req: DescribeScanResultListRequest, cb?: (error: string, rep: DescribeScanResultListResponse) => void): Promise; /** * 本接口(DescribeApplicationList)用于查询自己账号下的应用列表 */ DescribeApplicationList(req: DescribeApplicationListRequest, cb?: (error: string, rep: DescribeApplicationListResponse) => void): Promise; /** * 通过该接口,用户可以修改语音消息转文本热句模型状态,上下线热句模型 */ ModifyCustomizationState(req: ModifyCustomizationStateRequest, cb?: (error: string, rep: ModifyCustomizationStateResponse) => void): Promise; /** * 查询录制任务信息。 */ DescribeRecordInfo(req: DescribeRecordInfoRequest, cb?: (error: string, rep: DescribeRecordInfoResponse) => void): Promise; /** * **接口作用**:此接口用于修改房间用户的麦克风状态,例如房间内用户麦克风为打开状态,可调用此接口将该用户麦克风进行关闭,关闭后即使该用户使用客户端接口 EnableMic 打开麦克风,依然无法与房间内成员通话,属于被禁言状态。该状态持续到此用户退房后失效,或者调用该接口重新打开此用户麦克风状态。 **接口应用场景**:此接口多用于游戏业务中台或者风控后台,对一些发表不当言论的玩家进行禁言处理。 **接口使用前提**:目前 ModifyUserMicStatus 接口通过白名单开放,如需使用,需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。 */ ModifyUserMicStatus(req: ModifyUserMicStatusRequest, cb?: (error: string, rep: ModifyUserMicStatusResponse) => void): Promise; /** * 用户通过该接口可以删除语音消息转文本热句模型 */ DeleteCustomization(req: DeleteCustomizationRequest, cb?: (error: string, rep: DeleteCustomizationResponse) => void): Promise; /** * 提供服务端控制机器人的功能 */ ControlAIConversation(req: ControlAIConversationRequest, cb?: (error: string, rep: ControlAIConversationResponse) => void): Promise; /** * 开启录制 */ StartRecord(req: StartRecordRequest, cb?: (error: string, rep: StartRecordResponse) => void): Promise; /** * 本接口(ModifyAppStatus)用于修改应用总开关状态。 */ ModifyAppStatus(req: ModifyAppStatusRequest, cb?: (error: string, rep: ModifyAppStatusResponse) => void): Promise; /** * 目前该功能底层能力已不具备,不对外提供,目前需要下线,走预下线流程。 查询年龄语音识别任务结果,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。 */ DescribeAgeDetectTask(req: DescribeAgeDetectTaskRequest, cb?: (error: string, rep: DescribeAgeDetectTaskResponse) => void): Promise; }