tencent cloud

Feedback

UploadIvrAudio

Last updated: 2024-09-09 17:58:20

1. API Description

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

Upload audio files used in IVR, with a daily upload limit of 50 files. (It is recommended to use temporary links stored in Tencent Cloud Cos for the audio file URL in the parameters)

A maximum of 1 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: UploadIvrAudio.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required for this API.
SdkAppId Yes Integer Application ID (required) can be found at https://console.tencentcloud.com/ccc.
AudioList.N Yes Array of UploadAudioInfo Audio File List

3. Output Parameters

Parameter Name Type Description
FailedFileList Array of UploadIvrAudioFailedInfo List of failed uploads
Note: This field may return null, indicating that no valid values can be obtained.
SuccessFileList Array of AudioFileInfo List of successful uploads
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Upload IVR Audio Files

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadIvrAudio
<Common request parameters>

{
    "SdkAppId": 0,
    "AudioList": [
        {
            "CustomFileName": "abc",
            "AudioUrl": "http://xxxx.com/a.mp3"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "a",
        "FailedFileList": [],
        "SuccessFileList": [
            {
                "AudioFileName": "business_id_pic5.mp3",
                "CustomFileName": "1231",
                "FileId": 50,
                "Status": 0
            },
            {
                "AudioFileName": "business_id_pic6.mp3",
                "CustomFileName": "4561",
                "FileId": 51,
                "Status": 0
            }
        ]
    }
}

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.UploadFileOverflow Number of Uploaded Files exceeds the limit
InternalError.DBError Internal database access failure.
InvalidParameterValue parameter value is invalid.