Query Channel Callback Settings

Updated: 2026-04-24 09:26:22

API Description

1、查询频道回调设置接口
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/callback/get-setting

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

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 within 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 not 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	String	Channel ID

Example

http://api.polyv.net/live/v3/channel/callback/get-setting?appId=frlr1zazn3&sign=7CC8C8BEBB917B1640FE7CA9B1DB4DD6&channelId=2191569&timestamp=1621840149303

Response Parameters Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure [See Global Error Description]
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Callback settings returned on success [See Data Field Description]

Data Parameter Description

Parameter	Type	Description
recordCallbackUrl	String	Recording generation callback URL
playbackCallbackUrl	String	Recording video transfer success callback URL
streamCallbackUrl	String	Stream status callback URL
liveScanCallbackUrl	String	Live content moderation callback URL
recordCallbackVideoType	String	Video types for recording callback, multiple types separated by ","
pptRecordCallbackUrl	String	Courseware remake success callback URL
playbackSettingCallbackUrl	String	Playback offline cache callback URL
playbackCacheCallbackUrl	String	Playback cache generation success callback URL
subtitleCallbackUrl	String	(Planned, expected support in 2025 Q2) Subtitle generation success callback URL
globalSettingEnabled	String	Whether to apply global settings Y: Use user callback settings N: Use channel settings
liveViolationCutoffCallbackUrl	String	Live stream violation cutoff callback URL
customBookingCallbackUrl	String	Live stream viewer booking callback URL

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. Add it to your own project after downloading. 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 packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询回调设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetCallbackSetting() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url="https://api.polyv.net/live/v3/channel/callback/get-setting";
    String channelId="2191569";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    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",
    "message":"",
    "data":{
        "recordCallbackUrl":"http://www.abc.com/callback",
        "playbackCallbackUrl":"http://www.abc.com/callback",
        "streamCallbackUrl":"http://www.abc.com/callback",
        "liveScanCallbackUrl":null,
        "recordCallbackVideoType":"m3u8",
        "playbackCacheCallbackUrl":null,
        "pptRecordCallbackUrl":null,
        "playbackSettingCallbackUrl":null,
        "globalSettingEnabled":"Y",
        "liveViolationCutoffCallbackUrl": "http://www.abc.com/callback",
        "customBookingCallbackUrl": "http://www.booking.com/callback"
    }
}

Error Example

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

Live Streaming Server API