设置预约/提醒开关

更新时间：2026-06-26 10:44:06

接口描述

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

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

3、接口支持https协议

接口URL

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

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、本接口为局部更新，仅传入的字段会被修改，未传入的字段保持原值。

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	Integer	频道ID
bookingEnabled	true	String	微信提醒（微信预约）开关 Y：开启 N：关闭
smsRemindEnabled	false	String	短信提醒开关 Y：开启 N：关闭
smsRemindSendTimePoint	false	String	短信提醒发送时间点，默认living living：直播时提醒 5m：开播前5分钟 15m：开播前15分钟 30m：开播前30分钟 60m：开播前60分钟 1d：开播前1天
bookingTips	false	String	预约提示文案，最长60个字符
displayBookingNumberEnabled	false	String	显示预约人数开关 Y：显示 N：隐藏
customBookingEnabled	false	String	自定义提醒开关 Y：开启 N：关闭
customBookingCallbackUrl	false	String	自定义提醒回调地址，最长250个字符

示例

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}

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error参数描述】
data	Object	无返回数据，固定为 null

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "4c9fe1757834435a84e7a4086fa60300.67.16560360397655577",
    "data": null,
    "success": true
}

异常示例

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

直播服务端 API