Set Booking/Reminder Switch

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

API Description

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

2、局部更新：仅传入的字段会被修改，其余字段保持原值

3、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
This API performs partial updates. Only the fields passed in will be modified; fields not passed in retain their original values.

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 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
bookingEnabled	true	String	WeChat reminder (WeChat booking) switch Y: Enable N: Disable
smsRemindEnabled	false	String	SMS reminder switch Y: Enable N: Disable
smsRemindSendTimePoint	false	String	SMS reminder send time point, default is living living: Remind during live stream 5m: 5 minutes before stream starts 15m: 15 minutes before stream starts 30m: 30 minutes before stream starts 60m: 60 minutes before stream starts 1d: 1 day before stream starts
bookingTips	false	String	Booking prompt text, max 60 characters
displayBookingNumberEnabled	false	String	Display booking count switch Y: Show N: Hide
customBookingEnabled	false	String	Custom reminder switch Y: Enable N: Disable
customBookingCallbackUrl	false	String	Custom reminder callback URL, max 250 characters

Example

http://api.polyv.net/live/v4/channel/booking/setting/update?channelId=${channelId}&bookingEnabled=Y&smsRemindEnabled=Y&smsRemindSendTimePoint=living&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 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, should not be tied to business logic
error	Object	Error information when status code is not 200 [See Error Parameter Description]
data	Object	No return data, fixed as null

Error Parameter Description

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

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download 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 updateBookingSettingTest() 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/update";
    String channelId = "2191532";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("bookingEnabled", "Y");
    requestMap.put("smsRemindEnabled", "Y");
    requestMap.put("smsRemindSendTimePoint", "living");
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);

    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": null,
    "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