Obtaining a Recording Download and Playback URL

Updated on 2023-09-27 GMT+08:00

View PDF

Description

This interface is invoked to upload a recording file on the CC-FS to OBS/LSS and obtain the recording download and playback URL from OBS/LSS.

Prerequisites: Recording files have been synchronized to the CC-FS database by a scheduled task.
Usage restrictions
Developers can download only recordings under their own accounts. The developer account (ak) must correspond to the recording (callId).

The developer account (ak) is contained in the authentication string. For details, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

callId, beginTime, and endTime uniquely identify a recording.

Interface Method

POST

URI

https://ip:port/CCFS/resource/ccfs/getRecordFileUrlFromObs

Set ip to the IP address of the server where the CC-FS is installed and port to the HTTPS port number of the CC-FS.

If the request is routed through the NSLB, set ip to the IP address of the NSLB server and port to the HTTPS port number of the CC-FS service mapped on the NSLB.

Request

**Table 1** Parameters in the request header
Parameter	Mandatory	Value Type	Default Value	Description
Content-Type	Yes	String	None	The value is fixed to application/json; charset=UTF-8.
Authorization	Yes	String	None	For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

**Table 2** Parameters in the request body
Parameter	Mandatory	Value Type	Default Value	Description
callId	Yes	String (1–25)	None	Call ID.
beginTime	Yes	String	None	Recording start time. The time is in yyyy-MM-dd HH:mm:ss format.
endTime	Yes	String	None	Recording end time. The time is in yyyy-MM-dd HH:mm:ss format. The interval between the recording start time and end time cannot exceed three days.
version	No	String	None	Current interface version, which is 2.0. NOTICE: Time zones other than GMT+8: beginTime and endTime must be set to time in the time zone where the tenant space is located, and version is mandatory. GMT+8 When beginTime and endTime are set to time in the GMT+0 time zone, version is optional. For example, if the recording start time is 2022-01-02 10:00:00 in the GMT+8 time zone, you can set beginTime to 2022-01-02 02:00:00. When beginTime and endTime are set to time in the time zone where the tenant space is located, version is mandatory.

Response

**Table 3** Parameters in the response
Parameter	Value Type	Description
resultCode	String	Result code returned. 0: success Other values: failure
resultDesc	String	Request result description. For details, see Error Code Reference.
resultData	Object	Response data.
url	String	Recording download and playback URL returned from the OBS/LSS after this interface is successfully invoked. The URL expires after 8 hours by default. If a call ID corresponds to multiple recording files, the download and playback URLs of multiple recording files are returned. The URLs are sorted by start time and end time.

Error Codes

For details, see Error Code Reference.

Example

Request header

POST /CCFS/resource/ccfs/getRecordFileUrlFromObs HTTP/1.1
Authorization: ************
Accept: */*
Host: 10.154.198.164
Content-Type: application/json;charset=UTF-8
Content-Length: 185

Request parameters

{
    "callId": "1637742300-27",
    "beginTime": "2021-11-24 06:25:03",
    "endTime": "2021-11-25 06:25:11",
    "version": "2.0"
}

Response header

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Mon, 02 Jul 2018 02:43:03 GMT

Response parameters

{
    "resultData": {
        "url": "https://south-aicc-develop.obs.cn-south-1.myhuaweicloud.com:443/ccfs/record/developId/13ddcde6-2072-40d2-b96f-58cac16e18f5?AccessKeyId=************&Expires=1637936620&Signature=************"
    },
    "resultCode": "0",
    "resultDesc": "success"
}