保利威文档中心

幫助中心

停止答題卡

更新時間:2024-04-22 19:18:32

介面描述

1、停止答题卡
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/question/stop

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看 2、若參數不正確則會回應400異常

請求參數描述

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

範例

http://api.polyv.net/live/v4/channel/question/stop?channelId=4760542&questionId=gv0uf9s5v7&timestamp=1712480998000&appId=fso8gzbxlr&sign=72BA87A7BB04EC47C209AAC10D4BC103

回應描述

參數名 類型 說明
code Integer 狀態碼,與http狀態碼相同,用於確定基本的回應狀態
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一的UUID,僅可用於排查、除錯,不應該和業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位描述
data Object 回應詳細資訊【詳見data欄位說明

Error回應描述

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與error.code對應

data回應描述

參數名 類型 說明
answer String 正確答案
type String 答題卡類型:R單選, C多選, S評分, V投票
itemType Integer 類型:0答題卡, 1問答
total Long 答題總人數
rightUserCount Long 回答正確人數
faultUserCount Long 回答錯誤人數
singleResult List 各個選項選擇人數

Java請求範例

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

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


回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "b8e410f71a9f4246acc9e597ca27be8b.73.17124809986010047",
    "data": {
        "answer": "A",
        "type": "R",
        "itemType": 0,
        "total": 1,
        "rightUserCount": 1,
        "faultUserCount": 0,
        "singleResult": [
            1,
            0
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询