DownloadRecording

Updated at:

Downloads call recordings.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:DownloadRecording

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

da37319b-6c83-4268-9f19-814aed62e401

TaskId

string

Yes

The call ID.

744b27f3-437f-4a8c-a181-f668e492fd24

NeedVoiceSliceRecording

boolean

No

Specifies whether to query segmented recordings.

false

SwapChannels

boolean

No

Specifies whether to swap the left and right audio channels. Default value: false.

false

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

Code

string

The API status code.

OK

Message

string

The response message.

Success

RequestId

string

The request ID.

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Success

boolean

Indicates whether the request was successful.

true

DownloadParams

object

The download URL.

SignatureUrl

string

The URL used to download the recording file over HTTP.

http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D

FileName

string

The name of the recording file, which is typically a UUID.

281eb174-3865-41c1-9274-7b6813edadab.wav

VoiceSliceRecordingListJson

string

The list of segmented recordings, including the file names and file URLs.

[{"fileName":"10a17c447415424c99491884abe27d8a-1.wav","filePath":"https://ssml-test.oss-cn-shanghai.aliyuncs.com/7253/voiceSlice/10a17c447415424c99491884abe27d8a/10a17c447415424c99491884abe27d8a-1.wav?Expires=1686645470&OSSAccessKeyId=LTA*********kr8M9&Signature=V23OhiV5yIOoouriu6SiWkO9h8E%3D"}]

EarlyMediaSignatureUrl

string

The signed download URL for the early media recording file.

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "DownloadParams": {
    "SignatureUrl": "http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D",
    "FileName": "281eb174-3865-41c1-9274-7b6813edadab.wav",
    "VoiceSliceRecordingListJson": "[{\"fileName\":\"10a17c447415424c99491884abe27d8a-1.wav\",\"filePath\":\"https://ssml-test.oss-cn-shanghai.aliyuncs.com/7253/voiceSlice/10a17c447415424c99491884abe27d8a/10a17c447415424c99491884abe27d8a-1.wav?Expires=1686645470&OSSAccessKeyId=LTA*********kr8M9&Signature=V23OhiV5yIOoouriu6SiWkO9h8E%3D\"}]",
    "EarlyMediaSignatureUrl": ""
  }
}

Error codes

HTTP status code

Error code

Error message

Description

500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404 NotExist.Instance The specified Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.