查询预约/提醒开关设置

接口描述

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

2、接口支持https协议

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

示例

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

响应参数描述

data参数描述

Error参数描述

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 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
}

响应示例

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

成功示例

{
    "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
}

异常示例

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