Query Booking/Reminder Switch Settings

Updated: 2026-06-26 10:44:06

API Description

1、查询频道的预约/提醒开关设置，包括短信提醒、微信提醒（微信预约）、自定义提醒开关，以及显示预约人数开关等

2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/booking/setting/get

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 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 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 details: Signature Generation Rules
channelId	true	Integer	Channel ID

Example

http://api.polyv.net/live/v4/channel/booking/setting/get?channelId=${channelId}&appId=${your_appId}&timestamp=${timestamp}&sign=${your_sign}

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 business logic. 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 details: Error Parameter Description
data	Object	Booking/reminder switch settings See details: data Parameter Description

data Parameter Description

Parameter	Type	Description
channelId	Integer	Channel ID
smsRemindEnabled	String	SMS reminder switch Y: Enabled N: Disabled
smsRemindSendTimePoint	String	SMS reminder send time point living: Remind during live broadcast 5m: 5 minutes before broadcast 15m: 15 minutes before broadcast 30m: 30 minutes before broadcast 60m: 60 minutes before broadcast 1d: 1 day before broadcast
bookingEnabled	String	WeChat reminder (WeChat booking) switch Y: Enabled N: Disabled
bookingTips	String	Booking prompt text
displayBookingNumberEnabled	String	Display booking count switch Y: Show N: Hide
customBookingEnabled	String	Custom reminder switch, default is N Y: Enabled N: Disabled
customBookingCallbackUrl	String	Custom reminder callback URL
otherChannelIds	Array	List of other channel IDs for booking

Error Parameter 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 base 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, both contained in the download 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(getClass());
/**
 * 查询预约/提醒开关设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getBookingSettingTest() 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/booking/setting/get";
    String channelId = "2191532";

    //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",
    "requestId": "4c9fe1757834435a84e7a4086fa60300.67.16560360397655577",
    "data": {
        "channelId": 2191532,
        "smsRemindEnabled": "Y",
        "smsRemindSendTimePoint": "living",
        "bookingEnabled": "Y",
        "bookingTips": "立即预约，开播提醒不错过",
        "displayBookingNumberEnabled": "Y",
        "customBookingEnabled": "N",
        "customBookingCallbackUrl": "",
        "otherChannelIds": []
    },
    "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