tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeScanResultList

最后更新时间：2022-12-05 10:18:20
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query the result of voice moderation tasks. Up to 100 tasks can be queried in one time.

If the `Callback` field is not set when a voice moderation task is submitted, this API is called to query the moderation result.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeScanResultList.
Version Yes String Common Params. The value used for this API: 2018-07-11.
Region No String Common Params. This parameter is not required for this API.
BizId Yes Integer Application ID, which is obtained when you create an application in the GME console.
TaskIdList.N Yes Array of String List of IDs of the tasks to be queried. Up to 100 entries can be added in the ID list.
Limit No Integer Number of task results to be returned. Default value: 10. Maximum value: 500. This parameter will be ignored for large file tasks where all results will be returned.

3. Output Parameters

Parameter Name Type Description
Data Array of DescribeScanResult Result of the voice detection task to be queried
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying voice detection result

Input Example

https://gme.tencentcloudapi.com/?Action=DescribeScanResultList
&BizId=1400000000
&TaskIdList.0=xxx
&Limit=20
&<Common request parameters>

Output Example

{
    "Data": [
        {
            "Code": 0,
            "DataId": "1400000000_test_data_id",
            "ScanFinishTime": 1566720906,
            "HitFlag": true,
            "Live": false,
            "Msg": "",
            "ScanPiece": [
                {
                    "DumpUrl": "",
                    "HitFlag": true,
                    "MainType": "abuse",
                    "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"
        }
    ],
    "RequestId": "xxx"
}

5. Developer Resources

SDK

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

Command Line Interface

6. Error Code

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

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.TagKey Incorrect tag.
MissingParameter Parameter missing.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Operation unsupported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款