Invoke the GetAudioFileUploadParameters API to obtain audio file upload parameters. Before creating an audio file, you must first call this API to retrieve the upload parameters and then call CreateAudioFile to create the audio file. This API is typically invoked by the default public cloud CRM system provided by Cloud Contact Center. It is not recommended for integration customers to call this API directly, because file upload must be performed through a Page operation first; only after the upload is complete can the GetAudioFileUploadParameters API be called.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
Instance ID. |
ccc-test |
| AudioFileName |
string |
Yes |
Audio file name. |
test-file.wav |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
HTTP status code. |
200 |
| Code |
string |
Response code. |
OK |
| Message |
string |
Response message. |
无 |
| RequestId |
string |
Request ID. |
C81FD1A5-4B99-470A-A527-D80150228784 |
| Data |
object |
Data. |
|
| FilePath |
string |
Key of the OSS file. |
ccc-test/test-file.wav |
| Signature |
string |
Signature information of the temporary credential for file upload, used to authenticate the upload request. |
HIyClras8IcVlbTV7RIJWJbU**** |
| Host |
string |
Endpoint domain name of OSS. |
https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com |
| Policy |
string |
Signature policy. |
eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d**** |
| ExpireTime |
integer |
Expiration time. |
1647313420 |
| AccessKeyId |
string |
AccessKey ID used for signing. |
**** |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "无",
"RequestId": "C81FD1A5-4B99-470A-A527-D80150228784",
"Data": {
"FilePath": "ccc-test/test-file.wav",
"Signature": "HIyClras8IcVlbTV7RIJWJbU****",
"Host": "https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com",
"Policy": "eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****",
"ExpireTime": 1647313420,
"AccessKeyId": "****"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Parameter.Blank | The parameter %s may not be null or blank. | |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.