Query Custom Interactive Script for Simulated Live Streaming

Updated: 2024-12-09 18:10:02

API Description

1、查询伪直播自定义互动脚本
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/interaction-script/query-disk-video-custom-script

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Incorrect parameters will result in a 400 error response.

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See 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 stored 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 Signature Generation Rules
channelId	true	Integer	Channel ID
diskVideoId	true	String	Simulated live streaming video

Example

http://api.polyv.net/live/v4/channel/interaction-script/query-disk-video-custom-script?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=4619012&diskVideoId=123

Response Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns success on success, error on failure
success	Boolean	Whether the request was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, not to be tied to business logic
data	Object	Returns null if no script is associated. Returns script information if associated See Data Field Description
error	Object	Error information when status code is not 200 See Error Field Description

Data Response Description

Parameter	Type	Description
id	Integer	Script ID
name	String	Script name
diskVideoId	String	Simulated live streaming video
duration	String	Script duration (HH:mm:ss)

Error Response Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included 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 pools.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 删除脚本
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void query() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
        
    String url = "http://api.polyv.net/live/v4/channel/interaction-script/query-disk-video-custom-script";
    //业务参数
    Integer channelId = 5004544;
    String diskVideoId = "diskVideoId";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("diskVideoId", diskVideoId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询脚本结果：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "5211d4a661514e0abd99f594188c894d.78.17334636313441389",
    "data": {
        "id": 6112,
        "name": null,
        "liveType": "diskVideo",
        "diskVideoId": "h1509fwdpw",
        "diskVideoName": "f0_s",
        "diskVideoSource": "VideoPool",
        "stauts": "Y",
        "duration": "00:00:46",
        "startTime": 1732951491000
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API