查詢彈幕列表
更新時間:2025-01-14 15:59:20
介面說明
1、分页查询用户下所有的弹幕信息
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
介面URL
http://api.polyv.net/v2/danmu/{userid}
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| ptime | true | Long | 目前時間的毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| vid | false | String | 影片id,傳入則查詢該影片下所有彈幕,不傳則查詢使用者所有彈幕 |
| numPerPage | false | Integer | 單頁顯示的記錄筆數 |
| pageNum | false | Integer | 查詢的頁數 |
範例
http://api.polyv.net/v2/danmu/1b448be323?vid=1b448be323b68b2999802799a98dba54_1&sign=F6254A68BF8AC6570848D86CDB7F57BB3989638A&numPerPage=1&ptime=1617241038467&pageNum=1
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 回應成功時返回影片彈幕詳細資訊【詳見data欄位說明】 |
data欄位說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageNumber | Integer | 目前頁 |
| totalItems | Integer | 總記錄數 |
| totalPages | Integer | 總頁數 |
| endRow | Integer | 目前頁最後一筆記錄在總記錄中的位置 |
| startRow | Integer | 目前頁第一筆記錄在總記錄中的位置 |
| activePageNum | Integer | 實際頁碼 |
| firstPage | Boolean | 是否為第一頁,值為:true/false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false |
| nextPageNumber | Integer | 下一頁編號 |
| prePageNumber | Integer | 上一頁編號 |
| limit | Integer | 目前頁記錄筆數 |
| offset | Integer | 分頁起始記錄 |
| contents | Object | 上傳者資訊 【詳見contents欄位說明】 |
contents欄位說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Integer | 彈幕資訊的唯一標識 |
| vid | String | 影片id |
| userid | String | 保利威點播帳戶id |
| msg | String | 彈幕資訊內容 |
| time | String | 彈幕出現的時間點,格式:HH:mm:ss,例:00:00:10 |
| fontsize | String | 彈幕內容的字型大小 |
| fontmode | String | 彈幕內容滾動方式 roll:滾動 top:頂部 bottom:底部 |
| fontcolor | String | 彈幕內容字型顏色 |
| timestamp | Long | 彈幕內容出現的時間,13位毫秒級時間戳 |
| sessionid | String | 自訂參數(不能超過64位的字串),新增彈幕傳入的自訂參數(例如客戶自己的使用者id資料等) |
| param2 | String | 自訂參數(不能超過64位的字串),新增彈幕傳入的自訂參數(例如客戶自己的使用者id資料等) |
| msgtype | String | 直播回放轉存到點播時會把聊天記錄轉為點播彈幕資訊,直播聊天室訊息類型 speak:發言 chatImg:發圖片 |
| user | String | 直播回放轉存到點播的資料,登入直播聊天的使用者資訊,資料格式:json物件【詳見user參數說明】 |
| origin | String | 彈幕來源 vod:點播 playback:直播回放的聊天資料 chat:直播過程的聊天資料 |
| viewerId | String | 自訂參數(不能超過64位的字串),新增彈幕傳入的自訂參數(例如客戶自己的使用者id資料等) |
user參數說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| actor | String | 頭銜 |
| banned | Boolean | 是否禁言,true/false |
| channelId | String | 頻道id |
| clientIp | String | 使用者ip |
| nick | String | 使用者暱稱 |
| pic | String | 使用者頭像 |
| roomId | String | 房間號 |
| sessionId | String | 直播的場次id |
| uid | String | 聊天室socketid |
| userId | String | POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->點播(API介面) |
| userType | String | 使用者類型,預設為student,三分屏場景下學員需設定為slice student:一般學員 slice:雲課堂學員 teacher:講師 manager:管理員 assistant:助教 guest:嘉賓 |
返回錯誤代碼列表
| 錯誤代碼 | message | 說明 |
|---|---|---|
| 400 | sign can not be empty. | 加密串為空 |
| 400 | ptime is too old. | 時間戳過期 |
| 400 | ptime is illegal. | 時間戳參數格式不對或超過目前時間3分鐘 |
| 400 | Could not find user by userid. | userid不存在 |
| 400 | the sign is not right. | 加密串不正確 |
| 500 | query failed. | 後台程式拋異常 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(VodVideoManagementTest.class);
/**
* 查询弹幕
*/
@Test
public void testGetDanmu() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = String.format("http://api.polyv.net/v2/danmu/%s", userId);
String vid = "1b448be323b68b2999802799a98dba54_1";
String numPerPage = "1";
String pageNum = "1";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("vid", vid);
requestMap.put("numPerPage", numPerPage);
requestMap.put("pageNum", pageNum);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.get(url, requestMap);
log.debug("测试查询弹幕,{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "success",
"data": {
"pageNumber": 1,
"totalItems": 7,
"contents": [{
"id": 17252332,
"vid": "1b448be323b68b2999802799a98dba54_1",
"userid": "1b448be323",
"msg": "测试获取弹幕信息",
"time": "00:00:01",
"fontsize": "24",
"fontmode": "roll",
"fontcolor": "0xFFFFFF",
"timestamp": 1617176768000,
"sessionid": null,
"param2": null,
"msgtype": "speak",
"user": "",
"origin": "vod",
"viewerId": null
}],
"totalPages": 1,
"endRow": 7,
"startRow": 1,
"nextPageNumber": 1,
"prePageNumber": 1,
"activePageNum": 1,
"firstPage": true,
"lastPage": true,
"limit": 1,
"offset": 0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "ptime is too old.",
"data": ""
}
