Help Center/ Customer Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Bidirectional Calls/ Obtaining the Recording File URL (getRecordingAddress)
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Obtaining the Recording File URL (getRecordingAddress)

Scenario

This interface is invoked to obtain the recording URL.

Method

POST

URI

https://{Domain name}/apiaccess/CC-Management/v1/mobileAgent/getRecordingAddress, where, {Domain name} can be service.besclouds.com.

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

No

User ID, which is the same as the value of app_key in the tokenByAkSk interface request.

2

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

callSerialNo

String

Yes

Call SN.

Length limit: string (50)

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

retCode

Number

Yes

Return code. The value 0 indicates success, and other values indicate failure.

1: Failed to upload data to OBS.

3: The VDN is unavailable.

5: No corresponding history record.

6: The VDN does not exist.

7: The SFTP information is empty.

8: The SFTP user password is empty.

9: SFTP connection failed.

10: Failed to obtain the temporary path.

11: Failed to download files from the UAP.

12: The length of the call SN cannot exceed 50 characters.

13: The size of the recording file exceeds the upper limit.

1.2

retMsg

String

Yes

Failure cause.

1.3

result

Object

No

Result content.

1.3.1

url

String

No

Recording URL. The validity period of the obtained recording URL is 5 minutes.

Length limit: string (200)
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

    >

Error Codes

None

Example

Request header:

x-app-key:6******************************b  
Authorization:Bearer e******************************6   
Content-Type:application/json

Request parameters:

{
	"callSerialNo": "679218118865715226"
}

Response header:

{
	"connection": "keep-alive",
	"content-type": "application/json;charset=UTF-8"
}

Response parameters:

{
	"retMsg": "success",
	"result": {
		"url": "https://aicc-obs0.obs.cn-south-1.myhuaweicloud.com:443/644429155876552705?AWSAccessKeyId=ZGUZVMUDBS2DKAQ5X141&Expires=1565681851&Signature=sb3ZDPyzg%2FXZLMIPK0zBTRA6x5s%3D"
	},
	"retCode": "0"
}