1. API Description

Domain name for API request: gme.tencentcloudapi.com.

This API is used to submit a speech detection task. Up to 100 tasks can be added in the detection task list. Before using this API, please enable the speech analysis service in Console > Service Configuration.

Feature trial description:

API feature description:

Audio file limit description:

Audio stream limit description:

`Scenes` and `Label` parameter description:

When submitting a speech detection task, you need to specify the `Scenes` parameter. You are currently required to set the `Scenes` parameter to `["default"]`. The detection result will contain the scenario specified at the time of request and detection result in the corresponding type.

Callback description:

• Signature generation description:
• The HMAC-SH1 algorithm should be used, and the result should be encoded with Base64;
• The original signature string is the entire JSON content of POST and body (the length is subject to `Content-Length`);
• The signature key is the `SecretKey` of the application, which can be viewed in the console.

{
    "Code": 0,
    "DataId": "1400000000_test_data_id",
    "ScanFinishTime": 1566720906,
    "HitFlag": true,
    "Live": false,
    "Msg": "",
    "ScanPiece": [{
        "DumpUrl": "",
        "HitFlag": true,
        "MainType": "abuse",
        "RoomId": "123",
        "OpenId": "xxx",
        "Info":"",
        "Offset": 0,
        "Duration": 3400,
        "PieceStartTime":1574684231,
        "ScanDetail": [{
            "EndTime": 1110,
            "KeyWord": "xxx",
            "Label": "abuse",
            "Rate": "90.00",
            "StartTime": 1110
        }, {
            "EndTime": 1380,
            "KeyWord": "xxx",
            "Label": "abuse",
            "Rate": "90.00",
            "StartTime": 930
        }, {
            "EndTime": 1560,
            "KeyWord": "xxx",
            "Label": "abuse",
            "Rate": "90.00",
            "StartTime": 930
        }, {
            "EndTime": 2820,
            "KeyWord": "xxx",
            "Label": "abuse",
            "Rate": "90.00",
            "StartTime": 2490
        }]
    }],
    "ScanStartTime": 1566720905,
    "Scenes": [
        "default"
    ],
    "Status": "Success",
    "TaskId": "xxx",
    "Url": "https://xxx/xxx.m4a"
}

A maximum of 1000 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Submitting audio stream detection task

This example shows you how to submit a speech detection task for an audio stream where the callback address is empty and the DescribeScanResultList API needs to be called to poll the detection result.

Input Example

https://gme.tencentcloudapi.com/?Action=ScanVoice
&BizId=1400000000
&Scenes.0=default
&Live=true
&Callback=
&Tasks.0.DataId=1400000000_test_data_id
&Tasks.0.Url=https://xxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "Data": [
      {
        "DataId": "1400000000_test_data_id",
        "TaskId": "xxx-xxx-xxx"
      }
    ],
    "RequestId": "xxx-xxx-xxx"
  }
}

Example2 Submitting audio file detection task

This example shows you how to submit a speech detection task for an audio file where the callback address (Callback) is set to get the detection result.

Input Example

https://gme.tencentcloudapi.com/?Action=ScanVoice
&BizId=1400000000
&Scenes.0=default
&Live=false
&Callback=https://0.0.0.0/user_callback
&Tasks.0.DataId=1400000000_test_data_id
&Tasks.0.Url=http://xxxx/audio_store/xxxx.mp3
&<Common request parameters>

Output Example

{
  "Response": {
    "Data": [
      {
        "DataId": "1400000000_test_data_id",
        "TaskId": "xxx-xxx-xxx"
      }
    ],
    "RequestId": "xxx-xxx-xxx"
  }
}

Example3 Submitting audio file detection task

This example shows you how to submit a speech detection task for an audio file where the callback address is empty and the DescribeScanResultList API needs to be called to poll the detection result.

Input Example

https://gme.tencentcloudapi.com/?Action=ScanVoice
&BizId=1400000000
&Scenes.0=default
&Live=false
&Callback=
&Tasks.0.DataId=1400000000_test_data_id
&Tasks.0.Url=http://xxx/audio_store/xxxx.mp3
&<Common request parameters>

Output Example

{
  "Response": {
    "Data": [
      {
        "DataId": "1400000000_test_data_id",
        "TaskId": "xxx-xxx-xxx"
      }
    ],
    "RequestId": "xxx-xxx-xxx"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

• API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.