查詢頻道登記觀看設定的欄位資訊

更新時間：2022-09-02 18:08:07

介面描述

1、获取频道或全局的登记观看字段
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/auth/get-record-field

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v3/channel/auth/get-record-field?appId=frlr1zazn3&sign=A9BFED5A4CD52C57BD0384827628C73C&rank=1&channelId=1965681&timestamp=1621844135149

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Array	請求成功為資料內容，錯誤為空字串【詳見data欄位說明】

data欄位說明

參數名	類型	說明
type	String	登記觀看類型 name：姓名 mobile：手機號碼 number：數字 option：下拉選擇 text：文字
name	String	登記觀看資訊標題
placeholder	String	登記觀看資訊描述
options	String	登記觀看為下拉選擇時的選項，選項值以英文逗號分隔
sms	String	簡訊驗證開關 Y：開 N：關

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 查询频道登记观看设置的字段信息
 * @throws IOException
 */
@Test
public void testGetRecordField() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String url = "http://api.polyv.net/live/v3/channel/auth/get-record-field";
    String rank = "1";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("rank", rank);
    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",
    "message": "",
    "data": [{
        "type": "name",
        "name": "姓名",
        "options": null,
        "placeholder": "请输入姓名",
        "sms": null
    }, {
        "type": "number",
        "name": "年龄",
        "options": null,
        "placeholder": "请输入您的年龄",
        "sms": null
    }, {
        "type": "option",
        "name": "来自何方",
        "options": "大唐,东方",
        "placeholder": "来自哪里呢?",
        "sms": null
    }]
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}