Query Global Callback Settings

Updated: 2025-09-04 09:52:52

API Description

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

API URL

http://api.polyv.net/live/v4/user/global-setting/callback/get

Online API Call

Request Method

GET

API Constraints

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

Request Parameter 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. 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]

Example

http://api.polyv.net/live/v4/user/global-setting/callback/get?appId=frlr1zazn3&sign=4A5B12ECA5142FB85E12A8DE9BF7DE71&timestamp=1657851977367

Response Parameter 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 response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 [See Error Field Description]
data	Object	[See data Field Description]

Error Parameter Description

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

data Parameter Description

Parameter	Type	Description
recordCallbackUrl	String	Recording generation callback URL
recordFileCallBackType	String	Callback recording file type all: All playback videos last: Final playback video
recordCallbackVideoType	String	Callback file type m3u8: m3u8 file mp4: mp4 file m3u8,mp4: m3u8 and mp4 files
playbackCallbackUrl	String	Transfer success callback URL
rebirthVodCallbackEnabled	String	Remake courseware transfer to VOD callback switch Y: Enabled N: Disabled
pptRecordCallbackUrl	String	Courseware remake success callback URL
streamCallbackUrl	String	Live stream status change callback URL
channelBasicUpdateCallbackUrl	String	Channel live room information modification callback URL
liveScanCallbackUrl	String	Live content review failure callback URL
chatUserStatusCallbackUrl	String	Live room user status callback URL
interactionCallbackUrl	String	Interactive feature callback URL
playbackCacheCallbackUrl	String	Live playback cache generation callback notification URL
playbackSettingCallbackUrl	String	Playback settings callback URL
aiPptVideoCallbackUrl	String	Video creation information callback
liveViolationCutoffCallbackUrl	String	Live violation disconnection callback

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 code project. The 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 static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
 * 查询全局回调设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getCallbackTest() 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/user/global-setting/callback/get";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    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",
    "requestId": "8acd0194a7b6459a8ab168fcf2b63153.64.16578519813679255",
    "data": {
        "recordCallbackUrl": "http://www.abc.com/callback",
        "recordFileCallBackType": "all",
        "recordCallbackVideoType": "m3u8,mp4",
        "playbackCallbackUrl": "http://www.abc.com/callback",
        "rebirthVodCallbackEnabled": "Y",
        "pptRecordCallbackUrl": "",
        "streamCallbackUrl": "http://www.abc.com/callback",
        "channelBasicUpdateCallbackUrl": "",
        "liveScanCallbackUrl": "",
        "chatUserStatusCallbackUrl": "",
        "interactionCallbackUrl": "",
        "playbackCacheEnabled": "N",
        "chatUserStatusCallbackEnabled": "Y",
        "playbackCacheCallbackUrl": "",
        "playbackSettingCallbackUrl": null,
        "aiPptVideoCallbackUrl":null,
        "liveViolationCutoffCallbackUrl": "http://www.abc.com/callback"
    },
    "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