設定頻道虛擬預約人數

更新時間：2026-10-26 12:54:05

介面描述

1、单独设置频道虚拟预约人数，不影响聊天室显示虚拟人数
2、人数显示模式支持立即生效、分时生效
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/robot/virtual-booking-number/update

線上API呼叫

請求方式

POST

介面約束

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

2、請設定請求頭contentType:application/json

請求參數描述

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

請求體參數描述

參數名	必選	類型	說明
channelId	true	Integer	頻道號
virtualBookingNumber	true	Integer	虛擬預約人數
addRobotModel	true	String	人數顯示模式 timely：立即生效 fixed_time：分時生效
changeTime	false	Integer	生效時間，addRobotModel為fixed_time分時生效時必填，單位秒，最小值為20（20秒），最大值為18000（300分鐘）

範例

http://api.polyv.net/live/v4/channel/robot/virtual-booking-number/update?appId=xxx&sign=xxx&timestamp=xxx&channelId=3335806

{
    "channelId": 3335806,
    "virtualBookingNumber": 100,
    "addRobotModel": "timely"
}

回應參數描述

參數名	類型	說明
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 updateVirtualBookingNumberTest() 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/robot/virtual-booking-number/update";
    String channelId = "3335806";

    //签名参数
    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));

    //请求体参数
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("channelId", Integer.valueOf(channelId));
    jsonMap.put("virtualBookingNumber", 100);
    jsonMap.put("addRobotModel", "timely");

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("测试设置频道虚拟预约人数成功：{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "61b9319c9e3b42979f8a152dfa6b3f40.73.16626900842179815",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360830583026105",
    "error": {
        "code": 10001,
        "desc": "生效时间不能为空"
    },
    "success": false
}