保利威文档中心

幫助中心

提交觀眾報名資訊

更新時間:2026-11-09 17:32:49

供接入方在自有頁面/App 內代觀眾提交報名,報名資料進入頻道已有的報名統計,審核流程與保利威後台一致。配合查詢頻道報名觀看配置、查詢觀眾報名及審核狀態使用。

介面描述

1、接入方指定频道,传入观众ID与报名账号,提交保利威后台报名表单对应的信息
2、频道未开启报名时不允许提交,返回错误码1175
3、按后台表单的必填要求及格式规则校验,校验失败返回明确错误原因,不保存本次提交
4、通过本接口提交报名时,不要求也不校验保利威短信验证码,手机号真实性由接入方自行负责(保利威观看页仍按后台配置执行短信验证)
5、同一观众(观众ID)重复提交时:已审核通过的报名幂等返回成功;其余情况更新原报名记录(表单内容、报名账号跟随本次提交更新),不会重复生成报名记录
6、开启审核的频道,新报名进入待审核状态(W),由保利威后台审核;审核结果通过[查询观众报名及审核状态](__PLV_KEEP_2__)获取,提交成功不代表审核通过
7、接口产生的报名记录纳入已有的报名提交及审核结果回调【详见[报名观看回调](__PLV_KEEP_3__)】,回调中的观众ID与报名记录一致
8、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/enroll/record/save

線上API呼叫

請求方式

POST

介面約束

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

2、請設定請求頭contentType:application/json,簽名僅使用URL參數(appId、timestamp、channelId等),請求體參數不參與簽名【詳見簽名生成規則】

請求參數描述

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

請求體參數描述

參數名 必選 類型 說明
channelId true Integer 頻道號
code true String 報名帳號類型,mobile:手機,email:電子郵件
mobile true String 報名帳號,手機號或電子郵件地址(code為email時傳電子郵件),長度不超過40字元
viewerId true String 接入方觀眾ID,同一觀眾的報名記錄與該ID關聯,長度不超過64字元
content true String 報名表單內容,JSON格式字串:{"欄位id": "欄位值"},欄位id與查詢頻道報名觀看配置返回的fields.id對應

範例

http://api.polyv.net/live/v4/channel/enroll/record/save?appId=frlr1zazn3&sign=16DC042339E27BAD00452D004C1FA9CA&timestamp=1731128494801

請求體JSON範例

{
    "channelId": 5588786,
    "code": "mobile",
    "mobile": "13100001111",
    "viewerId": "viewer001",
    "content": "{\"4085178\": \"13100001111\", \"4085180\": \"张三\"}"
}

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗
status String 回應結果,成功返回success,失敗返回error
success Boolean 回應結果,成功返回true,失敗返回false
data Object 介面只返回提交結果,無業務資料;審核狀態請透過查詢觀眾報名及審核狀態取得
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId String 請求ID,每次請求生成的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛上鉤

Error參數描述

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因,本介面常見:1175:頻道未開啟報名觀看;1176:報名表單必填項缺失;1038:電子郵件地址格式非法
desc String 錯誤描述,與 error.code 對應

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和優化。

private static final Logger log = LoggerFactory.getLogger(ChannelEnrollControllerTest.class);
/**
 * 提交观众报名信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSaveEnrollRecord() 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/enroll/record/save";
    Integer channelId = 5588786;
    String viewerId = "viewer001";
    String code = "mobile";
    String mobile = "13100001111";
    // 字段id与「查询频道报名观看配置」返回的 fields.id 对应
    String content = "{\"4085178\": \"13100001111\", \"4085180\": \"张三\"}";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", String.valueOf(channelId));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("channelId", channelId);
    jsonMap.put("code", code);
    jsonMap.put("mobile", mobile);
    jsonMap.put("viewerId", viewerId);
    jsonMap.put("content", content);
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("提交观众报名信息,返回值:{}", response);
    // do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "success": true,
    "data": null
}

異常範例(頻道未開啟報名)

{
    "code": 400,
    "status": "error",
    "success": false,
    "error": {
        "code": 1175,
        "desc": "频道未开启报名观看"
    }
}

異常範例(報名表單必填項缺失)

{
    "code": 400,
    "status": "error",
    "success": false,
    "error": {
        "code": 1176,
        "desc": "报名表单必填项缺失"
    }
}
联系客服,在线咨询
在线咨询