Documentation
Super Board (Full version)
Server API V2
Delete a file

Delete a file

Last updated：2022-12-21 17:44

Description

Deletes a transcoded file or both the source and transcoded files from ZEGO cloud storage.

Request method and endpoint

Request method: POST
Request endpoint: https://docs-api.zego.im/?Action=DeleteFile
Protocol: HTTPS
Rate limit: 10 times/second

Request parameters

Listed below are the parameters specific to this request. For the complete list of public request parameters, see Accessing Server APIs - Public parameters.

Parameter	Type	Required	Description
FileId	String	Yes	File ID returned after successful transcoding.
DeleteType	Int64	Yes	Type of the file to be deleted. The options are as follows: 1: transcoded files 2: source and transcoded files Only source files that are stored on the ZEGO file storage server can be deleted. Source files for those uploaded and transcoded by the Super Board or file sharing SDK are stored on the ZEGO file storage server.

Sampple request

Request URL

https://docs-api.zego.im/?Action=DeleteFile
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false

Request message body

{
  "FileId": "8cb1bccbdf2e655a3b45f4b126ef8392",
  "DeleteType": 1
}

Response parameters

Parameter	Type	Description
Code	Int64	Error code.
Message	String	Error description.
RequestId	String	Request ID.

Sample response

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}

Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return code	Description
60100	The type parameter of the files to be deleted is incorrect.
60101	The transcoded file with the specified file ID cannot be found.