查詢預約/提醒開關設定

更新時間：2026-06-26 10:44:06

介面描述

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

2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	Integer	頻道ID

範例

http://api.polyv.net/live/v4/channel/booking/setting/get?channelId=${channelId}&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	預約/提醒開關設定【詳見data參數描述】

data參數描述

參數名	類型	說明
channelId	Integer	頻道ID
smsRemindEnabled	String	簡訊提醒開關 Y：開啟 N：關閉
smsRemindSendTimePoint	String	簡訊提醒發送時間點 living：直播時提醒 5m：開播前5分鐘 15m：開播前15分鐘 30m：開播前30分鐘 60m：開播前60分鐘 1d：開播前1天
bookingEnabled	String	微信提醒（微信預約）開關 Y：開啟 N：關閉
bookingTips	String	預約提示文案
displayBookingNumberEnabled	String	顯示預約人數開關 Y：顯示 N：隱藏
customBookingEnabled	String	自訂提醒開關，預設N Y：開啟 N：關閉
customBookingCallbackUrl	String	自訂提醒回調地址
otherChannelIds	Array	預約的其他頻道ID列表

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