提交语音检测任务

1. 接口描述

接口请求域名： gme.tencentcloudapi.com 。

本接口(ScanVoice)用于提交语音检测任务，检测任务列表最多支持100个。使用前请您登录控制台 - 服务配置开启语音内容安全服务。

功能试用说明：

接口功能说明：

音频文件限制说明：

语音流限制说明：

Scenes 与 Label 参数说明：

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

回调相关说明：

• 签名生成说明：
• 使用 HMAC-SH1 算法, 最终结果做 BASE64 编码;
• 签名原文串为 POST+body 的整个json内容(长度以 Content-Length 为准);
• 签名key为应用的 SecretKey，可以通过控制台查看。

{
    "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"
}

默认接口请求频率限制：5000次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

4. 示例

示例1 提交语音流检测任务

通过语音流的方式提交检测任务，回调地址为空，需要通过接口(查询语音检测结果)主动轮询获取检测结果

输入示例

POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ScanVoice
<公共请求参数>

{
    "Callback": "https://0.0.0.0/user_callback",
    "Live": "true",
    "Tasks": [
        {
            "Url": "https://xxxx",
            "DataId": "1400000000_test_data_id"
        }
    ],
    "BizId": "1400000000",
    "Scenes": [
        "default"
    ]
}

输出示例

{
    "Response": {
        "Data": [
            {
                "DataId": "1400000000_test_data_id",
                "TaskId": "6330xxxx-9xx7-11ed-98e3-52xxxxe4ac3b"
            }
        ],
        "RequestId": "c91b5243-bbd1-48e0-af41-d66891cabecb"
    }
}

示例2 提交语音文件检测任务

通过语音文件的方式提交检测任务，可通过设置回调地址 Callback 获取检测结果

输入示例

POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ScanVoice
<公共请求参数>

{
    "Callback": "https://0.0.0.0/user_callback",
    "Live": "false",
    "Tasks": [
        {
            "Url": "http://xxxx/audio_store/xxxx.mp3",
            "DataId": "1400000000_test_data_id"
        }
    ],
    "BizId": "1400000000",
    "Scenes": [
        "default"
    ]
}

输出示例

{
    "Response": {
        "Data": [
            {
                "DataId": "1400000000_test_data_id",
                "TaskId": "6330xxxx-9xx7-11ed-98e3-52xxxxe4ac3b"
            }
        ],
        "RequestId": "de52afb5-3887-462d-876a-f8b0b654dc92"
    }
}

示例3 提交语音文件检测任务-2

通过语音文件的方式提交检测任务，回调地址为空，需要通过接口(查询语音检测结果)主动轮询获取检测结果

输入示例

POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ScanVoice
<公共请求参数>

{
    "Callback": "https://0.0.0.0/user_callback",
    "Live": "false",
    "Tasks": [
        {
            "Url": "http://xxx/audio_store/xxxx.mp3",
            "DataId": "1400000000_test_data_id"
        }
    ],
    "BizId": "1400000000",
    "Scenes": [
        "default"
    ]
}

输出示例

{
    "Response": {
        "Data": [
            {
                "DataId": "1400000000_test_data_id",
                "TaskId": "6330xxxx-9xx7-11ed-98e3-52xxxxe4ac3b"
            }
        ],
        "RequestId": "c91b5243-bbd1-48e0-af41-d66891cabecb"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。