Delete Document

Updated: 2022-09-02 18:08:07

Interface Description

1、删除频道文档接口
2、支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/document/delete

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules
channelId	true	String	Channel ID
fileId	true	String	File ID (multiple IDs can be concatenated with English commas). This value originates from the data.contents[0].fileId returned by the Query Channel Uploaded Document List interface
type	true	String	File type for old/new versions. Values: old: Old version new: New version This value originates from the data.contents[0].type returned by the Query Channel Uploaded Document List interface. If there are multiple fileIds, this value must correspond one-to-one with the fileIds.

Example

http://api.polyv.net/live/v3/channel/document/delete

Form Parameters:

appId=frlr1zazn3&sign=1B00420546771ECCF501FAF176A0B6AE&type=new&channelId=1965681&timestamp=1621843168035&fileId=39e6bd3fe674c952815ad1a09c66e1061965681common

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See details: Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	String	Empty on success, empty on failure

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChannelDocTest.class);
/**
 * 删除文档
 * @throws IOException
 */
@Test
public void testDeleteDocument() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/document/delete";
    String channelId = "1965681";
    String fileId = "39e6bd3fe674c952815ad1a09c66e1061965681common";
    String type  = "new";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("fileId",fileId);
    requestMap.put("type",type);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试删除文档：{}",response);
    //do somethings

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":""
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API